Correlating event logs

A single interaction can create multiple event logs. Event logs can be correlated in different ways.

Correlate logs for a specific API interaction

A single API request/response interaction will create multiple event logs across the different services and may also include dialog NII logs.

For example, consider a dialog Start request/response interaction; it might generate the following event logs:

To correlate all the event log records that apply to a specific request/response interaction, use the requestid field. All the logs for a specific customer interaction share the same requestid value.

The requestid field is particularly useful for interactions that span multiple services. For example, consider a dialog Execute request that requires NLU interpretation. In addition to the related NII logs, such an interaction might also include the following event logs:

The following examples show sample event logs in a dialog start request interaction with requestid 50f04cf5-debd-9a6a-b1f0-75e408ce21d1. Only the content under the value field is shown.

  NII session-start  
  NII selector  
  DLGaaS-Start-Start  
  DLGaaS-Start-End  

Correlate ASR, NLU, TTS, and NR logs for a specific dialog session

When DLGaaS calls ASRaaS, NLUaaS, TTSaaS, or NRaaS, it includes the following fields in the logs of the service, as part of the clientData of the request:

  • x-nuance-dialog-session-id: ID of the dialog session.
  • x-nuance-dialog-seqid: Sequence ID of the NII log message to which this event log applies.

These fields can be used to identify all the ASR, NLU, TTS, and NR event logs that relate to a dialog session.

The following example show a sample ASRaaS event log for dialog session b15302ac-be35-4d9c-b593-3789b091e83f. Only the content under the value field is shown.

  recognitionInitMessage  

Correlate NII logs for a specific dialog session

To correlate the NII logs that correspond to a specific dialog session, use the following data fields:

  • sessionid: Specifies the ID of the dialog session. All the NII logs for a specific dialog session share the same session ID. This is the session ID that is created with the DLGaaS StartRequest.
  • seqid: Sequence ID of the NII log. Starts at 1 and increments for each NII message in a dialog session.

The seqid ensures that you can determine the sequence of the NII logs in a dialog session, since these logs may not be received in the order in which they are created and sent.

For a description of the NII log events, see dlg-nii-logs payload.

The following examples show a sample NII sequence for dialog session c475ff51-d60c-4ad0-b1df-7fb4aae43b13. Only the content under the value field is shown.

  First message in NII sequence  
  Second message in NII sequence