Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana Agent Grafana Agent Flow Reference Components remote.http

remote.http

remote.http exposes the response body of a URL to other components. The URL is polled for changes so that the most recent content is always available.

The most common use of remote.http is to load discovery targets from an HTTP server.

Multiple remote.http components can be specified by giving them different labels.

Usage

river Copy

remote.http "LABEL" {
  url = "URL_TO_POLL"
}

Arguments

The following arguments are supported:

When remote.http performs a poll operation, an HTTP GET request is made against the URL specified by the url argument. A poll is triggered by the following:

• When the component first loads.
• Every time the component’s arguments get re-evaluated.
• At the frequency specified by the poll_frequency argument.

The poll is successful if the URL returns a 200 OK response code. All other response codes are treated as errors and mark the component as unhealthy. After a successful poll, the response body from the URL is exported.

Blocks

The following blocks are supported inside the definition of remote.http:

The > symbol indicates deeper levels of nesting. For example, client > basic_auth refers to an basic_auth block defined inside a client block.

client block

The client block configures settings used to connect to the HTTP server.

bearer_token, bearer_token_file, basic_auth, authorization, and oauth2 are mutually exclusive and only one can be provided inside of a http_client_config block.

basic_auth block

The basic_auth block configures basic authentication to use when polling the configured URL.

password and password_file are mututally exclusive and only one can be provided inside of a basic_auth block.

authorization block

The authorization block configures custom authorization to use when polling the configured URL.

credential and credentials_file are mutually exclusive and only one can be provided inside of an authorization block.

oauth2 block

The oauth2 block configures OAuth2 authorization to use when polling the configured URL.

client_secret and client_secret_file are mututally exclusive and only one can be provided inside of an oauth2 block.

The oauth2 block may also contain its own separate tls_config sub-block.

tls_config block

The tls_config block configures TLS settings for connecting to HTTPS servers.

When min_version is not provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2. If min_version is provided, it must be set to one of the following strings:

• "TLS10" (TLS 1.0)
• "TLS11" (TLS 1.1)
• "TLS12" (TLS 1.2)
• "TLS13" (TLS 1.3)

Exported fields

The following field is exported and can be referenced by other components:

If the is_secret argument was true, content is a secret type.

Component health

Instances of remote.http report as healthy if the most recent HTTP GET request of the specified URL succeeds.

Debug information

remote.http does not expose any component-specific debug information.

Debug metrics

remote.http does not expose any component-specific debug metrics.

Example

This example reads a JSON array of objects from an endpoint and uses them as a set of scrape targets:

river Copy

remote.http "targets" {
  url = env("MY_TARGETS_URL")
}

prometheus.scrape "default" {
  targets    = json_decode(remote.http.targets.content)
  forward_to = [prometheus.remote_write.default.receiver]
}

prometheus.remote_write "default" {
  client {
    url = env("PROMETHEUS_URL")
  }
}