Graylog destination plugin - Cortex XCOR Documentation

This information is for Palo Alto Networks Telemetry Pipeline, which is a standalone product separate from Palo Alto Networks Cortex XCOR.

The Graylog destination plugin (name: gelf) lets you send your telemetry pipeline data to Graylog.

Supported telemetry types

The Graylog destination plugin for Palo Alto Networks Telemetry Pipeline supports these telemetry types:

Logs	Metrics	Traces

Configuration parameters

Use the parameters in this section to configure the Graylog destination plugin. The Palo Alto Networks Telemetry Pipeline web interface uses the items in the Name column to describe these parameters. Pipeline configuration files use the items in the Key column as YAML keys.

General

Name	Key	Description	Default
Host	`Host`	IP address or hostname of the target Graylog server.	`127.0.0.1`
Port	`Port`	The port that your Graylog GELF input is listening on.	`12201`
Mode	`Mode`	The protocol to use (`tls`, `tcp` or `udp`).	`udp`
Packet Size	`Packet_Size`	If `mode` is `udp`, sets the size of packets to be sent.	`1420`
Compress	`Compress`	If `true`, and `mode` is `udp`, compresses your UDP packets. Accepted values: `true`, `false`.	`true`

GELF settings

Name	Key	Description	Default
GELF Short Message Key	`Gelf_Short_Message_Key`	A short descriptive message (must be set in GELF).	`short_message`
GELF Timestamp Key	`Gelf_Timestamp_Key`	Your log timestamp (should be set in GELF).	`timestamp`
GELF Host Key	`Gelf_Host_Key`	This key value is used as the name of the host, source, or app that sent this message. (must be set in GELF).	`host`
GELF Full Message Key	`Gelf_Full_Message_Key`	Key to use as the long message. (Optional in GELF).	none
GELF Level Key	`Gelf_Level_Key`	Key to be used as the log level. Its value must be in standard syslog levels between 0 and 7. (Optional in GELF).	none

Security and TLS

Name	Key	Description	Default
TLS	`tls`	If `true`, enables TLS/SSL. If `false`, disables TLS/SSL. Accepted values: `true`, `false`.	`false`
TLS Certificate Validation	`tls.verify`	If `on`, and if `tls` is `true`, enables TLS/SSL certificate validation. If `off`, disables TLS/SSL certificate validation. Accepted values: `on`, `off`.	`on`
TLS Debug Level	`tls.debug`	Sets TLS debug verbosity level. Accepted values: `0` (No debug), `1` (Error), `2` (State change), `3` (Informational), `4` (Verbose).	`1`
CA Certificate File Path	`tls.ca_file`	Absolute path to CA certificate file.	none
Certificate File Path	`tls.crt_file`	Absolute path to certificate file.	none
Private Key File Path	`tls.key_file`	Absolute path to private key file.	none
Private Key Path Password	`tls.key_passwd`	Password for private key file.	none
TLS SNI Hostname Extension	`tls.vhost`	Hostname to be used for TLS SNI extension.	none

Advanced Networking

Name	Key	Description	Default
DNS Mode	`net.dns.mode`	Selects the primary DNS connection type, which can be `TCP` or `UDP`.	none
DNS Resolver	`net.dns.resolver`	Selects the primary DNS connection type, which can be `LEGACY` or `ASYNC`.	none
Prefer IPv4	`net.dns.prefer_ipv4`	Prioritizes IPv4 DNS results when trying to establish a connection. Accepted values: `true`, `false`.	`false`
Keepalive	`net.keepalive`	Enables or disables Keepalive support. Accepted values: `true`, `false`.	`true`
Keepalive Idle Timeout	`net.keepalive_idle_timeout`	Sets the maximum time allowed for an idle Keepalive connection.	`30s`
Max Connect Timeout	`net.connect_timeout`	Sets the maximum time allowed to establish a connection, which includes the TLS handshake.	`10s`
Max Connect Timeout Log Error	`net.connect_timeout_log_error`	Specifies whether to log an error on connection timeout. When disabled, the timeout is logged as a debug message. Accepted values: `true`, `false`.	`true`
Source Address	`net.source_address`	Specifies the network address to bind for data traffic.	none
Max Keepalive Recycle	`net.keepalive_max_recycle`	Sets the maximum number of times a keepalive connection can be used before it’s retired.	`2000`