Prometheus Remote Write
An output plugin to submit Prometheus Metrics using the remote write protocol
The prometheus remote write plugin allows you to take metrics from Fluent Bit and submit them to a Prometheus server through the remote write mechanism.
Important Note: The prometheus exporter only works with metric plugins, such as Node Exporter Metrics
Key | Description | Default |
|---|---|---|
host | IP address or hostname of the target HTTP Server | 127.0.0.1 |
http_user | Basic Auth Username | |
http_passwd | Basic Auth Password. Requires HTTP_user to be set | |
AWS_Auth | Enable AWS SigV4 authentication | false |
AWS_Service | For Amazon Managed Service for Prometheus, the service name is aps | aps |
AWS_Region | Region of your Amazon Managed Service for Prometheus workspace | |
AWS_STS_Endpoint | Specify the custom sts endpoint to be used with STS API, used with the AWS_Role_ARN option, used by SigV4 authentication | |
AWS_Role_ARN | AWS IAM Role to assume, used by SigV4 authentication | |
AWS_External_ID | External ID for the AWS IAM Role specified with aws_role_arn, used by SigV4 authentication | |
port | TCP port of the target HTTP Server | 80 |
proxy | Specify an HTTP Proxy. The expected format of this value is http://HOST:PORT. Note that HTTPS is not currently supported. It is recommended not to set this and to configure the HTTP proxy environment variables instead as they support both HTTP and HTTPS. | |
uri | Specify an optional HTTP URI for the target web server, e.g: /something | / |
header | Add a HTTP header key/value pair. Multiple headers can be set. | |
log_response_payload | Log the response payload within the Fluent Bit log | false |
add_label | This allows you to add custom labels to all metrics exposed through the prometheus exporter. You may have multiple of these fields | |
Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0. | 2 |
The Prometheus remote write plugin only works with metrics collected by one of the from metric input plugins. In the following example, host metrics are collected by the node exporter metrics plugin and then delivered by the prometheus remote write output plugin.
# Node Exporter Metrics + Prometheus remote write output plugin
# -------------------------------------------
# The following example collects host metrics on Linux and delivers
# them through the Prometheus remote write plugin to new relic :
#
[SERVICE]
Flush 1
Log_level info
[INPUT]
Name node_exporter_metrics
Tag node_metrics
Scrape_interval 2
[OUTPUT]
Name prometheus_remote_write
Match node_metrics
Host metric-api.newrelic.com
Port 443
Uri /prometheus/v1/write?prometheus_server=YOUR_DATA_SOURCE_NAME
Header Authorization Bearer YOUR_LICENSE_KEY
Log_response_payload True
Tls On
Tls.verify On
# add user-defined labels
add_label app fluent-bit
add_label color blue
# Note : it would be necessary to replace both YOUR_DATA_SOURCE_NAME and YOUR_LICENSE_KEY
# with real values for this example to work.
The following are examples of using Prometheus remote write with hosted services below
With Grafana Cloud hosted metrics you will need to use the specific host that is mentioned as well as specify the HTTP username and password given within the Grafana Cloud page.
[OUTPUT]
name prometheus_remote_write
host prometheus-us-central1.grafana.net
match *
uri /api/prom/push
port 443
tls on
tls.verify on
http_user <GRAFANA Username>
http_passwd <GRAFANA Password>
With Logz.io hosted prometheus you will need to make use of the header option and add the Authorization Bearer with the proper key. The host and port may also differ within your specific hosted instance.
[OUTPUT]
name prometheus_remote_write
host listener.logz.io
port 8053
match *
header Authorization Bearer <LOGZIO Key>
tls on
tls.verify on
log_response_payload true
With Coralogix Metrics you may need to customize the URI. Additionally, you will make use of the header key with Coralogix private key.
[OUTPUT]
name prometheus_remote_write
host metrics-api.coralogix.com
uri prometheus/api/v1/write?appLabelName=path&subSystemLabelName=path&severityLabelName=severity
match *
port 443
tls on
tls.verify on
header Authorization Bearer <CORALOGIX Key>
Last modified 4mo ago