Datadog agent

Receive logs collected by a Datadog Agent

status: beta role: aggregator role: sidecar delivery: at-least-once egress: batch state: stateless output: log
Page source Edit this page
Receives observability data from a Datadog Agent over HTTP or HTTPS. For now, this is limited to logs, but will be expanded in the future to cover metrics and traces.

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",
      "store_api_key": true
    }
  }
}
[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
    framing: null
    tls: null
    store_api_key: true
    decoding: null

acknowledgements

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

Warning

Disabling this option may lead to loss of data, as destination sinks may reject events after the source acknowledges their successful 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 in which way frames are decoded into events.

decoding.codec

optional string literal enum
The decoding method.
Enum options
OptionDescription
bytesEvents containing the byte frame as-is.
jsonEvents being parsed from a JSON string.
syslogEvents being parsed from a Syslog message.
default: bytes

framing

optional object
Configures in which way incoming byte sequences are split up into byte frames.

framing.character_delimited

optional object
Options for character_delimited framing.
Relevant when: method = `character_delimited`
framing.character_delimited.delimiter
optional string literal
The character used to separate frames.
Examples 
"\n"
"\t"
framing.character_delimited.max_length
optional uint
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples 
65535
102400

framing.method

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 whose length is encoded in a header.
newline_delimitedByte frames which are delimited by a newline character.
octet_countingByte frames according to the octet counting format.
default: bytes

framing.newline_delimited

optional object
Options for newline_delimited framing.
Relevant when: method = `newline_delimited`
framing.newline_delimited.max_length
optional uint
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`
framing.octet_counting.max_length
optional uint
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples 
65535
102400

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 connections.

tls.ca_file

optional string literal
Absolute path to an additional CA certificate file, in DER or PEM format (X.509), or an in-line CA certificate 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, in DER or PEM format (X.509) or PKCS#12, or an in-line certificate in PEM format. If this is set, and is not a PKCS#12 archive, key_file must also be set. This is required if enabled is set to true.
Examples 
"/path/to/host_certificate.crt"

tls.enabled

optional bool
Require TLS for incoming connections. If this is set, an identity certificate is also required.
default: false

tls.key_file

optional string literal
Absolute path to a private key file used to identify this server, in DER or PEM format (PKCS#8), or an in-line private key in PEM format.
Examples 
"/path/to/host_certificate.key"

tls.key_pass

optional string literal
Pass phrase used to unlock the encrypted key file. This has no effect unless key_file is set.
Examples 
"${KEY_PASS_ENV_VAR}"
"PassWord1"

tls.verify_certificate

optional bool
If true, Vector will require a TLS certificate from the connecting host and terminate the connection if the certificate is not valid. If false (the default), Vector will not request a certificate from the client.
default: false

Output

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 coma 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
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_sent_event_bytes_total

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

component_sent_events_total

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

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 required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
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

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

logs_config:
	dd_url: "<VECTOR_HOST>:<SOURCE_PORT>"
	use_v2_api: false # source does not yet support new v2 API
	use_http: true # this source only supports HTTP/HTTPS
	logs_no_ssl: true|false # should match source SSL 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.
Sidebar