Prometheus

Prometheus is currently the leading tool for metric collection, it’s easy to integrate and easy to use.

Still, short-term retention is a big struggle faced by Prometheus users.

Coralogix helps you overcome this struggle by providing you a way to automatically ship your metrics into your Coralogix account and store them long-term without making complex changes to your Prometheus architecture.

 

How to Send Prometheus Metrics to Coralogix

Using a YML file –

Under root level add remote.write using the following format:

remote_write:
    url: 'https://metrics-api.coralogix.com/prometheus/api/v1/write?appLabelName=path&subSystemLabelName=path&severityLabelName=severity'. 
    name: '<customer_name>'
    remote_timeout: 120s
    bearer_token: '<valid-private_key>'

Using Prometheus operator –

Prometheus Operator provides Kubernetes native deployment.

You can add remoteWrite in the following format (note the camel case):

remoteWrite:
    url: 'https://metrics-api.coralogix.com/prometheus/api/v1/write?appLabelName=path&subSystemLabelName=path&severityLabelName=severity'
    name: '<customer_name>'
    remoteTimeout: 120s
    bearerToken: '<valid-private_key>'

Guidelines –

  • URL – query params that send metric information to Coralogix. These params contain appLabelName, subSystemLabelName and severityLabelName. The parameters you should provide are the keys you choose to send to Coralogix, they are mapped to metric labels.
  • Name – The name of the time series.
  • Remote timeout – Timeout for requests to the remote write endpoint.
  • Bearer Token – This token identifies you into your Coralogix account.  You can find the key in your Coralogix account settings under ‘send your logs’.
  • Severities values that are valid in Coralogix are Debug, Verbose, Info, Warning, Error, and Critical. The default severity when leaving severityLabelName empty is Info.

Server responses –

  • HTTP 200: The protobuf file is valid and contains Prometheus Metadata.
  • HTTP 201: The protobuf file is valid and processed by Coralogix.
  • HTTP 204: The protobuf file is valid, but the Prometheus.WriteRequest is empty.
  • HTTP 400: The REST API request itself was malformed. Check the query params.
  • HTTP 401: The customer is unauthorized. Verify your private key.

 

Grafana Visibility

Coralogix enables you to integrate and view your metrics from Grafana as well.

prometheus grafana

To connect Grafana to your account you can follow this tutorial: https://coralogix.com/tutorials/grafana-plugin/

 

Coralogix Visibility

To view the metrics in Coralogix:

  1. Navigate to ‘Kibana Discover’
  2. Choose the log-metric index.
  3. A metric sample from Coralogix: