Class ObservabilityPipelinePrometheusRemoteWriteSource

The prometheus_remote_write source ingests metrics pushed over the Prometheus Remote Write protocol.

Supported pipeline types: metrics

Hierarchy

  • ObservabilityPipelinePrometheusRemoteWriteSource

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
addressKey?: string

Name of the environment variable or secret that holds the listen address for the Prometheus Remote Write endpoint.

HTTP authentication method.

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).

passwordKey?: string

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

path: string

The HTTP path on which the source listens for incoming Prometheus Remote Write requests.

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

The source 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 plain).

A list of tokens that are accepted for authenticating incoming requests. When set, the source rejects any request whose token does not match an enabled entry in this list.

Generated using TypeDoc