Datadog Logs 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 Datadog Logs destination plugin (name: datadog) lets you configure your telemetry pipeline to integrate your telemetry data with Datadog Logs, letting you store, analyze, and visualize your log data using logging tools in Datadog.

Supported telemetry types

The Datadog Logs 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 Datadog Logs 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.

Required

Name	Key	Description	Default
Datadog API Key	`apikey`	Required. Datadog API Key found within account settings.	none

Advanced

Name	Key	Description	Default
Datadog Server	`host`	The Datadog server where you’re sending your logs.	`http-intake.logs.datadoghq.com`
Datadog Service Name	`dd_service`	The human-readable name for your service generating the logs. The name of your app or database.	none
Datadog Source Name	`dd_source`	A human readable name for the underlying technology of your service. For example, `postgres` or `nginx`.	none
Datadog Tags	`dd_tags`	The tags you want to assign to your logs in Datadog.	none
Datadog Message Key	`dd_message_key`	By default, the plugin searches for the key ‘log’ and remap the value to the key `message`. If the property is set, the plugin searches the property name key.	none
Include Tag Key	`include_tag_key`	If `true`, tag is appended to output. The key name is used `tag_key` property. Accepted values: `true`, `false`.	`false`
Tag Key	`tag_key`	The key name of tag. If `include_tag_key` is false, This property is ignored.	`tagkey`
JSON Date Key	`json_date_key`	Date key name for output in log.	`timestamp`
Compression	`compress`	Compresses the payload in GZIP format, Datadog supports and recommends setting this to ‘gzip’.	`gzip`
Proxy	`proxy`	Specifies an HTTP Proxy. The expected format of this value is `http://host:port`. HTTPS isn’t supported.	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`