Prometheus Remote Write

Apica Ascent can collect Prometheus metrics from externally hosted Prometheus. Apica Ascent uses the remote_write capabilities to help you do so.

Prometheus configuration

To send metrics from Prometheus to Apica Ascent endpoint, use the configuration below.

You may also want to add a relabel configuration section to make sure the metrics from your prometheus instance are prefixed for easier identification See Section below.

remote_write:
  - url: https://<apica-ascent-endpoint>/api/v1/receive
    tls_config:
        insecure_skip_verify: true
        # Optional - ca_file: <file-name>
        # Optional - cert_file: <file-name>
        # Optional - key_file: <file-name>

Prometheus Remote Write in Helm Chart

Prometheus helm

Helm Chart for Prometheus document is found here:

helm-charts/charts/prometheus at main · prometheus-community/helm-chartsGitHub

The configuration for remote write in the Helm values.yaml file differs slightly from that in the prometheus.yml file. Note that in the values.yaml file, the configuration file under the server section uses the remoteWrite keyword instead of remote_write, which is used in the prometheus.yml file. This distinction in syntax is important to ensure that the remote write functionality is correctly configured in your deployment.

server:
  remoteWrite:
  - url: https://<apica-ascent-endpoint>/api/v1/receive
    tls_config:
        insecure_skip_verify: true
        # Optional - ca_file: <file-name>
        # Optional - cert_file: <file-name>
        # Optional - key_file: <file-name>

Adding relabel configuration to prefix your metrics

To ensure that your metrics are easily identifiable, replace <prefix> in the replacement attribute within the write_relabel_configs section with a descriptive prefix of your choice. This prefix will be appended to the beginning of all metrics sent to the output stream, allowing you to easily differentiate them from other metrics in your system.

  remote_write:
  - url: https://<apica-ascent-endpoint>/api/v1/receive
    tls_config:
        insecure_skip_verify: true

    write_relabel_configs:
    - action: replace
      source_labels: [__name__]
      regex: (.*)
      target_label: __name__
      replacement: '<prefix>_$1'

OpenTelemetry configuration

The Prometheus Remote Write Exporter can be used to send OpenTelemetry metrics to Prometheus remote write compatible backends. By leveraging this capability, you can easily visualize these metrics on the Apica Ascent platform, allowing you to gain valuable insights into the performance of your system.

exporters:
  prometheusremotewrite:
    endpoint: "https://<apica-ascent-endpoint>/api/v1/receive"
    wal: # Enabling the Write-Ahead-Log for the exporter.
      directory: ./prom_rw # The directory to store the WAL in
      buffer_size: 100 # Optional count of elements to be read from the WAL before truncating; default of 300
      truncate_frequency: 45s # Optional frequency for how often the WAL should be truncated. It is a time.ParseDuration; default of 1m
    tls: 
      ca_file: <file-name>
      cert_file: <file-name>
      key_file: <file-name>

    external_labels: #labels to identify the metric
         label1: value1

receivers:
  otlp:
    protocols:
      grpc:
      http:

processors:
  batch:

service:
  pipelines:
    metrics:
         receivers: [otlp]
         processors: [batch]
         exporters: [prometheusremotewrite]

VictoriaMetrics configuration

VictoriaMetrics is a fast, cost-effective, and scalable monitoring solution and time-series database. vmagent is an agent which helps you collect metrics from various sources and store them in VictoriaMetrics or any other Prometheus-compatible storage systems that support the remote_write protocol. VMagent has the ability to push metrics additionally to pulling them; push model is a traditional model of the client sending data to the server:

Run the vmagent as shown below and pass the below parameters

remoteWrite.tls.url=https://<apica-ascent-endpoint>/api/v1/receive

remoteWrite.tlsInsecureSkipVerify

./vmagent-prod -promscrape.config=/etc/prometheus/prometheus.yml -remoteWrite.url=https://<apica-ascent-endpoint>/api/v1/receive -remoteWrite.tlsInsecureSkipVerify