SyslogConfiguration

SyslogConfiguration
SyslogConfiguration
JSON Example
{
    "enabled": false,
    "address": "string",
    "port": "string",
    "transport_protocol": "string",
    "queue_size": 0,
    "tls_enabled": false,
    "permitted_peer": "string",
    "ssl_ca_certificate": "string",
    "environment": "string",
    "forward_debug_logs": false,
    "custom_rsyslog_configuration": "string"
}
boolean
enabled
Optional

Change this to true to use syslog

string
address
Optional

Required. The address or host for the syslog server. Can be a hostname or an IP address

string
port
Optional

Required. The port on which the syslog server listens

string
transport_protocol
Optional

Required. The transport protocol used to send syslog messages to the server

Possible values are : tcp, udp,
integer
queue_size
Optional
Constraints: default: 100000

Optional. The number of log messages the buffer holds before dropping messages. A larger buffer size might overload the system.

boolean
tls_enabled
Optional

Required. Change this to true to use TLS.

string
permitted_peer
Optional

Required when using tls_enabled is true. Either the accepted fingerprint (SHA1) or name of remote peer, e.g. *.example.com

string
ssl_ca_certificate
Optional

Required when using tls_enabled is true. This certificate will ensure that logs get securely transported to the syslog destination

string
environment
Optional

A human-readable identifier that will be included in log lines

boolean
forward_debug_logs
Optional

Optional. Some components produce voluminous debug logs. Change this to true to prevent debug logs from being forwarded. They will still be written to local disk.

string
custom_rsyslog_configuration
Optional

Optional. Accepts configuration for rsyslog in the rainerscript syntax. For example, 'if ($app-name startswith "exampleComponent") then stop' can be used to drop all traffic from a particular component. Entered configuration will be applied prior to the forwarding rule.