Log Configuration Options

Configure per-call logging settings

This section is OPTIONAL

The header for this section is [log]

Table 1. log
Name Mandatory Type Default Description
directory no string log/callLogs Directory relative to /opt/blueworx/vr in which to write call logs.
archive_directory no string log/callLogs/archive Directory relative to /opt/blueworx/vr in which to write archived call logs.
file_limit no integer 100 Maximum number of MB to write to any one call log file.

Min: 1, Max: 2047
app_log_mode no string FILE This parameter was introduced in version 7.8.0

Where to send application logging such as major events in the call, applications starting/stopping, output from the <log> tag in VoiceXML or Call Control XML. Files will be generated in the log directory per-call if FILE or BOTH is set, and messages will be sent to a kafka broker if KAFKA or BOTH is set.

Valid options are: OFF, FILE, KAFKA, BOTH
error_log_mode no string FILE This parameter was introduced in version 7.8.0

Where to send error messages in addition to them being sent to the trace. Messages are sent to error_0.out if FILE or BOTH is set, or to a Kafka broker if KAFKA or BOTH is set.

Valid options are: OFF, FILE, KAFKA, BOTH
trace_log_mode no string FILE This parameter was introduced in version 7.8.0

Where to send logging and trace to help debug issues with BVR other than application logging. Trace is appended to files in the log directory if FILE or BOTH is set, and messages will be sent to a kafka broker if KAFKA or BOTH is set.

Valid options are: OFF, FILE, KAFKA, BOTH
kafka_properties_file no string   This parameter was introduced in version 7.8.0

If app_log_mode, error_log_mode or trace_log_mode are set to KAFKA or BOTH, this defines the properties file that will set up the connection to the Kafka broker.

If not specified, the general section's default_kafka_properties_file will be used instead.

This is the absolute file path for the properties file, for example:

kafka_properties_file = "/location/of/file/kafka.properties"

Note: For more information on configuring Kafka producer properties see "Configuring Apache Kafka producer properties" in the BVR documentation
keep_logs no boolean false Whether to archive application logs or delete them after the call has finished. If set to true they are archived once the call has finished. Note that application logs are only created on the filesystem if the app_log_mode is set to FILE or BOTH.