Recueillez vos métriques Prometheus et OpenMetrics exposées à partir de votre application exécutée sur vos hosts à l’aide de l’Agent Datadog et de l’intégration Datadog/OpenMetrics ou Datadog/Prometheus.

Présentation

Depuis la version 6.5.0, l’Agent inclut des checks OpenMetrics et Prometheus capables de scraper les endpoints Prometheus. Nous vous conseillons d’utiliser le check OpenMetrics du fait de son efficacité accrue et de sa prise en charge complète du format texte Prometheus. Pour en savoir plus sur l’utilisation avancée de l’interface OpenMetricsCheck et le développement d’un check custom, consultez la section Outils de développement. N’utilisez le check Prometheus que lorsque l’endpoint de métriques ne prend pas en charge un format texte.

Cette page décrit les principes d’utilisation de base de ces checks. Ils vous permettent d’importer toutes vos métriques Prometheus exposées dans Datadog.

Configuration

Installation

Installez l’Agent Datadog sur votre système d’exploitation. Les checks Prometheus et OpenMetrics sont inclus dans le paquet de l’Agent Datadog : vous n’avez donc rien d’autre à installer sur vos conteneurs ou vos hosts.

Configuration

Pour recueillir vos métriques exposées :

1. Modifiez le fichier openmetrics.d/conf.yaml dans le dossierconf.d/ à la racine du répertoire de configuration de votre Agent. Consultez le fichier d’exemple openmetrics.d/conf.yaml pour découvrir toutes les options de configuration disponibles. Voici la configuration minimale requise pour activer l’intégration :

   init_config:
   
   instances:
       - prometheus_url: 'localhost:<PORT>/<ENDPOINT>'
         namespace: '<NAMESPACE>'
         metrics:
             - '<METRIC_TO_FETCH>': '<DATADOG_METRIC_NAME>'
   

   Les placeholders à configurer sont les suivants :

   Placeholder	Description
   <PORT>	Le port auquel se connecter afin d’accéder à l’endpoint Prometheus.
   <ENDPOINT>	L’URL pour les métriques fournies par le conteneur, au format Prometheus.
   <NAMESPACE>	L’espace de nommage spécifié ici sera ajouté comme préfixe à chaque métrique lors de son affichage dans Datadog.
   <METRIC_TO_FETCH>	La clé de métrique Prometheus à récupérer à partir de l’endpoint Prometheus.
   <DATADOG_METRIC_NAME>	Lorsque ce paramètre facultatif est défini, la clé de métrique <METRIC_TO_FETCH> est remplacée par <DATADOG_METRIC_NAME> dans Datadog. Si vous choisissez de ne pas utiliser cette option, passez une liste de chaînes plutôt que des paires key:value.

2. Redémarrez l’Agent pour commencer à recueillir vos métriques.

Paramètres disponibles

Voici la liste complète des paramètres disponibles pour vos instances :

Remarque : à l’exception de send_distribution_buckets et de send_distribution_counts_as_monotonic, tous les paramètres sont pris en charge aussi bien par le check OpenMetrics que par le check Prometheus.

Prise en main

Collecte de métriques simple

Pour commencer à recueillir des métriques exposées par Prometheus, suivez les étapes ci-dessous :

1. Référez-vous à la section Getting Started de la documentation Prometheus (en anglais) pour exécuter une version locale de Prometheus capable de se surveiller elle-même.

2. Installez l’Agent Datadog pour votre plateforme.

3. Modifiez le fichier openmetrics.d/conf.yaml dans le dossier conf.d/ à la racine du répertoire de configuration de votre Agent en ajoutant le contenu suivant :

   init_config:
   
   instances:
       - prometheus_url: http://localhost:9090/metrics
         namespace: 'documentation_example'
         metrics:
             - promhttp_metric_handler_requests_total: prometheus.handler.requests.total
   

4. Redémarrez l’Agent.

5. Accédez à votre page Metric summary pour visualiser les métriques recueillies : prometheus_target_interval_length_seconds*.

Proposer une intégration personnalisée comme intégration officielle

Par défaut, toutes les métriques récupérées par le check Prometheus générique sont considérées comme des métriques custom. Si vous surveillez un logiciel prêt à l’emploi et que vous pensez qu’il mérite une intégration officielle, n’hésitez pas à apporter votre contribution !

Les intégrations officielles utilisent des répertoires dédiés. Le check générique intègre un système de création d’instances qui se charge de coder en dur la configuration par défaut et les métadonnées des métriques. Reportez-vous au référentiel sur l’intégration kube-proxy pour obtenir un exemple.

Further Reading

Documentation, liens et articles supplémentaires utiles:

Recueillir vos logsDOCUMENTATION Recueillir vos processusDOCUMENTATION Recueillir vos tracesDOCUMENTATION Écrire votre propre check Prometheus customDOCUMENTATION