Logging contexts

Overview

The logging context defines data added to the audit logs that are generated for each request of transformation. It reprensents the information the client wants to insert in the audit logs for future usage.

The data in the logging context is weakly formatted. A logging context is represented (instantiated) with an array of evidences sets.

IMPORTANT : the evidences sets used in the logging context do not need to be defined in RPS CoreConfiguration

JSON instantiation

Logging contexts are instantiated using JSON and are used in the Transform API requests.

"loggingContext": {
  "guid": "[string]",
  "evidences": [
    {
      "name": "[string]",
      "value": "[string]"
    }
    ...
  ]
}
JSON attributeTypeDescriptionRequired
guidstringa random generated valid GUID defining the logging context.
evidencesarraythe evidences set. It is an array of one or more evidences objects {name,value}
evidences[j]
.name
stringthe name of the evidence j
evidences[j]
.value
stringthe value of the evidence j

Example of JSON instantiation

"loggingContext": {
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "evidences": [
    {
      "name": "status",
      "value": "READY"
    },
    {
      "name": "source",
      "value": "middleware application"
    }
  ]
}