← Back to plugin index

Correlation ID Settings
Description
Defines settings for the correlation ID.
Type name
CorrelationIdSettings
Class
com.airlock.iam.common.application.configuration.logging.CorrelationIdSettingsConfig
May be used by
Main Settings Adminapp Service Container Transaction Approval Loginapp API Policy Service
Properties
Header Name (headerName)
Description
Defines the header from which the correlation ID will be extracted on incoming requests.
Attributes
String
Optional
Validation RegEx: [a-zA-Z0-9_-]+
Default value
X-Correlation-ID
Validation Pattern (validationPattern)
Description

The correlation ID that is extracted from the request header will be matched against this regular expression.

If it matches, then it will be logged for the scope of the current HTTP request. Otherwise, the value is rejected, and no correlation ID will be logged.

This can be configured to prevent unexpected values from being written to the log files.

Attributes
RegEx
Optional
Default value
[\x21-\x7E]{2,256}
YAML Template (with default values) 

type: CorrelationIdSettings
id: CorrelationIdSettings-xxxxxx
displayName: 
comment: 
properties:
  headerName: X-Correlation-ID
  validationPattern: [\x21-\x7E]{2,256}