Configuring call logging

The default configuration is set in the NSS configuration file (NSSserver.cfg) . You can override the defaults globally and for individual sessions.

For global configuration of the call log server, set the following parameters on the Speech Server in the Management Station. If not using Management Station, set in the NSS configuration file.

Parameter

Description

server.callLog.enableDiskLog

Enables call logging. When disabled, no call logs are written.

server.callLog.baseDirectory

Specifies the parent directory where the system writes call logs.

server.callLog.tcp.port

Specifies the listening TCP port assigned to the call log server.

server.callLog.tls.port

Specifies the listening TLS port for clients to communicate with call log server.

server.callLog.utteranceSampling

Specifies the percentage of randomly-selected utterances saved as audio files.

server.tls.tlsVersion

TLSClosed version expected by the listener port

server.callLog.useStrongestCipherSuite

Specifies the encryption ciphers on the TLS port. Requires use of only the strongest TLS ciphers for communication with the call log server.

For session-level configuration, define parameters in the <speechserver> section of the session.xml file. For example, you can segregate log files for individual companies and applications (for example, if you host applications for multiple customers).

Parameter

Description

application_name

Specifies the application name written to the call logs and used in the filepath to the logs.

company_name

Specifies the company name written to the call logs and used in the filepath to the logs.

Adding application data to call logs

Use this parameter to add application-defined tokens to call logs:

Parameter

Description

swirec_app_state_tokens

Adds application or browser information to call logs to synchronize runtime activities with log analysis.

Protecting confidential information

Use these session.xml parameters to affect confidential data in the system:

Parameter

Description

swirec.secure_context

Sets recognizer security levels for protecting confidential data, typically for a single event.

switts.secure_context

Sets Vocalizer security levels for protecting confidential data in logs of text-to-speech conversions.

To affect encryption of call logs through the TLS port, set these parameters on the Speech Server in the Management Station:

Parameter

Description

server.callLog.tls.keyDir

Key directory for the TLS calllog listener.

server.callLog.tls.keyPassword

Password for access to server.callLog.tls.keyDir.

Cleaning up call logs

Depending on system activity and your logging configuration, log file directories can fill up quickly. To make efficient use of available disk storage, configure Speech Server to automatically clean up log file directories. If using Management Station, see also Purging call log files.

You can set cleanup rules for each file type, or for each pair of company and application name. If the cleanup process finds any files that are older than the rules specify, or the amount of free space is below the warning threshold, the cleanup process deletes files according to the current rule settings.

Note: The automatic cleanup does not apply to diagnostic logs, since there is another process for controlling disk space used by diagnostic logs by rolling them over once they reach a certain size.

Use these parameters for cleanup:

Parameter

Description

server.callLog.cleanupCallLogServer

Enables removal of old log files (audio and text).

server.callLog.cleanupRates.0

Controls how long to keep each type of log file before deletion.

server.callLog.cleanupBreakTimeMinutes

Specifies time for the call log server cleanup process to pause between cleaning cycles.

server.callLog.minFreeDiskMB

Specifies the minimum available disk space for writing call logs.

server.callLog.warnMinFreeDiskMB

Threshold to warn operators that the available disk space for call logging is too low.