Log Entry Enrichment
Upon receipt of a log entry from a log client, the ActiveMatrix Service Grid platform sets enrichment fields that can be used to augment the log record.
The enrichment fields are set in two locations: LRE and MDC.
- To include an LRE field in
the log output, preface the name of the field key surrounded by brackets with
%R
in the pattern layout of the simple file appender . For example,%R{_cl.physicalCompId.matrix.host}
. - To include an MDC field,
preface the field surrounded by brackets in the simple file appender's pattern
layout with
%X
. For example,%X{_cl.correlationId}
.
Field Key | LRE | MDC | Description |
---|---|---|---|
_cl.correlationId
|
* | ID to correlate the context with which the log event is associated with another context in the same message exchange. | |
_cl.contextId
|
* | Context with which the log event is associated. | |
_cl.parentContextId
|
* | Parent of the context with which the log event is associated. | |
_cl.physicalCompId.scheme
|
* | * | Scheme of the
physicalCompId format.
Default: amx3. |
_cl.physicalCompId.matrix.env
|
* | Environment name. Field1 of the physical component ID. Scheme must be amx3. | |
_cl.physicalCompId.matrix.host
|
* | Host name. Field2 of the physical component ID. Scheme must be amx3. Only available on host logging. | |
_cl.physicalCompId.matrix.node
|
* | Node name. Field3 of the physical component ID. Scheme must be amx3. | |
_cl.physicalCompId.matrix.typeadapter
|
* | Implementation or binding type name. Field4 of the physical component ID. Scheme must be amx3. | |
_cl.logicalCompId.scheme
|
* | * | Scheme of the
logicalCompId format.
Default: amx3. |
_cl.logicalCompId.matrix.application
|
* | Application name. Field 1 of the logical component ID. | |
_cl. logicalCompId.matrix.component
|
* | Composite or component name. Field 2 of the logical component ID. | |
_cl. logicalCompId.matrix.component.version
|
* | Component version. | |
_cl. logicalCompId.matrix.component.revision
|
* | Component revision. | |
_cl.logicalCompId.matrix.service
|
* | Service name. Field3 of the logical component ID. Scheme must be amx3. | |
_cl.logicalCompId.matrix.reference
|
* | Reference name. Field3 of the logical component ID. Scheme must be amx3. | |
_cl.logicalCompId.matrix.operation
|
* | Operation name. Field4 of the logical component ID. Scheme must be amx3. | |
_cl.securityPrincipal
|
* | Value of the security principal if applicable. | |
_cl.payload.id
|
|||
_cl.payload.name
|
Auto-generated file name | ||
_cl.payload.type
|
Auto-detected mimetype of payload file. | ||
_cl.payload.uri
|
URI of payload data. This has been deprecated. | ||
_cl.payload.size
|
File size of payload file. | ||
_cl.payload.MD5
|
MD5 value of payload file. | ||
_cl.payload.TTL
|
Time to leave of payload data. The payload data is automatically purged if it's reached the time to leave. Unit of TTL is hour. | ||
_cl.payload.data
|
Binary data of payload file. |