Correlation Ids
Overview¶
The Blue platform applications utilize the correlation patterns in JHA to allow for traceability across services.
For logging, see also Common Log Fields.
JX Correlation Fields¶
JX has common correlation ids
| Name | jX Header Field | JX-R Header Field | Desc |
|---|---|---|---|
| Request ID | N/A | X-Request-ID |
To support communications level identification of every message sent, a unique identifier (GUID) will be sent on every call from a caller and returned in the response by the respondent (service or intermediary) regardless of the final disposition of the request/message. |
| Correlation ID | jXLogTrackingId |
X-Correlation-ID |
To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. |
| Business Correlation ID | BusCorrelId |
X-BusinessCorrelationId |
In support of business functions: The correlation identification as related to business functions and activities. Generally expected to be a GUID. |
| Workflow Correlation ID | WorkflowCorrelId |
X-WorkflowCorrelationId |
In support of workflow functions: The correlation identification as related to workflow functions and activities. Generally Expected to be a GUID. |
Correlation Fields by Area¶
| Area | Request ID | Correlation ID | Business Correlation ID | Workflow Correlation ID |
|---|---|---|---|---|
| WSO2 | Generate new for each request to: Jx, EWS, Blue API | Started via: - DI: jXLogTrackingId - EWS: event-id- WSO2 timer: generate UUID Otherwise generate UUID. |
N/A | Generate at the start of each UC and tracked as TransactionIdFk. |
| Dotnet API | Inbound X-Request-ID should be a new guid for each call. The same value will be returned. |
HTTP Header X-Correlation-ID. Required by endpoints. Used in calls to other services in same request scope. |
N/A | HTTP Header X-WorkflowCorrelation-Id. Used in calls to other services in same request scope. |
| RabbitMQ client | N/A | Set custom header CorrelationId |
N/A | Set custom header WorkflowCorrelationId |
| RabbitMQ MassTransit | N/A | Set SendContext property CorrelationId |
N/A | Set SendContext custom header property WorkflowCorrelationId |
| Serilog | Set LogContext property XRequestId |
Set LogContext property CorrelationId |
N/A | Set LogContext property WorkflowCorrelationId |
Correlation Fields Data Flow¶
