Datadog Logs Source

The Vector datadog_logs source receives logs from a Datadog Agent over HTTP or HTTPS.

Configuration

[sources.my_source_id]
type = "datadog_logs" # required
address = "0.0.0.0:80" # required
  • commonrequiredstring

    address

    The address to accept connections on. The address must include a port.

    • Syntax: literal
  • optionaltable

    tls

    Configures the TLS options for incoming connections.

    • optionalstring

      ca_file

      Absolute path to an additional CA certificate file, in DER or PEM format (X.509), or an in-line CA certificate in PEM format.

      • Syntax: literal
    • optionalstring

      crt_file

      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.

      • Syntax: literal
    • optionalbool

      enabled

      Require TLS for incoming connections. If this is set, an identity certificate is also required.

      • Default: false
    • optionalstring

      key_file

      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.

      • Syntax: literal
    • optionalstring

      key_pass

      Pass phrase used to unlock the encrypted key file. This has no effect unless key_file is set.

      • Syntax: literal
    • optionalbool

      verify_certificate

      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

This component outputs log events with the following fields:

{
"dd_api_key" : "abcdefgh13245678abcdefgh13245678",
"ddsource" : "java",
"ddtags" : "env:prod,region:ap-east-1",
"hostname" : "my-host.local",
"message" : "Hi from erlang",
"service" : "backend",
"status" : "info",
"timestamp" : "2020-10-10T17:07:36+00:00"
}
  • commonrequiredstring

    dd_api_key

    The Datadog API key extracted from the event. This sensitive field may be removed or obfuscated using the remap transform.

    • Syntax: literal
  • commonrequiredstring

    ddsource

    The source field extracted from the event.

    • Syntax: literal
  • commonrequiredstring

    ddtags

    The coma separated tags list extracted from the event.

    • Syntax: literal
  • commonrequiredstring

    hostname

    The local hostname, equivalent to the gethostname command.

    • Syntax: literal
  • commonrequiredstring

    message

    The message field, containing the plain text message.

    • Syntax: literal
  • commonrequiredstring

    service

    The service field extracted from the event.

    • Syntax: literal
  • commonrequiredstring

    status

    The status field extracted from the event.

    • Syntax: literal
  • commonrequiredtimestamp

    timestamp

    The exact time the event was ingested into Vector.

Telemetry

This component provides the following metrics that can be retrieved through the internal_metrics source. See the metrics section in the monitoring page for more info.

  • counter

    events_out_total

    The total number of events emitted by this component. This metric includes the following tags:

    • component_kind - The Vector component kind.

    • component_name - The Vector component ID.

    • component_type - The Vector component type.

    • instance - The Vector instance identified by host and port.

    • job - The name of the job producing Vector metrics.

How It Works

Context

By default, the datadog_logs source will augment events with helpful context keys as shown in the "Output" section.

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.