Prometheus Remote Write source plugin
The Prometheus Remote Write source plugin lets users retrieve data from the Prometheus Remote-Write API (opens in a new tab).
Supported telemetry types
This plugin supports these telemetry types:
| Logs | Metrics | Traces |
|---|---|---|
Configuration parameters
Use the parameters in this section to configure your plugin. The Telemetry Pipeline web interface uses the values in the Name column to describe the parameters. Items in the Key column are the YAML keys to use in pipeline configuration files.
Required
| Name | Key | Description | Default |
|---|---|---|---|
| Port | port | Required. The port for the pipeline to receive data. | 8088 |
Advanced
| Name | Key | Description | Default |
|---|---|---|---|
| Tag from URI | tag_from_uri | Sets tag from URI. For example, v1_metrics from /v1/metrics. | false |
| URI | uri | Sets the URI to receive Prometheus Remote Write metrics on. | /api/prom/push |
| Chunk Size | buffer_chunk_size | Required. Sets the chunk size for incoming JSON messages. Chunks are stored and managed in the space available by buffer_max_size. | 512K |
| Buffer Max Size | buffer_max_size | Specifies the maximum buffer size in KB to receive a JSON message. | 4M |
Security and TLS
| Name | Key | Description | Default |
|---|---|---|---|
| TLS | tls | Enables or disables TLS/SSL support. Accepted values: true, false. | false |
| TLS Certificate Validation | tls.verify | Enables or disables TLS/SSL certificate validation. TLS must be enabled for certificates to be validated. Accepted values: off, on. | on |
| TLS Debug Level | tls.debug | Sets TLS debug verbosity level. Accepted values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), 4 (Verbose). | 1 |
| CA Certificate File Path | tls.ca_file | Absolute path to CA certificate file. | none |
| Certificate File Path | tls.crt_file | Absolute path to certificate file. | none |
| Private Key File Path | tls.key_file | Absolute path to private key file. | none |
| Private Key Path Password | tls.key_passwd | Password for private key file. | none |
| TLS SNI Hostname Extension | tls.vhost | Hostname to be used for TLS SNI extension. | none |