Generating one log file per call

By default, diagnostic logs can contain information about several calls. You can enable the Telephony Session service and Voice Browser service to generate a dedicated log file for each call (or session) instead. The filename includes a unique session ID generated at the start of the call. The same session ID appears in the call log file allowing you to correlate these files.

To enable, set these service properties to TRUE on the Advanced tab in the Management Station. The default is FALSE.

Note: It is important to use the same logging structure across all service instances on a host. If you enable any feature (for example, company or per-call logging) ensure you configure at the appropriate scope so the changes propagate to all instances.

Service Service property Location Filename
Telephony Session service ts.diagLogPerCall %NUANCE_DATA_DIR%/system/diagnosticLogs tsnum-SessionID.log
Voice Browser service

browser.LogPerCall

%NUANCE_DATA_DIR%/system/diagnosticLogs vbsnum-BrowserInstance-Company-App-SessionID.log

Note: You can enable one or both services. The settings are independent.

Telephony Session service

To summarize:

  • Rollover policy applies to per-call logs. For example:

    %NUANCE_DATA_DIR%/systemdiagnosticLogs/tsnum-SessionID-bck001.log

  • Company logging applies to per-call logs. For example:

    %NUANCE_DATA_DIR/Company/diagnosticLogs/tsnum-Company-SessionID.log

    %NUANCE_DATA_DIR/Company/diagnosticLogs/tsnum-Company-SessionID-bck001.log

    The company name, if not configured in the SIP INVITE, defaults to Nuance when per-call logging is enabled.

Saving to a directory hierarchy

You can save these log files to a hierarchical directory structure. Set ts.LogDirectoryHierarchy = TRUE on the Advanced tab for the Telephony Session service. The default is FALSE. This feature is valid only for per-call log files (ts.diagLogPerCall = TRUE).

The directory structure indicates the year, month, day, and hour at which the call started. If company logging is enabled, then the directory structure includes the company name. For example:

  • Without company logging: Per-call logs are written to %NUANCE_DATA_DIR%/system/diagnosticLogs/YYYY/MMmonth/DD/HH/tsnum-SessionID.log
  • With company logging (default company and application = Nuance and MyApp if not configured in SIP INVITE): %NUANCE_DATA_DIR%/Company/diagnosticLogs/App/YYYY/MMmonth/DD/HH/tsnum-Company-App-SessionID.log

Voice Browser service

To summarize:

  • The per-call feature applies only to log files generated by browser instances. These are logical ports that handle calls.
  • Files are saved in %NUANCE_DATA_DIR%/system/diagnosticLogs.
  • The filename includes the service and browser instances that handled the call, plus the company and application names as entered on the Applications tab for the Voice Browser service. For example:
    vbs1-1-CO1-APP1-S0a650a0d_0000057e_4af25f34_0001_1234.log

Note: There is no rollover policy or automatic deletion of these per-call log files. You must manually remove them from the host.

Saving to a directory hierarchy

You can save these log files to a hierarchical directory structure by setting browser.LogDirectoryHierarchy to TRUE on the Advanced tab for the Voice Browser service. The default is FALSE. This feature is valid only for per-call log files (browser.LogPerCall = TRUE).

The directory structure indicates the company and application name, plus year, month, day, and hour at which the call started. For example:

%NUANCE_DATA_DIR%/Company/diagnosticLogs/App/YYYY/MMmonth/DD/HH/

The company and application values are defined on the Voice Browser service properties Application tab. For example, if a call were taken on May 30 at 3:33:16 p.m for the AcmeCo company and AcmeApp application, the directory structure would look something like this.

%NUANCE_DATA_DIR%/CO1/diagnostlicLogs/APP1/2012/05May/30/15/

Note: There is no rollover policy or automatic deletion of these files. You should periodically remove them from the host.