prometheus.exporter.catchpoint
EXPERIMENTAL: This is an experimental component. Experimental components are subject to frequent breaking changes, and may be removed with no equivalent replacement. The
stability.level
flag must be set toexperimental
to use the component.
The prometheus.exporter.catchpoint
component uses the catchpoint_exporter
for collecting statistics from a Catchpoint account.
Usage
prometheus.exporter.catchpoint "<LABEL>" {
port = "<PORT>"
verbose_logging = <VERBOSE_LOGGING>
webhook_path = "<WEBHOOK_PATH>"
}
Arguments
You can use the following arguments with prometheus.exporter.catchpoint
:
Blocks
The prometheus.exporter.catchpoint
component doesn’t support any blocks. You can configure this component with arguments.
Exported fields
The following fields are exported and can be referenced by other components.
For example, the targets
can either be passed to a discovery.relabel
component to rewrite the targets’ label sets or to a prometheus.scrape
component that collects the exposed metrics.
The exported targets use the configured in-memory traffic address specified by the run command.
Component health
prometheus.exporter.catchpoint
is only reported as unhealthy if given an invalid configuration.
In those cases, exported fields retain their last healthy values.
Debug information
prometheus.exporter.catchpoint
doesn’t expose any component-specific debug information.
Debug metrics
prometheus.exporter.catchpoint
doesn’t expose any component-specific debug metrics.
Example
This example uses a prometheus.scrape
component to collect metrics from prometheus.exporter.catchpoint
:
prometheus.exporter.catchpoint "example" {
port = "9090"
verbose_logging = false
webhook_path = "/catchpoint-webhook"
}
// Configure a prometheus.scrape component to collect catchpoint metrics.
prometheus.scrape "demo" {
targets = prometheus.exporter.catchpoint.example.targets
forward_to = [prometheus.remote_write.demo.receiver]
}
prometheus.remote_write "demo" {
endpoint {
url = <PROMETHEUS_REMOTE_WRITE_URL>
basic_auth {
username = <USERNAME>
password = <PASSWORD>
}
}
}
Replace the following:
<PROMETHEUS_REMOTE_WRITE_URL>
: The URL of the Prometheusremote_write
compatible server to send metrics to.<USERNAME>
: The username to use for authentication to theremote_write
API.<PASSWORD>
: The password to use for authentication to theremote_write
API.
Compatible components
prometheus.exporter.catchpoint
has exports that can be consumed by the following components:
- Components that consume Targets
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.