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).
Configuration parameters
The Prometheus Remote Write source plugin provides these configuration parameters. Items in the Name column display in the Calyptia Dashboard. 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 OTEL data. | 8088 |
Advanced
| Name | Key | Description | Default |
|---|---|---|---|
| Tag from URI | tag_from_uri | Set tag from URI. For example, v1_metrics from /v1/metrics. | false |
| URI | uri | Set 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 | Specify the maximum buffer size in KB to receive a JSON message. | 4M |
Security and TLS
| Name | Key | Description | Default |
|---|---|---|---|
| TLS | tls | Enable or disable TLS/SSL support. | none |
| TLS Certificate Validation | tls.verify | Turn TLS/SSL certificate validation on or off. TLS must be on for this setting to be enabled. | on |
| TLS Debug Level | tls.debug | Set 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 | Optional password for tls.key_file file. | none |
| TLS SNI Hostname Extension | tls.vhost | Hostname to be used for TLS SNI extension. | none |