[ems]

log_sinks

Log Sinks

List of one more pipe-delimited identifiers for log sinks that should be loaded upon initialization of the GVP Logging Service.

Valid values

DATAC, MFSINK or TRAPSINK

Default value

MFSINK|TRAPSINK

Takes effect At start/restart

logconfig.MFSINK

MF Sink Log Filter

Controls the log messages that are sent to the MF sink. The format is 'levels|moduleIDs|specifierIDs' (repeated if necessary). The values between the pipes can be in the format: 'm-n,o,p' (ie "0-4, 5,6"). The wildcard character '*' can also be used to indicate all valid numbers. Example: '*|*|*' indicates that all log messages should be sent to the sink. Alternatively, '0,1|0-10|*|4|*|*' inidcates that CRITICAL(0) and ERROR(1) level messages with module IDs in the range 0-10 wil be sent to the sink; and all INFO(4) level messages will be sent as well.

Valid values

Pipe delimited ranges for log levels, module IDs and specifier IDs. Ranges can be comma separated integers or range of integers or '*'.

Default value

0-3,5|*|*

Takes effect immediately

metricsconfig.MFSINK

MF Sink Metrics Filter

Specifies the metrics that are delivered to the MF Sink. '*' indicates that all metrics will be sent to the sink. Alternatively, '5-10,50-55,70,71' indicates that metrics with IDs 5,6,7,8,9,10,50,51,52,53,54,55,70 and 71 will be sent to the MF sink.

Valid values

Comma separated list of metric values or ranges. A metric value must be between 0 and 141 inclusive. The values '*' and blank are also allowed.

Default value

0-15,19-41,43,52-56,72-74,76-81,127,129,130,132-141

Takes effect immediately

trace_flag

Trace Flag

Flag specifying whether debug level logging is enabled. When enabled, debug level logs will be processed and filtered like logs (and metrics) and all other levels.

Valid values

  • FALSE
  • TRUE
TRUE or FALSE

Default value

FALSE

Takes effect immediately

trapsink.initfile

SNMP Trap EMS to MF Mapping

Specifies the full path of the EMS MF mapping file, which maps EMS log IDs to MF counterparts.

Default value

$InstallationRoot$\config\FM_EMStoMFIDs.txt

Takes effect At start/restart

trapsink.trapfilterfile

SNMP Trap Filter

Specifies the full path of the trap filter file, which maps MF ids to SNMP traps.

Default value

$InstallationRoot$\config\FM_trapfilter.txt

Takes effect At start/restart

[iproxy]

cache_error_max_age

Maximum Cache Age (failures)

Maximum age of cache for failed fetches in seconds.

Default value

0

Takes effect At start/restart

cache_max_age

Maximum Cache Age

Maximum age for data cached in pwproxy in seconds (default is 60). It applies only if data is cacheable. Caching could be turned off by setting this to 0.

Default value

60

Takes effect At start/restart

cache_max_size

Maximum Cache Size

Maximum size of the shared memory cache in MBytes

Default value

64

Takes effect At start/restart

connect_timeout

Connect Timeout

The maximum time in seconds allowed for connecting to a server. If enabled, the smaller of connect_timeout and the fetch response timeout will be used. If disabled, the fetch response timeout will be used.
Note that when this parameter is enabled, the minimum timeout interval is 1 second. It is not possible to use milliseconds. In addition, if the SSL connection phase does not finish before time timeout is reached, the fetch will be aborted. (i.e. the fetch request will not be successful (on the server side) ) If the SSL connection phase has completed but the rest of the fetch does not finish before the timeout is reached, the fetch request will be successful (on the server side).
When this parameter is disabled, the timeout interval has no minimum value. The fetch request will always be successful even if the timeout is reached from the VoiceGenie/VoiceXML side. However, note that the fetch cannot timeout until after the SSL connection phrase is finished, even if that takes longer than the timeout interval.
After the SSL connection phase is done, the value of this parameter no longer applies, even if it is smaller than the fetchtimeout value. For example, if the SSL connection phase ends after 2 seconds but the rest of the fetch takes longer to finish, and connect_timeout=5s and fetchtimeout=10s, the fetch would not time out until after 10 seconds.

Default value

5

Takes effect At start/restart

curl_handle_fetchtimeout

cURL Handle Fetch Timeout

If set to FALSE, fetch timeouts are handled by the Fetching Module itself; when a timeout occurs, a fetch timeout result will be returned to the host application but the actual HTTP fetch operation won't be aborted and will be carried out to completion. If set to TRUE, fetch timeouts are handled by cURL; when a timeout occurs, a fetch timeout result will be returned to the host application and the actual HTTP fetch operation will be aborted by cURL, regardless of being in a connection, request or response phase. Note that when this is set to TRUE, the fetchtimeout resolution is 1 second.

Default value

true

Takes effect At system start/restart

http_accept

HTTP Accept

A list of mime types for the default value of the Accept directive in HTTP header.

Default value

*/*

Takes effect At start/restart

http_proxy

HTTP Proxy

IP address and port of HTTP proxy to use. If disabled (left blank), the pwproxy will not use HTTP proxy.

Default value

127.0.0.1:3128

Takes effect At start/restart

https_proxy

HTTPS Proxy

IP address and port of HTTPS proxy to use. If disabled (left blank), the pwproxy will not use HTTPS proxy.

Default value

(blank)

Takes effect At start/restart

max_connections

Maximum Number of Connections

Max. number of concurrent active connections between iproxy and the HTTP proxy/server

Default value

1000

Takes effect At start/restart

max_redirections

Maximum Number of Redirections

Max. number of redirections allowed on a fetch request.

Default value

5

Takes effect At start/restart

max_shmem_entry

Maximum Shared memory Entry Size

Maximum size (MBytes) of cache entry that is permitted in shared memory. Anything larger will be cached as a memory mapped file.

Default value

32

Takes effect At start/restart

no_cache_url_substr

No Cache URL Substring

If a URL contains any one of the sub-strings in this list, it will not be cached.

Default value

cgi-bin

Takes effect At start/restart

ssl_ca_info

SSL CA Info

The file name holding one or more certificates to verify the peer with.

Default value

(blank)

Takes effect At start/restart

ssl_ca_path

SSL CA Path

The path holding multiple CA certificates to verify the peer with. The certificate directory must be prepared using the openssl c_rehash utility.

Default value

(blank)

Takes effect At start/restart

ssl_cert

SSL Certificate

The file name of your certificate. The default format is "PEM" and can be changed with the configuration parameter ssl_cert_type

Default value

(blank)

Takes effect At start/restart

ssl_cert_type

SSL Certificate Type

The format of the certificate.

Valid values

  • PEM
  • DER

Default value

PEM

Takes effect At start/restart

ssl_cipher_list

SSL Cipher List

The list of ciphers to use for the SSL connection. The list must be syntactly correct, it consists of one or more cipher strings sepa-separated rated by colons. Commas or spaces are also acceptable separators but colons are normally used, , - and + can be used as operators. Valid examples of cipher lists include 'RC4-SHA', 'SHA1+DES', 'TLSv1' and 'DEFAULT'. You'll find more details about cipher lists on this URL: http://www.openssl.org/docs/apps/ciphers.html.

Default value

0

Takes effect At start/restart

ssl_engine

SSL Engine

The identifier for the crypto engine you want to use for your private key.

Default value

(blank)

Takes effect At start/restart

ssl_engine_default

SSL Default Engine

Sets the actual crypto engine as the default for (asymetric) crypto operations.

Default value

(blank)

Takes effect At start/restart

ssl_key

SSL Key

The file name of the private key. The default format for the key is "PEM" and may be changed by the parameter ssl_key_type.

Default value

(blank)

Takes effect At start/restart

ssl_key_passwd

SSL Key Password

The password required to use the ssl_key.

Default value

(blank)

Takes effect At start/restart

ssl_key_type

SSL Key Type

The format of the private key.

Valid values

  • PEM
  • DER

Default value

PEM

Takes effect At start/restart

ssl_random_file

SSL Random File Seed

The path to a file which is read from to seed the random engine for SSL.

Default value

(blank)

Takes effect At start/restart

ssl_verify_host

SSL Verify Host

Specifies how the Common name from the peer certificate should be verified during the SSL handshake

Valid values

  • 0
  • 1
  • 2

Default value

0

Takes effect At start/restart

ssl_verify_peer

Verify Peer Certificate

Do you want verify the peer's certificate. When this option is set, you should set one of ssl_ca_info or ssl_ca_path.

Valid values

  • 0
  • 1

Default value

0

Takes effect At start/restart

ssl_version

SSL Version

Set what version of SSL to attempt to use. By default, the SSL library will try to solve this by itself although some servers make this difficult why you at times may have to use this option.

Valid values

  • 0
  • 1
  • 2
  • 3

Default value

0

Takes effect At start/restart

use_connection_caching

Use Connection Caching

If this is set, the cURL easy handles will reuse their connections.

Default value

true

use_strict_caching_rules

Use Strict Caching Rules

When set to true, the Fetching Module will perform strictly HTTP/1.1 conformant caching. Setting this to false offers better performance.

Default value

true

Takes effect At start/restart

user_agent

User Agent

HTTP request header User-Agent field contains information about the user agent originating the request.

Default value

GVP/8.0

Takes effect At start/restart

[log]

all

Output for level all

Specifies the outputs to which an application sends all log events. The log output types must be separated by a comma when more than one output is configured.

Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

    • Default value

    $InstallationRoot$\logs\fm,stdout

    Takes effect immediately

    check-point

    Check point interval

    Specifies, in hours, how often the application generates a check point log event, to divide the log into sections of equal time. By default, the application generates this log event every hour. Setting the option to 0 prevents the generation of check-point events.

    Valid values

    0 - 24

    Default value

    1

    Takes effect immediately

    compatible-output-priority

    Enable 6.X compatible log output priority

    Specifies whether the application uses 6.x output logic.

    Valid values

  • true The log of the level specified by "Log Output Options" is sent to the specified output.
  • false The log of the level specified by "Log Output Options" and higher levels is sent to the specified output.

    • Default value

    false

    Takes effect immediately

    debug

    Output for level debug

    Specifies the outputs to which an application sends the log events of the Debug level and higher (that is, log events of the Standard, Interaction, Trace, and Debug levels). The log output types must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

    • Default value

    (blank)

    Takes effect immediately

    expire

    Log Expiration

    Determines whether log files expire. If they do, sets the measurement for determining when they expire, along with the maximum number of files (segments) or days before the files are removed.

    Valid values

  • false No expiration; all generated segments are stored.
  • [number] file or [number] Sets the maximum number of log files to store. Specify a number from 1-100.
  • [number] day Sets the maximum number of days before log files are deleted. Specify a number from 1-100.

    • Default value

    10

    Takes effect immediately

    interaction

    Output for level interaction

    Specifies the outputs to which an application sends the log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels). The log outputs must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

    • Default value

    ..\logs\mcp_metricsfile,network

    Takes effect immediately

    keep-startup-file

    Keep startup log file

    Specifies whether a startup segment of the log, containing the initial T-Server configuration, is to be kept. If it is, this option can be set to true or to a specific size. If set to true, the size of the initial segment will be equal to the size of the regular log segment defined by the segment option. The value of this option will be ignored if segmentation is turned off (that is, if the segment option set to false).

    Valid values

  • false No startup segment of the log is kept.
  • true A startup segment of the log is kept. The size of the segment equals the value of the segment option.
  • [number] KB Sets the maximum size, in kilobytes, for a startup segment of the log.
  • [number] MB Sets the maximum size, in megabytes, for a startup segment of the log.

    • Default value

    false

    Takes effect After restart

    memory

    Memory snapshot file name

    Specifies the name of the file to which the application regularly prints a snapshot of the memory output, if it is configured to do this. The new snapshot overwrites the previously written data. If the application terminates abnormally, this file will contain the latest log messages. Memory output is not recommended for processors with a CPU frequency lower than 600 MHz.

    Valid values

    [string] (memory file name)

    Default value

    (blank)

    Takes effect immediately

    memory-storage-size

    Memory output buffer size

    Specifies the buffer size for log output to the memory, if configured.

    Valid values

  • [number] KB or [number] The size of the memory output, in kilobytes. The minimum value is 128 KB.
  • [number] MB The size of the memory output, in megabytes. The maximum value is 64 MB

    • Default value

    (blank)

    Takes effect When memory output is created

    message_format

    Log messages format

    Specifies the format of log record headers that an application uses when writing logs in the log file. Using compressed log record headers improves application performance and reduces the log file's size. With the value set to short:
  • A header of the log file or the log file segment contains information about the application (such as the application name, application type, host type, and time zone), whereas single log records within the file or segment omit this information.
  • A log message priority is abbreviated to Std, Int, Trc, or Dbg, for Standard, Interaction, Trace, or Debug messages, respectively.
  • The message ID does not contain the prefix GCTI or the application type ID.
    A log record in the full format looks like this:
    2002-05-07T18:11:38.196 Standard localhost cfg_dbserver GCTI-00-05060 Application started
    A log record in the short format looks like this:
    2002-05-07T18:15:33.952 Std 05060 Application started

    • Valid values

    • short
    • full
  • short An application uses compressed headers when writing log records in its log file.
  • full An application uses complete headers when writing log records in its log file.

    • Default value

    short

    Takes effect immediately

    messagefile

    Message file

    Specifies the file name for application-specific log events. The name must be valid for the operating system on which the application is running. The option value can also contain the absolute path to the application-specific *.lms file. Otherwise, an application looks for the file in its working directory.

    Valid values

    [string].lms (message file name)

    Default value

    (blank)

    Takes effect Immediately, if an application cannot find its *.lms file at startup

    print-attributes

    Enable printing extended attributes

    Specifies whether the application attaches extended attributes, if any exist, to a log event that it sends to log output. Typically, log events of the Interaction log level and Audit-related log events contain extended attributes. Setting this option to true enables audit capabilities, but negatively affects performance. Genesys recommends enabling this option for Solution Control Server and Configuration Server when using audit tracking. For other applications, refer to Genesys 7.5 Combined Log Events Help to find out whether an application generates Interaction-level and Audit-related log events; if it does, enable the option only when testing new interaction scenarios.

    Valid values

  • true Attaches extended attributes, if any exist, to a log event sent to log output.
  • false Does not attach extended attributes to a log event sent to log output.

    • Default value

    false

    Takes effect immediately

    segment

    Log Segmentation

    Specifies whether there is a segmentation limit for a log file. If there is, sets the mode of measurement, along with the maximum size. If the current log segment exceeds the size set by this option, the file is closed and a new one is created.

    Valid values

  • false No segmentation is allowed.
  • [number] KB or [number] Sets the maximum segment size, in kilobytes. The minimum segment size is 100 KB.
  • [number] MB Sets the maximum segment size, in megabytes.
  • [number] hr Sets the number of hours for the segment to stay open. The minimum number is 1 hour.

    • Default value

    10000

    Takes effect immediately

    spool

    Folder for the temporary network log output files

    Specifies the folder, including full path to it, in which an application creates temporary files related to network log output. If you change the option value while the application is running, the change does not affect the currently open network output.

    Valid values

    [path] (the folder, with the full path to it)

    Default value

    (blank)

    Takes effect immediately

    standard

    Output for level standard

    Specifies the outputs to which an application sends the log events of the Standard level. The log output types must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

    • Default value

    ..\logs\MCP,network

    Takes effect immediately

    time_convert

    Time generation for log messages

    Specifies the system in which an application calculates the log record time when generating a log file. The time is converted from the time in seconds since the Epoch (00:00:00 UTC, January 1, 1970).

    Valid values

    • local
    • utc
  • local The time of log record generation is expressed as a local time, based on the time zone and any seasonal adjustments. Time zone information of the application's host computer is used.
  • utc The time of log record generation is expressed as Coordinated Universal Time (UTC).

    • Default value

    local

    Takes effect immediately

    time_format

    Time format for log messages

    Specifies how to represent, in a log file, the time when an application generates log records.
    A log record's time field in the ISO 8601 format looks like this:
    2001-07-24T04:58:10.123

    Valid values

    • time
    • locale
    • ISO8601
  • time The time string is formatted according to the HH:MM:SS.sss (hours, minutes, seconds, and milliseconds) format.
  • locale The time string is formatted according to the system's locale.
  • ISO8601 The date in the time string is formatted according to the ISO 8601 format. Fractional seconds are given in milliseconds.

    • Default value

    time

    Takes effect immediately

    trace

    Output for level trace

    Specifies the outputs to which an application sends the log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels). The log outputs must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

    • Default value

    (blank)

    Takes effect immediately

    verbose

    Verbose Level

    Determines whether a log output is created. If it is, specifies the minimum level of log events generated. The log events levels, starting with the highest priority level, are Standard, Interaction, Trace, and Debug.

    Valid values

    • all
    • debug
    • trace
    • interaction
    • standard
    • none
  • all All log events (that is, log events of the Standard, Trace,Interaction, and Debug levels) are generated.
  • debug The same as all.
  • trace Log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels) are generated, but log events of the Debug level are not generated.
  • interaction Log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels) are generated, but log events of the Trace and Debug levels are not generated.
  • standard Log events of the Standard level are generated, but log events of the Interaction, Trace, and Debug levels are not generated.
  • none No output is produced.

    • Default value

    interaction

    Takes effect immediately