Class ObservabilityPipelinePrometheusRemoteWriteDestination

The prometheus_remote_write destination forwards metrics to an endpoint that supports the Prometheus Remote Write protocol.

Supported pipeline types: metrics

Hierarchy

  • ObservabilityPipelinePrometheusRemoteWriteDestination

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

The authentication strategy to use for outgoing Prometheus Remote Write requests.

Configuration for buffer settings on destination components.

defaultNamespace?: string

The default namespace to add as a prefix to metric names that do not already have one.

endpointUrlKey?: string

Name of the environment variable or secret that holds the Prometheus Remote Write endpoint URL. Defaults to DESTINATION_PROMETHEUS_REMOTE_WRITE_ENDPOINT_URL (prefixed with DD_OP_ at runtime).

id: string

The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the input to downstream components).

inputs: string[]

A list of component IDs whose output is used as the input for this component.

passwordKey?: string

Name of the environment variable or secret that holds the password (used when auth_strategy is basic).

tenantId?: string

The tenant ID to include with outgoing requests. Used by multi-tenant Prometheus Remote Write receivers.

Configuration for enabling TLS encryption between the pipeline component and external services.

tokenKey?: string

Name of the environment variable or secret that holds the bearer token (used when auth_strategy is bearer).

The destination type. The value should always be prometheus_remote_write.

usernameKey?: string

Name of the environment variable or secret that holds the username (used when auth_strategy is basic).

Generated using TypeDoc