Collecteurs de données télémétriques

L’orchestrateur émet des données télémétriques en utilisant OpenTelemetry (OTLP). Pour configurer votre orchestrateur afin qu’il émette des données télémétriques, commencez par consulter la rubrique Configuration de la télémétrie.

Ce document contient des exemples de configuration de certains collecteurs OTLP permettant de recevoir la télémétrie de l’orchestrateur.

L’orchestrateur émet des données télémétriques au format OTLP.

Plusieurs fournisseurs proposent des collecteurs OTLP natifs que vous pouvez utiliser pour consulter la télémétrie de l’orchestrateur.

Les utilisateurs peuvent déployer un collecteur OpenTelemetry coimplanté pour collecter, regrouper et traiter la télémétrie provenant de l’orchestrateur.

Veuillez consulter la section local dashboard pour découvrir un exemple d’exécution locale d’une pile d’observabilité afin de consulter la télémétrie provenant d’un orchestrateur.

New Relic

New Relic est une plateforme d’observabilité hébergée sur le cloud.

Ce guide présente les étapes élémentaires de connexion de l’orchestrateur à New Relic. Consultez également le guide New Relic OpenTelemetry pour plus de détails.

Configuration du compte

Pour configurer New Relic afin de collecter la télémétrie de l’orchestrateur, vous devrez d’abord créer un compte en ligne.

Clé API

Pour connecter l’orchestrateur à votre compte New Relic, commencez par créer une clé API. L’orchestrateur envoie cette clé API sous forme d’en-tête dans les données transmises à New Relic. New Relic vérifie la clé API avec votre compte, puis autorise les métriques de l’orchestrateur à entrer dans votre magasin de données en ligne.

Certificats TLS

New Relic exige le protocole TLS pour la sécurité HTTP. Vous pouvez réutiliser la paire certificat/clé définie pour le serveur http (normalement nommée maverics), ou configurer des certificats TLS spécifiquement pour le service de télémétrie. Reportez-vous à la section Sécurité du transport (TLS, Transport Layer Security) pour obtenir des instructions sur la mise en place des certificats et des clés.

Configuration de l’orchestrateur

Une fois que vous disposez d’un compte New Relic, de votre clé API et des certificats TLS, vous pouvez configurer l’orchestrateur pour qu’il produise des métriques vers votre compte New Relic.

Modifiez votre fichier de configuration de l’orchestrateur maverics.yaml pour y inclure une section similaire à la suivante :

telemetry:
  metrics:
    enabled: true
    interval: 5m
    exporter: otlp
  exporters:
    otlp:
      protocols:
        http:
          tls: telemetryTLS # defined in the tls section
          endpoint: otlp.nr-data.net:4318
          headers:
            api-key: <NewRelicAPIKey>

DataDog

DataDog est « la plateforme incontournable de surveillance et de sécurité pour les applications hébergées sur le cloud ».

Ce guide présente les étapes élémentaires permettant d’émettre des métriques d’orchestrateur vers DataDog.

DataDog propose également de la documentation en ligne sur OpenTelemetry. Pour plus d’informations techniques sur OpenTelemetry et l’agent DataDog, reportez-vous à leur documentation.

Configuration du compte

Pour connecter l’orchestrateur à DataDog, vous devez d’abord disposer d’un compte DataDog. Vous pouvez créer un compte gratuitement sur le site web de DataDog en cliquant sur le bouton « Get Started ».

Clé API

Pour émettre des métriques de l’orchestrateur vers votre compte DataDog, l’orchestrateur doit connaître votre clé d’application (API) DataDog. Pour créer une nouvelle clé d’application, connectez-vous d’abord à DataDog, puis accédez aux clés d’application de votre organisation. Utilisez un nom explicite pour votre clé, tel que « Maverics Orchestrater OTLP Machine », afin de vous souvenir de sa fonction.

Agent DataDog

Installez l’agent DataDog

Pour collecter des données à partir de l’orchestrateur, DataDog exige que vous exécutiez son agent. Il est obligatoire d’installer l’agent DataDog de votre système d’exploitation sur le système où l’orchestrateur est installé. Les instructions d’installation de l’agent DataDog sont disponibles dans leur documentation.

Au bas de la page d’installation correspondant à votre système d’exploitation, vous trouverez un lien vers des instructions « étape par étape ». Cliquez sur ce lien et trouvez l’emplacement du fichier datadog.yaml sur votre système ; il vous faudra mettre à jour ce fichier dans la section suivante.

Configuration de l’agent DataDog

Pour permettre à l’agent DataDog de collecter les métriques OTLP, il est nécessaire de modifier le fichier de configuration de l’agent datadog.yaml et de redémarrer l’agent (voir la section ci-dessus pour trouver le fichier datadog.yaml dans votre système).

Dans datadog.yaml, accédez à la section intitulée OpenTelemetry Configuration section et mettez-la à jour en y incluant les lignes suivantes :

otlp_config:
  receiver:
    protocols:
      http:
        endpoint: 0.0.0.0:4318

Dans le fichier datadog.yaml original, nous vous recommandons d’ajouter simplement les lignes yaml ci-dessus, et de conserver la section otlp_config en commentaire, pour toute référence future.

Pour plus d’informations sur l’OTLP de DataDog, reportez-vous à leur documentation. Vous pouvez également consulter les instructions d’installation de DataDog ci-dessus pour obtenir plus d’informations sur l’agent DataDog.

Redémarrez l’agent DataDog

Une fois le fichier datadog.yaml mis à jour pour activer les métriques OTLP, il vous faudra redémarrer l’agent DataDog. Suivez les instructions pour redémarrer votre agent dans la section Installation de l’agent ci-dessus.

Par exemple, sur un système Fedora, exécutez sudo systemctl restart datadog-agent

Configuration de l’orchestrateur

Maintenant que l’agent DataDog est installé et opérationnel, configurez votre orchestrateur pour qu’il émette des métriques vers l’agent, en utilisant le terminal que vous avez configuré ci-dessus.

Modifiez votre fichier de configuration de l’orchestrateur maverics.yaml pour y inclure une section similaire à la suivante :

telemetry:
  metrics:
    enabled: true
    interval: 5m
    exporter: otlp
  exporters:
    otlp:
      protocols:
        http:
          endpoint: 0.0.0.0:4318

Redémarrez l’orchestrateur pour lire votre nouvelle configuration de télémétrie, puis accédez à votre compte DataDog pour consulter les métriques de l’orchestrateur.

Lecture des métriques de l’orchestrateur dans DataDog

Il vous faudra configurer un tableau de bord ou un autre programme moniteur pour lire les métriques de l’orchestrateur. Pour plus d’informations, reportez-vous à la documentation concernant le tableau de bord.

Pour vous assurer que DataDog réceptionne les métriques de l’orchestrateur, accédez à l’explorateur de métriques et recherchez les métriques du service io.strata.maverics.

Tableau de bord local

Cette configuration est utile pour les tests locaux de base et peut être utilisée comme point de départ pour configurer votre propre pile OTLP.

Vous pouvez consulter les métriques de l’orchestrateur localement en utilisant Docker Compose et une configuration de base pour Prometheus, Grafana et le collecteur OpenTelemetry fourni dans un dossier téléchargeable.

1. Téléchargez et extrayez le dossier grafana_dashboard.zip.
2. Dans l’annuaire, exécutez docker compose up.
3. Démarrez l’orchestrateur avec la télémétrie configurée. Un exemple de fichier de configuration de l’orchestrateur est inclus dans le dossier. Le collecteur OpenTelemetry utilisera l’adresse http://localhost:4318.
4. Après le démarrage réussi de tous les conteneurs, naviguez vers le tableau de bord du système Maverics dans Grafana.