ClientLogStreamingConfig

ClientLogStreamingConfig
ClientLogStreamingConfig
JSON Example
{
    "external_server": "string",
    "external_server_port": 0,
    "format_config": {
        "format": "string",
        "included_fields": [
            "string"
        ]
    },
    "log_types_to_send": "string",
    "marker_keys": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "max_logs_per_second": 0,
    "protocol": "string",
    "syslog_config": {
        "facility": 0,
        "filtered_log_severity": 0,
        "hostname": "string",
        "msg_id": "string",
        "non_significant_log_severity": 0,
        "proc_id": "string",
        "significant_log_severity": 0
    }
}
string
external_server
Required

IP address or hostnames (FQDNs) of destination servers. If an FQDN is provided, this should be resolvable on Avi Service Engines. Multiple servers are supported by furnishing a comma-separated list of IP addresses or host names, for example, 11.11.11.11,23.12.12.4,2001 123 1. Optionally, a separate port can be specified for each external server in the list, for example,11.11.11.11 234,12.12.12.12 343,[2001 123 1] 234. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
external_server_port
Optional
Constraints: default: 514

The service port to use for the external servers. If multiple external servers have been specified, the single port number specified here will apply to all those servers for which an explicit port number has not been specified in the external server list. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

format_config
Optional

format_config

string
log_types_to_send
Optional
Constraints: default: LOGS_ALL

Type of logs to stream to the external server. Default is LOGS_ALL, i.e., send all logs. Enum options - LOGS_SIGNIFICANT_ONLY, LOGS_UDF_ONLY, LOGS_UDF_SIGNIFICANT, LOGS_ALL. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

marker_keys
Optional

One or more keys which should exist in VirtualService RBAC markers. Key along with values will be streamed out in log. If key is not found in RBAC markers, it will not be streamed. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_logs_per_second
Optional
Constraints: default: 100

Maximum number of logs per second streamed to the remote server. By default, 100 logs per second are streamed. Set this to zero(0) to not enforce any limit. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
protocol
Optional
Constraints: default: LOG_STREAMING_PROTOCOL_UDP

Protocol to use for streaming logs. Enum options - LOG_STREAMING_PROTOCOL_UDP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_UDP, LOG_STREAMING_PROTOCOL_TCP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TCP, LOG_STREAMING_PROTOCOL_RAW_OVER_UDP, LOG_STREAMING_PROTOCOL_TLS, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TLS. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

syslog_config
Optional

syslog_config

Property Of