Class ObservabilityPipelineHttpClientSource

The http_client source scrapes logs from HTTP endpoints at regular intervals.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineHttpClientSource

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

Optional authentication strategy for HTTP requests.

customKey?: string

Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).

The decoding format used to interpret incoming logs.

endpointUrlKey?: string

Name of the environment variable or secret that holds the HTTP endpoint URL to scrape.

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

scrapeIntervalSecs?: number

The interval (in seconds) between HTTP scrape requests.

scrapeTimeoutSecs?: number

The timeout (in seconds) for each scrape request.

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 source type. The value should always be http_client.

usernameKey?: string

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

Generated using TypeDoc