Datadog events
Publish observability events to the Datadog Events API
Configuration
Example configurations
{
"sinks": {
"my_sink_id": {
"type": "datadog_events",
"inputs": [
"my-source-or-transform-id"
],
"default_api_key": "${DATADOG_API_KEY_ENV_VAR}"
}
}
}[sinks.my_sink_id]
type = "datadog_events"
inputs = [ "my-source-or-transform-id" ]
default_api_key = "${DATADOG_API_KEY_ENV_VAR}"
---
sinks:
my_sink_id:
type: datadog_events
inputs:
- my-source-or-transform-id
default_api_key: ${DATADOG_API_KEY_ENV_VAR}
{
"sinks": {
"my_sink_id": {
"type": "datadog_events",
"inputs": [
"my-source-or-transform-id"
],
"default_api_key": "${DATADOG_API_KEY_ENV_VAR}",
"endpoint": "http://127.0.0.1:8080",
"region": "eu",
"site": "datadoghq.com"
}
}
}[sinks.my_sink_id]
type = "datadog_events"
inputs = [ "my-source-or-transform-id" ]
default_api_key = "${DATADOG_API_KEY_ENV_VAR}"
endpoint = "http://127.0.0.1:8080"
region = "eu"
site = "datadoghq.com"
---
sinks:
my_sink_id:
type: datadog_events
inputs:
- my-source-or-transform-id
default_api_key: ${DATADOG_API_KEY_ENV_VAR}
endpoint: http://127.0.0.1:8080
region: eu
site: datadoghq.com
acknowledgements
optional objectControls how acknowledgements are handled for this sink.
See End-to-end Acknowledgements for more information on how event acknowledgement is handled.
acknowledgements.enabled
optional boolWhether or not end-to-end acknowledgements are enabled.
When enabled for a sink, any source connected to that sink, where the source supports end-to-end acknowledgements as well, will wait for events to be acknowledged by the sink before acknowledging them at the source.
Enabling or disabling acknowledgements at the sink level takes precedence over any global
acknowledgements configuration.
buffer
optional objectConfigures the buffering behavior for this sink.
More information about the individual buffer types, and buffer behavior, can be found in the Buffering Model section.
buffer.max_events
optional uinttype = "memory"500buffer.max_size
required uintThe maximum size of the buffer on disk.
Must be at least ~256 megabytes (268435488 bytes).
type = "disk"buffer.type
optional string literal enum| Option | Description |
|---|---|
disk | Events are buffered on disk. This is less performant, but more durable. Data that has been synchronized to disk will not be lost if Vector is restarted forcefully or crashes. Data is synchronized to disk every 500ms. |
memory | Events are buffered in memory. This is more performant, but less durable. Data will be lost if Vector is restarted forcefully or crashes. |
memorybuffer.when_full
optional string literal enum| Option | Description |
|---|---|
block | Wait for free space in the buffer. This applies backpressure up the topology, signalling that sources should slow down the acceptance/consumption of events. This means that while no data is lost, data will pile up at the edge. |
drop_newest | Drops the event instead of waiting for free space in buffer. The event will be intentionally dropped. This mode is typically used when performance is the highest priority, and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance/consumption of events. |
blockdefault_api_key
required string literalendpoint
optional string literalThe endpoint to send observability data to.
The endpoint must contain an HTTP scheme, and may specify a hostname or IP address and port.
If set, overrides the site option.
healthcheck
optional objecthealthcheck.enabled
optional booltrueinputs
required [string]A list of upstream source or transform IDs.
Wildcards (*) are supported.
See configuration for more info.
proxy
optional objectProxy configuration.
Configure to proxy traffic through an HTTP(S) proxy when making external requests.
Similar to common proxy configuration convention, users can set different proxies to use based on the type of traffic being proxied, as well as set specific hosts that should not be proxied.
proxy.http
optional string literalProxy endpoint to use when proxying HTTP traffic.
Must be a valid URI string.
proxy.https
optional string literalProxy endpoint to use when proxying HTTPS traffic.
Must be a valid URI string.
proxy.no_proxy
optional [string]A list of hosts to avoid proxying.
Multiple patterns are allowed:
| Pattern | Example match |
|---|---|
| Domain names | example.com matches requests to example.com |
| Wildcard domains | .example.com matches requests to example.com and its subdomains |
| IP addresses | 127.0.0.1 matches requests to 127.0.0.1 |
| CIDR blocks | 192.168.0.0/16 matches requests to any IP addresses in this range |
| Splat | * matches all hosts |
region
optional string literal enum| Option | Description |
|---|---|
eu | EU region. |
us | US region. |
request
optional objectMiddleware settings for outbound requests.
Various settings can be configured, such as concurrency and rate limits, timeouts, etc.
request.adaptive_concurrency
optional objectConfiguration of adaptive concurrency parameters.
These parameters typically do not require changes from the default, and incorrect values can lead to meta-stable or unstable performance and sink behavior. Proceed with caution.
request.adaptive_concurrency.decrease_ratio
optional floatThe fraction of the current value to set the new concurrency limit when decreasing the limit.
Valid values are greater than 0 and less than 1. Smaller values cause the algorithm to scale back rapidly
when latency increases.
Note that the new limit is rounded down after applying this ratio.
0.9request.adaptive_concurrency.ewma_alpha
optional floatThe weighting of new measurements compared to older measurements.
Valid values are greater than 0 and less than 1.
ARC uses an exponentially weighted moving average (EWMA) of past RTT measurements as a reference to compare with the current RTT. Smaller values cause this reference to adjust more slowly, which may be useful if a service has unusually high response variability.
0.4request.adaptive_concurrency.rtt_deviation_scale
optional floatScale of RTT deviations which are not considered anomalous.
Valid values are greater than or equal to 0, and we expect reasonable values to range from 1.0 to 3.0.
When calculating the past RTT average, we also compute a secondary “deviation” value that indicates how variable those values are. We use that deviation when comparing the past RTT average to the current measurements, so we can ignore increases in RTT that are within an expected range. This factor is used to scale up the deviation to an appropriate range. Larger values cause the algorithm to ignore larger increases in the RTT.
2.5request.concurrency
optional string literal enum uint| Option | Description |
|---|---|
adaptive | Concurrency will be managed by Vector’s Adaptive Request Concurrency feature. |
none | A fixed concurrency of 1. Only one request can be outstanding at any given time. |
nonerequest.rate_limit_duration_secs
optional uintrate_limit_num option.1 (seconds)request.rate_limit_num
optional uintrate_limit_duration_secs time window.9.223372036854776e+18 (requests)request.retry_attempts
optional uintThe maximum number of retries to make for failed requests.
The default, for all intents and purposes, represents an infinite number of retries.
9.223372036854776e+18 (retries)request.retry_initial_backoff_secs
optional uintThe amount of time to wait before attempting the first retry for a failed request.
After the first retry has failed, the fibonacci sequence will be used to select future backoffs.
1 (seconds)request.retry_max_duration_secs
optional uint3600 (seconds)request.timeout_secs
optional uintThe time a request can take before being aborted.
It is highly recommended that you do not lower this value below the service’s internal timeout, as this could create orphaned requests, pile on retries, and result in duplicate data downstream.
60 (seconds)tls
optional objecttls.alpn_protocols
optional [string]Sets the list of supported ALPN protocols.
Declare the supported ALPN protocols, which are used during negotiation with peer. Prioritized in the order they are defined.
tls.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.
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.
tls.verify_hostname
optional boolEnables hostname verification.
If enabled, the hostname used to connect to the remote host must be present in the TLS certificate presented by the remote host, either as the Common Name or as an entry in the Subject Alternative Name extension.
Only relevant for outgoing connections.
Do NOT set this to false unless you understand the risks of not verifying the remote hostname.
Telemetry
Metrics
linkbuffer_byte_size
gaugecomponent_id instead. The value is the same as component_id.buffer_discarded_events_total
countercomponent_id instead. The value is the same as component_id.buffer_events
gaugecomponent_id instead. The value is the same as component_id.buffer_received_event_bytes_total
countercomponent_id instead. The value is the same as component_id.buffer_received_events_total
countercomponent_id instead. The value is the same as component_id.buffer_sent_event_bytes_total
countercomponent_id instead. The value is the same as component_id.buffer_sent_events_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_count
histogramA histogram of the number of events passed in each internal batch in Vector’s internal topology.
Note that this is separate than sink-level batching. It is mostly useful for low level debugging performance issues in Vector due to small internal batches.
component_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_bytes_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.utilization
gaugecomponent_id instead. The value is the same as component_id.How it works
Health checks
Require health checks
If you’d like to exit immediately upon a health check failure, you can pass the
--require-healthy flag:
vector --config /etc/vector/vector.toml --require-healthy
Disable health checks
healthcheck option to
false.Rate limits & adaptive concurrency
Adaptive Request Concurrency (ARC)
Adaptive Request Concurrency is a feature of Vector that does away with static concurrency limits and automatically optimizes HTTP concurrency based on downstream service responses. The underlying mechanism is a feedback loop inspired by TCP congestion control algorithms. Checkout the announcement blog post,
We highly recommend enabling this feature as it improves performance and reliability of Vector and the systems it communicates with. As such, we have made it the default, and no further configuration is required.
Static concurrency
If Adaptive Request Concurrency is not for you, you can manually set static concurrency
limits by specifying an integer for request.concurrency:
[sinks.my-sink]
request.concurrency = 10
Rate limits
In addition to limiting request concurrency, you can also limit the overall request
throughput via the request.rate_limit_duration_secs and request.rate_limit_num
options.
[sinks.my-sink]
request.rate_limit_duration_secs = 1
request.rate_limit_num = 10
These will apply to both adaptive and fixed request.concurrency values.