Datadog agent
Receive logs, metrics, and traces collected by a Datadog Agent
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 objectacknowledgement
settings. This setting is deprecated in favor of enabling acknowledgements
in the destination sink.acknowledgements.enabled
common optional boolfalse
address
required string literaldecoding
optional objectdecoding.codec
common optional string literal enumOption | Description |
---|---|
bytes | Uses the raw bytes as-is. |
gelf | Decodes the raw bytes as a GELF message. |
json | Decodes 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). |
bytes
disable_logs
optional booltrue
, logs won’t be accepted by the component.false
disable_metrics
optional booltrue
, metrics won’t be accepted by the component.false
disable_traces
optional booltrue
, traces won’t be accepted by the component.false
framing
optional objectframing.character_delimited
required objectcharacter_delimited
framing.method = `character_delimited`
framing.character_delimited.delimiter
required ascii_charframing.character_delimited.max_length
optional uintmax_length
bytes will be discarded entirely.framing.method
common optional string literal enumOption | Description |
---|---|
bytes | Byte frames are passed through as-is according to the underlying I/O boundaries (e.g. split between messages or stream segments). |
character_delimited | Byte frames which are delimited by a chosen character. |
length_delimited | Byte frames which are prefixed by an unsigned big-endian 32-bit integer indicating the length. |
newline_delimited | Byte frames which are delimited by a newline character. |
octet_counting | Byte frames according to the octet counting format. |
bytes
framing.newline_delimited
optional objectnewline_delimited
framing.method = `newline_delimited`
framing.newline_delimited.max_length
optional uintmax_length
bytes will be discarded entirely.framing.octet_counting
optional objectoctet_counting
framing.method = `octet_counting`
framing.octet_counting.max_length
optional uintmax_length
bytes will be discarded entirely.multiple_outputs
optional booltrue
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.false
store_api_key
optional booltrue
the key will kept in the event metadata and will be used if the event is sent to a Datadog sink.true
tls
optional objecttls.ca_file
optional string literalAbsolute 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.
tls.crt_file
optional string literalAbsolute 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.
tls.enabled
optional boolWhether 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.
false
tls.key_file
optional string literalAbsolute 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.
tls.key_pass
optional string literalPassphrase used to unlock the encrypted key file.
This has no effect unless key_file
is set.
tls.verify_certificate
optional boolEnables 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.
false
Outputs
<component_id>
logs
<component_id>.logs
as an input to downstream transforms and sinks.metrics
<component_id>.metrics
as an input to downstream transforms and sinks.traces
<component_id>.traces
as an input to downstream transforms and sinks.Output Data
Metrics
counter
counterdistribution
distributiongauge
gaugeLogs
Line
java
env:prod,region:ap-east-1
gethostname
command.my-host.local
Hi from erlang
backend
datadog_agent
info
2020-10-10T17:07:36.452332Z
Telemetry
Metrics
linkcomponent_discarded_events_total
countercomponent_id
instead. The value is the same as component_id
.component_errors_total
countercomponent_id
instead. The value is the same as component_id
.component_received_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_received_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_received_events_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_events_total
countercomponent_id
instead. The value is the same as component_id
.events_in_total
countercomponent_received_events_total
instead.component_id
instead. The value is the same as component_id
.events_out_total
countercomponent_sent_events_total
instead.component_id
instead. The value is the same as component_id
.source_lag_time_seconds
histogramcomponent_id
instead. The value is the same as component_id
.How it works
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
Transport Layer Security (TLS)
tls.*
options.Trace support caveats
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).