Standard EDR Fields

Root Fields

EDRs produced by all JSLEE subsystems have the following fields at their root level:

Field Type Presence Description
type String Always The type of the EDR, set by the creating service.
node-name String Always The server-name configured on the creating node.
event-timestamp Timestamp Always The time (in UTC) that the event that triggered the EDR occurred.
correlation-info Object Always A grouped field containing correlation information to allow retrieval of all EDRs for a given event.
source-info Object Always A grouped field containing source information for the entity that created this EDR.
status-message String Always Free-form text describing the outcome of the EDR, set by the creating service.
failure-class String On failure Only present for events that are considered failed. Holds the class of failure, either free-form or sourced from the ResponseClass class.
failure-code Integer On failure Only present for events that are considered failed. An internal code for the failure, either free-form or sourced from the ResponseClass class.

Other fields may be added at the root level by the generating service as required.

Other Fields

Correlation Information

The correlation information field (under the key correlation-info) holds additional information for the correlation of EDRs with each other and with external elements. All EDRs for a given triggering event will share the same slee-session-id value and will have distinct slee-event-id values.

Field Type Presence Description
slee-session-id String Always Contains the internally-generated unique ID used for all EDRs in a given end-to-end transaction across the SLEE.
slee-event-id String Always Contains the internal unique ID generated for a single event within an end-to-end transaction across the SLEE. Event IDs are usually numeric and reflect the progress of messaging through the SLEE from service to service.

Other fields may be added to the correlation information field by the generating service as required.

Event IDs are free-form, but are delimited by / when additional messages are generated by services. For example, consider the following sequence of messages:

  1. Event triggered on service A.
  2. Service A writes EDR with a slee-event-id of 1. Service A sends message to service B.
  3. Service B sends message to an external entity and writes an EDR with a slee-event-id of 1/1.
  4. Service B sends another message to an external entity and writes an EDR with a slee-event-id of 1/2.

Source Information

The source information field (under the key source-info) holds additional information on the source of a generated EDR.

Field Type Presence Description
source-service String Always Holds the configured name of the JSLEE service that generated the EDR.
source-endpoint String Conditional Holds the configured name of the endpoint on the JSLEE service that was handled the event, if applicable.
source-system String Always Holds the internal system type name of the JSLEE service that generated the EDR.
source-subsystem String Conditional Holds the internal subsystem type name of the JSLEE service subsystem that generated the EDR, if applicable.

Other fields may be added to the source information field by the generating service as required.