Prometheus Remote Write

Prometheus Remote Write destination plugin

Prometheus Remote Write is a feature of Prometheus, an open-source monitoring system, that allows you to send metrics data from Prometheus to another system or storage backend. It enables you to export data from Prometheus to a remote system, such as an object storage service or a database, for long-term storage and analysis.

Prometheus Remote Write works by sending metrics data in a standardized format over HTTP to the configured remote endpoint. This allows you to use different storage backends and analysis tools with Prometheus, and to centralize your monitoring data in a single location. It allows you to export data from Calyptia Core to a variety of storage and analysis systems for long-term storage and analysis.

Configuration parameters

The Prometheus Remote Write destination plugin provides these configuration parameters.

General

KeyDescription
HostIP address or hostname of the target HTTP Server.
PortTCP port of the target HTTP Server.
URISpecify an optional HTTP URI for the target web server.

Advanced

KeyDescription
HeadersAdd a HTTP header key/value pair. Multiple headers can be set.
Additional Prometheus Metric LabelsThis allows you to add custom labels to all metrics exposed through the Prometheus exporter. You may have multiple of these fields.
HTTP ProxySpecify an HTTP Proxy. The expected format of this value is http://host:port.
Log Response PayloadLog the response payload within the Core Pipeline log.

Security and TLS

KeyDescription
TLSEnable or disable TLS/SSL support.
TLS Certificate ValidationTurn TLS/SSL certificate validation on or off. TLS must be on for this setting to be enabled.
TLS Debug LevelSet TLS debug verbosity level. Accepts these values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), 4 (Verbose).
CA Certificate File PathAbsolute path to CA certificate file.
Certificate File PathAbsolute path to certificate file.
Private key File PathAbsolute path to private key file.
Private Key Path PasswordOptional password for tls.key_file file.
TLS SNI Hostname ExtensionHostname to be used for TLS SNI extension.

Advanced networking

KeyDescription
DNS ModeSelect the primary DNS connection type (TCP or UDP).
DNS ResolverSelect the primary DNS connection type (TCP or UDP).
Prefer IPv4Prioritize IPv4 DNS results when trying to establish a connection.
KeepaliveEnable or disable Keepalive support.
Keepalive Idle TimeoutSet maximum time allowed for an idle Keepalive connection.
Max Connect TimeoutSet maximum time allowed to establish a connection, this time includes the TLS handshake.
Max Connect Timeout Log ErrorOn connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
Max Keepalive RecycleSet maximum number of times a keepalive connection can be used before it is retired.
Source AddressSpecify network address to bind for data traffic.

Basic authentication

KeyDescription
HTTP UsernameOptional username for Basic Authentication on HEC.
HTTP PasswordPassword for user defined in HTTP_User.