Prometheus Remote Write

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.

Metadata

NameKeyDescriptionDefault
NameNamePlugin instance name for identification purposes.none

Required

NameKeyDescriptionDefault
PortportRequired. The port for the pipeline to receive OTEL data.8088

Advanced

NameKeyDescriptionDefault
Tag from URItag_from_uriSet tag from URI. For example, v1_metrics from /v1/metrics.false
URIuriSet the URI to receive Prometheus Remote Write metrics on./api/prom/push
Chunk Sizebuffer_chunk_sizeRequired. Sets the chunk size for incoming JSON messages. Chunks are stored and managed in the space available by buffer_max_size.512K
Buffer Max Sizebuffer_max_sizeSpecify the maximum buffer size in KB to receive a JSON message.4M

Security and TLS

NameKeyDescriptionDefault
TLStlsEnable or disable TLS/SSL support.none
TLS Certificate Validationtls.verifyTurn TLS/SSL certificate validation on or off. TLS must be on for this setting to be enabled.on
TLS Debug Leveltls.debugSet TLS debug verbosity level. Accepted values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), 4 (Verbose).1
CA Certificate File Pathtls.ca_fileAbsolute path to CA certificate file.none
Certificate File Pathtls.crt_fileAbsolute path to certificate file.none
Private Key File Pathtls.key_fileAbsolute path to private key file.none
Private Key Path Passwordtls.key_passwdOptional password for tls.key_file file.none
TLS SNI Hostname Extensiontls.vhostHostname to be used for TLS SNI extension.none