Jump to: navigation, search

log Section

access-log-apptype-filter-in

Description: Specifies the AppType filter for client requests that will be written to the access log file. For example, you can filter an Interaction Workspace application by setting the option to CFGInteractionWorkspace. Note that AppType is a non-mandatory attribute that the client application must specify.
Default Value: No default value
Valid Values: Any comma-separated list of valid AppTypes.
Mandatory: No
Changes Take Effect: Immediately

access-log-apptype-filter-out

Description: Specifies the AppType filter for client requests that will not be written to the access log file. For example, you can set the value to EMAIL_SERVER, Custom App to avoid those applications being logged. Note that AppType is a non-mandatory attribute that the client application must specify.
Default Value: No default value
Valid Values: Any comma-separated list of valid AppTypes.
Mandatory: No
Changes Take Effect: Immediately

access-log-path

Description: The path to the access log files
Default Value: access.log
Valid Values: String
Mandatory: No
Changes Take Effect: Immediately

access-log-rolling-period

Description: Specifies the rolling schedule as a pattern. For example, with the default value, every day at UCS local time, the current log file will be moved to <UCS installation folder>\access.log.2012-09-29 for each day of activity.
Default Value: ‘.’yyyy-MM-dd
Valid Values:

  • '.'yyyy-MM-dd—Daily. Rollover at midnight each day.
  • '.'yyyy-MM-dd-a—Twice daily. Rollover at midnight and midday of each day.
  • '.'yyyy-MM-dd-HH—Hourly. Rollover at the top of every hour.

Mandatory: No
Changes Take Effect: Immediately

all

Description: 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. For example: all = stdout, logfile
Default Value: stdout
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.

Changes Take Effect: Immediately

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.

buffering

Description: Turns on/off operating system file buffering. The option is applicable only to the stderr and stdout output. Setting this option to true increases the output performance.
Default Value: false
Valid Values: true enables buffering. false disables buffering.
Changes Take Effect: Immediately

debug

Description: 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 outputs must be separated by a comma when more than one output is configured. For example: debug = stderr, network
Default Value: stdout
Valid Values:

  • stdout—Log events are sent to the Standard output (stdout).
  • stderr*mdash;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. 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.

Changes Take Effect: Immediately

display-value

Description: Specifies whether the statement values are displayed in logs.
Valid Values: true, false
Default Value: false
Changes Take Effect: After start/restart

enable-access-log

Description: Enables (true) the access log file. The log file will be written one line per client request. Each line contains the IDs of the records accessed by the client application in the case of view, create, update, and delete operations.
Default Value: false
Valid Values: true/false
Mandatory: No
Changes Take Effect: Immediately

expire

Description: 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. This option is ignored if log output is not configured to be sent to a log file.
Default Value: 10
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.

If an option's value is set incorrectly—out of the range of valid values—it is automatically reset to 10.
Changes Take Effect: Immediately

log-background-activity

Description: Enables or disables the display of background activity in the log.
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately

log-body

Description: Enables or disables the logging of body request and response for Context Services.
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately


segment

Description: Specifies log segment size.
Default Value: 50000
Valid Values:

  • false—Disables log segmentation.
  • Any valid integer—Specifies segment size.

Changes Take Effect: Immediately

standard

Description: 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. For example: standard = stderr, network
Default Value: stdout
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. 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.

Changes Take Effect: Immediately

trace

Description: 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. For example: trace = stderr, network
Default Value: stdout
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. 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.

Changes Take Effect: Immediately

verbose

Description: 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. Default Value: standard Valid Values:

  • 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.

Changes Take Effect: Immediately

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 06:55.