Télémétrie

Explorer

Capacité d’observation de Maverics État de santé de l’orchestrateur Collecteurs de données télémétriques

Documentation

L’orchestrateur recueille et émet des informations relatives à l’état (télémétrie) à l’aide d’un projet open-source connu sous le nom d’OpenTelementry (OTLP). Pour en savoir plus sur l’OTLP en ligne.

Pour collecter et examiner la télémétrie de l’orchestrateur, nous recommandons d’utiliser le collecteur OTLP fourni par un fournisseur (DataDog, NewRelic, etc.).

Après avoir configuré l’orchestrateur pour qu’il émette des métriques (ci-dessous), vous pouvez configurer un collecteur de télémétrie en vous appuyant sur notre documentation.

Activation de la télémétrie

Chaque partie de la configuration de télémétrie de l’orchestrateur est détaillée ci-dessous. Un exemple complet est disponible à la fin du présent document.

`telemetry`

La clé telemetry est le point de départ de la configuration de la télémétrie. S’il elle est omise, l’orchestrateur n’émet pas de métriques.

`metrics`

La clé metrics doit figurer en dessous de la clé telemetry. Elle contient toute la configuration des métriques de télémétrie, décrite ci-dessous sous forme de clés.

`enabled`

Pour émettre des métriques, ajoutez la clé enabled: true sous metrics. Pour désactiver l’émission des métriques, changez simplement la valeur de la clé enabled en false.

`interval`

Il est possible de configurer l’intervalle des rapports de métriques, en ajoutant une clé interval suivie d’une durée : interval: 15m L’intervalle par défaut est de 5 minutes.

`exporter`

La clé exporter requise fait référence à un nom d’exportateur figurant dans la section exporters ci-dessous. Les métriques de l’orchestrateur seront émises vers la valeur exporter spécifiée. Le nom spécifié ici doit correspondre à celui défini dans la configuration exporters ci-dessous. Voir l’exemple à la fin du présent document.

`health`

La clé health doit figurer en dessous de telemetry.

`enabled`

Pour émettre des métriques « health », ajoutez la clé enabled: true en dessous de health. Pour désactiver l’émission des métriques « health », changez simplement la valeur de la clé enabled en false.

`exporter`

La clé exporter requise fait référence à un nom d’exportateur figurant dans la section exporters ci-dessous. Les métriques « health » de l’orchestrateur seront émises vers la valeur exporter spécifiée. Le nom spécifié ici doit correspondre à celui défini dans la configuration exporters ci-dessous. Voir l’exemple à la fin du présent document.

`exporters`

Cette clé obligatoire décrit l’endroit et la manière d’exporter les métriques de l’orchestrateur. Pour plus d’informations sur les collecteurs vers lesquels vous pouvez exporter des données télémétriques, veuillez vous reporter à la section Collecteurs.

L’orchestrateur n’émet actuellement que vers OTLP ; la section suivante est obligatoire sous exporters :

    otlp:
      protocols:

ℹ️

Les noms des exportateurs doivent tous commencer par otlp et être uniques, par exemple otlp-1 et otlp-2, ou otlp-newrelic et otlp-datadog. Voir l’exemple à la fin du présent document.

`http`

L’orchestrateur exporte la télémétrie OTLP à l’aide d’un exportateur HTTP (uniquement). Sous http, ajoutez la clé endpoint et indiquez l’endroit où l’orchestrateur doit émettre les métriques :

        http:
          endpoint: localhost:4318

ℹ️

Pour des exemples de configuration du collecteur OTLP, vous pouvez également vous référer à nos exemples.

`urlPath`

Par défaut, les collecteurs OTLP utilisent le chemin URL /v1/metrics pour accéder aux métriques. Cependant, les collecteurs OTLP peuvent également être configurés pour utiliser différents chemins d’accès aux URL. En cas d’utilisation d’un collecteur OTLP utilisant un chemin URL différent ou personnalisé, la configuration de l’exportateur doit être mise à jour avec le chemin URL attendu par le collecteur.

Pour spécifier un chemin d’accès à l’URL d’un exportateur, utilisez la clé urlPath dans la section http :

        http:
          endpoint: localhost:4318
          urlPath: /customPath

ℹ️

Il s’agit d’un paramètre facultatif, qui ne doit être spécifié que si le collecteur OTLP est configuré pour atteindre un chemin d’accès à l’URL différent de celui utilisé par défaut.

`headers`

Il est possible d’ajouter des en-têtes http qui sont transmis au collecteur OTLP. Ajoutez une clé headers, spécifiant le nom et la valeur de l’en-tête à envoyer avec la requête HTTP :

        http:
          headers:
            api-key: auth-header-value
            x-company-header: company-value

Par défaut, aucun en-tête supplémentaire n’est émis avec les métriques.

ℹ️

La plupart des fournisseurs de collecteurs OTLP publics exigent l’utilisation de l’en-tête api-key ou x-api-key.

Exemple complet

Voici un exemple de configuration de télémétrie d’un orchestrateur en cours d’exécution :

tls:
  telem-tls:
    certFile: telemetry/localhost-client.pem
    keyFile: telemetry/localhost-client-key.pem
    caFile: telemetry/rootCA.pem

telemetry:
  metrics:
    enabled: true
    interval: 5m
    exporter: otlp/datadog
  health:
    enabled: true
    exporter: otlp/local
  exporters:
    otlp/local:
      protocols:
        http:
          endpoint: localhost:4318
          insecure: true
    otlp/datadog:
      protocols:
        http:
          tls: telem-tls
          endpoint: otlp.nr-data.net:4318
          headers:
            api-key: <Your company's NewRelicAPIKey>