Fetch service metrics with Prometheus for Analytics

Objective

Analytics services allow you to export service metrics using Prometheus.

This guide explains how to setup a Prometheus exporter for your Analytics service so that a Prometheus server can collect metrics.

Requirements

• An Analytics service up and running,
• Access to the OVHcloud API,
• A Prometheus server to collect metrics.

Instructions

Enable the Prometheus exporter for your service

You can enable a Prometheus exporter for your service using this API endpoint:

Replace kafka in the route with your service's engine (for example opensearch or grafana).

The boolean property enablePrometheus should be set to true to activate the Prometheus exporter for your service.

Retrieve the Prometheus exporter access info

Use the following API endpoint to get the data needed to access the Prometheus exporter:

You will also need to reset the credentials in order to obtain the password required for access:

Configure your Prometheus server and start pulling metrics

Use the data from the previous state to configure your Prometheus server and start pulling metrics for your service. Here is an example of such a Prometheus configuration for an OpenSearch service:

scrape_configs:
- job_name: opensearch-metrics
  scrape_interval: 10s
  metrics_path: /metrics
  scheme : https
  basic_auth:
    username: prometheus
    password: "xxx"
  tls_config:
      insecure_skip_verify: true
  static_configs:
    - targets: 
        - opensearch-02d6a757-ovh-dev.database.cloud.ovh.net:9273

Limitations

Analytics offer service metrics via Prometheus for the following engines:

• Kafka
• Kafka Connect
• Kafka MirrorMaker
• OpenSearch

Prometheus endpoints are subject to the same networking limitations the associated service is. Thus, IP restrictions apply, and for services using private networking, the Prometheus exporter endpoint is only reachable from the private network your service is attached to.

We want your feedback!

We would love to help answer questions and appreciate any feedback you may have.

For training or technical assistance implementing our solutions, contact your sales representative or visit our Professional Services page to request a quote and have your project analysed by our experts.

Are you on Discord? Connect to our channel at https://discord.gg/ovhcloud and interact directly with the team that builds our Analytics service!

Join our community of users.