Edge Delta Dynatrace Destination

Configure the Dynatrace Node to send telemetry data to a Dynatrace endpoint using TLS.

6 minute read

Overview

The Dynatrace Node sends items to a Dynatrace destination over TLS. The items are processed and formatted to be compatible with Dynatrace.

incoming_data_types: cluster_pattern_and_sample, log, custom, metric, trace

Example Configuration

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com

Required Parameters

name

A descriptive name for the node. This is the name that will appear in pipeline builder and you can reference this node in the YAML using the name. It must be unique across all nodes. It is a YAML list element so it begins with a - and a space followed by the string. It is a required parameter for all nodes.

nodes:
  - name: <node name>
    type: <node type>

type: dynatrace_output

The type parameter specifies the type of node being configured. It is specified as a string from a closed list of node types. It is a required parameter.

nodes:
  - name: <node name>
    type: <node type>

token

The token parameter is a Dynatrace token that has “logs.ingest”, “metrics.ingest” and “openTelemetryTrace.ingest” scopes (based on usage).

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com

environment_type

This parameter specifies the environment type that the destination uses. This information is used for validating and crafting outgoing requests. You can specify grail, classic, or other.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com

endpoint_type

This parameter specifies the endpoint type that the destination uses. This information is used for validating and crafting outgoing requests. You can specify cloud, active_gate, or manual.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com

Optional Parameters

environment_id

This parameter specifies the environment ID for SaaS and Active Gate offerings.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: cloud
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    environment_id: some-id

active_gate_domain

This parameter specifies the domain where the Dynatrace ActiveGate proxy is accessible.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com

active_gate_port

This parameter specifies the Port where Dynatrace ActiveGate proxy is accessible.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com

endpoint

This parameter specifies the Dynatrace endpoint that will be used as a baseline for ingestion.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com

buffer_max_bytesize

The buffer_max_bytesize parameter configures the maximum byte size for total unsuccessful items. If the limit is reached, the remaining items are discarded until the buffer space becomes available. It is specified as a datasize.Size, has a default of 0 indicating no size limit, and it is optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    buffer_max_bytesize: 2048

buffer_path

The buffer_path parameter configures the path to store unsuccessful items. Unsuccessful items are stored there to be retried back (exactly once delivery). It is specified as a string and it is optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    buffer_path: <path to unsuccessful items folder>

buffer_ttl

The buffer_ttl parameter configures the time-to-Live for unsuccessful items, which indicates when to discard them. It is specified as a duration, has a default of 10m, and it is optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    buffer_ttl: 20m

tls

The tls parameter is a dictionary type that enables several options for configuring TLS connections. It is optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    tls:
      <tls options>

ignore_certificate_check The ignore_certificate_check parameter disables the validation of certificates for remote endpoints. It is a Boolean, defaults to false, and is optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    tls:
      ignore_certificate_check: true

ca_file The ca_file parameter specifies the CA certificate file for verifying server certificates. It is a string and optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    tls:
      ca_file: /certs/ca.pem

ca_path The ca_path parameter specifies the directory containing CA certificate files. It is a string and optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    tls:
      ca_path: /certs

crt_file The crt_file parameter specifies the certificate file for client authentication. It is a string and optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    tls:
      crt_file: /certs/client-cert.pem

key_file The key_file parameter specifies the private key file for client authentication. It is a string and optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    tls:
      key_file: /certs/client-key.pem

key_password The key_password parameter specifies the password for the private key file. It is a string and optional.

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    tls:
      key_password: <password>

client_auth_type The client_auth_type parameter is a child of the tls parameter. It specifies the authentication type to use for the connection. It is specified as a string from a closed list and is optional.

The following authentication methods are available:

noclientcert indicates that no client certificate should be requested during the handshake, and if any certificates are sent they will not be verified.
requestclientcert indicates that a client certificate should be requested during the handshake, but does not require that the client send any certificates.
requireanyclientcert indicates that a client certificate should be requested during the handshake, and that at least one certificate is required from the client, but that certificate is not required to be valid.
verifyclientcertifgiven indicates that a client certificate should be requested during the handshake, but does not require that the client sends a certificate. If the client does send a certificate it is required to be valid.
requireandverifyclientcert indicates that a client certificate should be requested during the handshake, and that at least one valid certificate is required to be sent by the client

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    tls:
      client_auth_type: <auth type>

max_version The max_version parameter is a child of the tls parameter. It specifies the maximum version of TLS to accept. It is specified as a string and is optional.

You can select one of the following options:

TLSv1_0
TLSv1_1
TLSv1_2
TLSv1_3

nodes:
  - name: dynatrace
    type: dynatrace_output
    endpoint_type: manual
    environment_type: grail
    token: some-token
    endpoint: https://my-example-environment.live.dynatrace.com
    tls:
      max_version: <TLS version>

min_version The min_version parameter is a child of the tls parameter. It specifies the minimum version of TLS to accept. It is specified as a string and is optional. The default is TLSv1_2.