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
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.
no_proxy
can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers.
proxy_url
must be configured if no_proxy
is configured.
proxy_from_environment
uses the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof).
Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY.
proxy_url
and no_proxy
must not be configured if proxy_from_environment
is configured.
proxy_connect_header
should only be configured if proxy_url
or proxy_from_environment
are configured.
basic_auth block
The basic_auth
block configures basic authentication to use when polling the configured URL.
password
and password_file
are mutually exclusive, and only one can be provided inside 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 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 mutually exclusive, and only one can be provided inside an oauth2
block.
The oauth2
block may also contain a separate tls_config
sub-block.
no_proxy
can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers.
proxy_url
must be configured if no_proxy
is configured.
proxy_from_environment
uses the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof).
Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY.
proxy_url
and no_proxy
must not be configured if proxy_from_environment
is configured.
proxy_connect_header
should only be configured if proxy_url
or proxy_from_environment
are configured.
tls_config block
The tls_config
block configures TLS settings for connecting to HTTPS servers.
The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:
ca_pem
andca_file
cert_pem
andcert_file
key_pem
andkey_file
When configuring client authentication, both the client certificate (using cert_pem
or cert_file
) and the client key (using key_pem
or key_file
) must be provided.
When min_version
isn’t 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
doesn’t expose any component-specific debug information.
Debug metrics
remote.http
doesn’t 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:
remote.http "targets" {
url = sys.env("MY_TARGETS_URL")
}
prometheus.scrape "default" {
targets = encoding.from_json(remote.http.targets.content)
forward_to = [prometheus.remote_write.default.receiver]
}
prometheus.remote_write "default" {
client {
url = sys.env("PROMETHEUS_URL")
}
}