Logging Parameters
| Parameter | Default | Description |
|---|---|---|
| Log_Level | WARN | Level of logging performed by the client. Valid values: (values are not case-sensitive) • NONE - Disables client logging. It is recommended that you do not disable logging. • ERROR - Logs the error messages only. • WARN - Logs the error messages and warnings. • INFO - Logs the error messages, warnings, and informational messages. • DEBUG - Logs the diagnostic information. Note: The user running the client application must have permission to write to the log file and to create new files in the directory where the log files are created. Applies to both, file logging as well as syslog logging. |
| Log_File | LogFile.txt | Name and path to the log file. The path can be absolute or relative to your application. Do not use quotes, even if the path contains spaces. Note: The user running the client application must have permission to write to the log file and to create new files in the directory where the log files. |
| Log_Rotation | Daily | Specifies whether logs file is rotated daily or once it reach a certain size. Possible settings: • Daily- Rotates the log file daily. • Size- Rotates the log file when it reaches the size specified in the Log_Size_Limit parameter. |
| Log_Size_Limit | 100k | Specifies how large the log files can be before they are rotated. This parameter is used only when Log_Rotation is set to Size. The default unit is bytes. You can use the suffix k (or K) for kilobytes and m (or M) for megabytes. |
| Syslog_Server_IP | no default | Syslog Server is the dedicated server where you want to dump all your logs. If this value is set, logs will be pushed to the syslog server in addition to local file logging as specified by the Log_File field. |
| Syslog_Server_Port | 514 | Syslog Server Port to dump all your logs. |
| Syslog_Server_Protocol | TCP | Syslog Server Protocol to dump all your logs. Valid values: • SSL • TCP • UDP Note: It is recommended to use SSL as it establishes the most secure communication between client and the Syslog server. |
| Syslog_CA | no default | Useful only when Syslog_Server_Protocol is set to SSL. The CA certificate that signed the Syslog server certificate presented to clients to establish SSL connections.If the CA certificate is in file system, provide path of the CA certificate. In case if CA is installed under trusted root authorities in system certificate store, there is no need to set this field. The path can be absolute or relative to the application. Do not use quotes when specifying the path, even if it contains spaces. In case of root Certificate Authority, specify single root CA in the file. For intermediate CAs, specify all the intermediate CAs with the root CA in the file. Example: <Syslog_CA>C:\Certificates\syslog_ca_cert.pem</Syslog_CA> |
| Syslog_Cert | no default | Useful only when Syslog_Server_Protocol is set to SSL. The path of client certificate to present to the Syslog server for client authentication.This value is required when client certificate authentication is enabled on the Syslog server. The certificate must be in pfx format. It works for all the platforms including windows.Example: <Syslog_Cert>C:\Certificates\syslog_client_cert.pfx</ClientCert> |
| Syslog_Passphrase | no default | The Export password provided while creating Syslog client certificate in pfx format.This value is required when client certificate authentication is enabled on the Syslog server. If Syslog_Passphrase_Encrypted is set to yes, you need to provide its value in the encrypted format using API Definition for PassPhraseEncryption Method. |
| Syslog_Passphrase_Encrypted | no | Specifies whether the value provided in Syslog_Passphrase is encrypted using the PassPhraseEncryption method from the PassPhraseSecure class. Possible settings in the Properties file • yes - encrypts the value provided in the Syslog_Passphrase parameter.• no - doesn't encrypt the value specified in the Syslog_Passphrase parameter.For more details of PassPhraseEncryption method, refer to API Definition for PassPhraseEncryption Method. |
For Syslog Advanced Configuration Parameters, click here.
