Datadog agent

Receive logs, metrics, and traces collected by a Datadog Agent

status: beta role: aggregator role: sidecar delivery: at-least-once acknowledgements: yes egress: batch state: stateless output: log output: metrics
Receives observability data from a Datadog Agent over HTTP or HTTPS.

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "datadog_agent",
      "acknowledgements": null,
      "address": "0.0.0.0:80"
    }
  }
}
[sources.my_source_id]
type = "datadog_agent"
address = "0.0.0.0:80"
---
sources:
  my_source_id:
    type: datadog_agent
    acknowledgements: null
    address: 0.0.0.0:80
{
  "sources": {
    "my_source_id": {
      "type": "datadog_agent",
      "acknowledgements": null,
      "address": "0.0.0.0:80",
      "multiple_outputs": null,
      "disable_logs": null,
      "disable_metrics": null,
      "disable_traces": null,
      "framing": null,
      "tls": null,
      "store_api_key": true,
      "decoding": null
    }
  }
}
[sources.my_source_id]
type = "datadog_agent"
address = "0.0.0.0:80"
store_api_key = true
---
sources:
  my_source_id:
    type: datadog_agent
    acknowledgements: null
    address: 0.0.0.0:80
    multiple_outputs: null
    disable_logs: null
    disable_metrics: null
    disable_traces: null
    framing: null
    tls: null
    store_api_key: true
    decoding: null

acknowledgements

common optional object
Controls how acknowledgements are handled by this source. These settings override the global acknowledgement settings. This setting is deprecated in favor of enabling acknowledgements in the destination sink.

acknowledgements.enabled

common optional bool
Controls if the source will wait for destination sinks to deliver the events before acknowledging receipt.
default: false

address

required string literal
The address to accept connections on. The address must include a port.
Examples
"0.0.0.0:80"
"localhost:80"

decoding

optional object
Configures how events are decoded from raw bytes.

decoding.codec

common optional string literal enum
The codec to use for decoding events.
Enum options
OptionDescription
bytesUses the raw bytes as-is.
gelfDecodes the raw bytes as a GELF message.
jsonDecodes the raw bytes as JSON.
native

Decodes the raw bytes as Vector’s native Protocol Buffers format.

This codec is experimental.

native_json

Decodes the raw bytes as Vector’s native JSON format.

This codec is experimental.

syslog

Decodes the raw bytes as a Syslog message.

Will decode either as the RFC 3164-style format (“old” style) or the more modern RFC 5424-style format (“new” style, includes structured data).

default: bytes

disable_logs

optional bool
If this settings is set to true, logs won’t be accepted by the component.
default: false

disable_metrics

optional bool
If this settings is set to true, metrics won’t be accepted by the component.
default: false

disable_traces

optional bool
If this settings is set to true, traces won’t be accepted by the component.
default: false

framing

optional object
Configures in which way incoming byte sequences are split up into byte frames.
Options for character_delimited framing.
Relevant when: method = `character_delimited`
The character used to separate frames.
Examples
"\n"
"\t"
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples
65535
102400

framing.method

common optional string literal enum
The framing method.
Enum options
OptionDescription
bytesByte frames are passed through as-is according to the underlying I/O boundaries (e.g. split between messages or stream segments).
character_delimitedByte frames which are delimited by a chosen character.
length_delimitedByte frames which are prefixed by an unsigned big-endian 32-bit integer indicating the length.
newline_delimitedByte frames which are delimited by a newline character.
octet_countingByte frames according to the octet counting format.
default: bytes
Options for newline_delimited framing.
Relevant when: method = `newline_delimited`
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples
65535
102400

framing.octet_counting

optional object
Options for octet_counting framing.
Relevant when: method = `octet_counting`
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples
65535
102400

multiple_outputs

optional bool
If this setting is set to true logs, metrics and traces will be sent to different outputs. For a source component named agent the received logs, metrics, and traces can then be accessed by specifying agent.logs, agent.metrics, and agent.traces, respectively, as the input to another component.
default: false

store_api_key

optional bool
When incoming events contain a Datadog API key, if this setting is set to true the key will kept in the event metadata and will be used if the event is sent to a Datadog sink.
default: true

tls

optional object
Configures the TLS options for incoming/outgoing connections.

tls.ca_file

optional string literal

Absolute path to an additional CA certificate file.

The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string in PEM format.

Examples
"/path/to/certificate_authority.crt"

tls.crt_file

optional string literal

Absolute path to a certificate file used to identify this server.

The certificate must be in DER, PEM (X.509), or PKCS#12 format. Additionally, the certificate can be provided as an inline string in PEM format.

If this is set, and is not a PKCS#12 archive, key_file must also be set.

Examples
"/path/to/host_certificate.crt"

tls.enabled

optional bool

Whether or not to require TLS for incoming/outgoing connections.

When enabled and used for incoming connections, an identity certificate is also required. See tls.crt_file for more information.

default: false

tls.key_file

optional string literal

Absolute path to a private key file used to identify this server.

The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.

Examples
"/path/to/host_certificate.key"

tls.key_pass

optional string literal

Passphrase used to unlock the encrypted key file.

This has no effect unless key_file is set.

Examples
"${KEY_PASS_ENV_VAR}"
"PassWord1"

Enables certificate verification.

If enabled, certificates must be valid in terms of not being expired, as well as being issued by a trusted issuer. This verification operates in a hierarchical manner, checking that not only the leaf certificate (the certificate presented by the client/server) is valid, but also that the issuer of that certificate is valid, and so on until reaching a root certificate.

Relevant for both incoming and outgoing connections.

Do NOT set this to false unless you understand the risks of not verifying the validity of certificates.

default: false

Outputs

<component_id>

Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks. Only active if multiple_outputs is disabled.

logs

If multiple_outputs is enabled, received log events will go to this output stream. Use <component_id>.logs as an input to downstream transforms and sinks.

metrics

If multiple_outputs is enabled, received metric events will go to this output stream. Use <component_id>.metrics as an input to downstream transforms and sinks.

traces

If multiple_outputs is enabled, received trace events will go to this output stream. Use <component_id>.traces as an input to downstream transforms and sinks.

Output Data

Metrics

counter

counter
A single value that can be incremented or reset to a zero value but not decremented.
* optional
Any tags present on the metric.
source_type
The name of the source type.

distribution

distribution
A distribution represents a distribution of sampled values. It is used with services that support global histograms and summaries.
* optional
Any tags present on the metric.
source_type
The name of the source type.

gauge

gauge
A gauge represents a point-in-time value that can increase and decrease. Vector’s internal gauge type represents changes to that value. Gauges should be used to track fluctuations in values, like current memory or CPU usage.
* optional
Any tags present on the metric.
source_type
The name of the source type.

Logs

Line

An individual event from a batch of events received through an HTTP POST request sent by a Datadog Agent.
Fields
ddsource required string literal
The source field extracted from the event.
Examples
java
ddtags required string literal
The comma separated tags list extracted from the event.
Examples
env:prod,region:ap-east-1
hostname required string literal
The local hostname, equivalent to the gethostname command.
Examples
my-host.local
message required string literal
The message field, containing the plain text message.
Examples
Hi from erlang
service required string literal
The service field extracted from the event.
Examples
backend
source_type required string literal
The name of the source type.
Examples
datadog_agent
status required string literal
The status field extracted from the event.
Examples
info
timestamp required timestamp
The exact time the event was ingested into Vector.
Examples
2020-10-10T17:07:36.452332Z

Telemetry

Metrics

link

component_discarded_events_total

counter
The number of events dropped by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.

component_errors_total

counter
The total number of errors encountered by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
error_type
The type of the error
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.
stage
The stage within the component at which the error occurred.

component_received_bytes_total

counter
The number of raw bytes accepted by this component from source origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_event_bytes_total

counter
The number of event bytes accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_events_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_sent_event_bytes_total

counter
The total number of event bytes emitted by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
output optional
The specific output of the component.
pid optional
The process ID of the Vector instance.

component_sent_events_total

counter
The total number of events emitted by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
output optional
The specific output of the component.
pid optional
The process ID of the Vector instance.

events_in_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins. This metric is deprecated and will be removed in a future version. Use component_received_events_total instead.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

events_out_total

counter
The total number of events emitted by this component. This metric is deprecated and will be removed in a future version. Use component_sent_events_total instead.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
output optional
The specific output of the component.
pid optional
The process ID of the Vector instance.

source_lag_time_seconds

histogram
The difference between the timestamp recorded in each event and the time when it was ingested, expressed as fractional seconds.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.

How it works

Context

By default, the datadog_agent source augments events with helpful context keys.

Configuring the Datadog Agent

Sending logs or metrics to Vector requires the Datadog Agent v7.35/6.35 or greater.

To send logs from a Datadog Agent to this source, the Datadog Agent configuration must be updated to use:

vector:
	logs.enabled: true
	logs.url: http://"<VECTOR_HOST>:<SOURCE_PORT>" # Use https if SSL is enabled in Vector source configuration

In order to send metrics the Datadog Agent configuration must be updated with the following options:

vector:
	metrics.enabled: true
	metrics.url: http://"<VECTOR_HOST>:<SOURCE_PORT>" # Use https if SSL is enabled in Vector source configuration

In order to send traces the Datadog Agent configuration must be updated with the following options:

vector:
	traces.enabled: true
	traces.url: http://"<VECTOR_HOST>:<SOURCE_PORT>" # Use https if SSL is enabled in Vector source configuration

State

This component is stateless, meaning its behavior is consistent across each input.

Transport Layer Security (TLS)

Vector uses OpenSSL for TLS protocols. You can adjust TLS behavior via the tls.* options.

Trace support caveats

The datadog_agent source is capable of receiving traces from the Datadog Agent and forwarding them to Datadog. In order to have accurate APM statistics, you should disable any sampling of traces within the Datadog Agent or client SDKs as Vector calculates the metrics that drive the APM statistics (like span hit count and duration distribution).