pyroscope.write
pyroscope.write
receives performance profiles from other components and forwards them to a series of user-supplied endpoints using Pyroscope’ Push API.
Multiple pyroscope.write
components can be specified by giving them different labels.
Usage
pyroscope.write "LABEL" {
endpoint {
url = PYROSCOPE_URL
...
}
...
}
Arguments
The following arguments are supported:
Blocks
The following blocks are supported inside the definition of pyroscope.write
:
The >
symbol indicates deeper levels of nesting.
For example, endpoint > basic_auth
refers to a basic_auth
block defined inside an endpoint
block.
endpoint block
The endpoint
block describes a single location to send profiles to.
Multiple endpoint
blocks can be provided to send profiles to multiple locations.
The following arguments are supported:
At most, one of the following can be provided:
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.
When multiple endpoint
blocks are provided, profiles are concurrently forwarded to all configured locations.
basic_auth block
password
and password_file
are mutually exclusive, and only one can be provided inside a basic_auth
block.
authorization block
credential
and credentials_file
are mutually exclusive, and only one can be provided inside an authorization
block.
oauth2 block
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 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 fields are exported and can be referenced by other components:
Component health
pyroscope.write
is only reported as unhealthy if given an invalid configuration.
In those cases, exported fields are kept at their last healthy values.
Debug information
pyroscope.write
does not expose any component-specific debug information.
Example
Compatible components
pyroscope.write
has exports that can be consumed by the following components:
- Components that consume Pyroscope
ProfilesReceiver
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.