Intégration monitoring HashiCorp Consul

Notre intégration HashiCorp Consul sur hôte collecte et envoie l'inventaire et les métriques de votre environnement data center Consul à New Relic, où vous pouvez voir l'état de santé de votre environnement. Nous collectons des données à la fois au niveau du data center et au niveau de l'agent/nœud.

Conseil

Notez que nous avons également une intégration de la plateforme HashiCorp Cloud Consul.

Compatibilité et exigences

Avant l'installation, assurez-vous de répondre aux exigences suivantes :

Notre intégration est compatible avec HashiCorp Consul 1.0 ou supérieur.
Si vous utilisez ACL, les informations d’identification pour l’intégration Consul doivent avoir les stratégies agent:read, node:read et service:read.

Démarrage rapide

instrumentez votre environnement Consul rapidement et envoyez vos données télémétriques avec installation guidée. Notre guide d'installation utilise notre agent infrastructure et notre CLI pour configurer l'intégration HashiCorp, et découvre d'autres applications et sources log exécutées dans votre environnement, puis recommande celles que vous devez instrumenter.

L'installation guidée fonctionne avec la plupart des configurations. Mais si cela ne répond pas à vos besoins, il existe d'autres options d'installation ci-dessous.

Prêt à commencer ? Cliquez sur le bouton correspondant, en fonction de la régiondata center que vous utilisez. Une fois l'installation terminée, revenez à cette documentation pour consulter les options de configuration.

installation guidée, région des États-Unis

installation guidée, région UE

Installation

Pour installer l'intégration HashiCorp Consul, suivez les instructions correspondant à votre environnement :

' '

Installez l'agent d'infrastructure et remplacez la variable INTEGRATION_FILE_NAME par nri-consul.
Changer de répertoire vers le dossier d'intégration :
```
cd /etc/newrelic-infra/integrations.d
```
Copiez l’exemple de fichier de configuration :
```
sudo cp consul-config.yml.sample consul-config.yml
```
Modifiez le fichier consul-config.yml comme décrit dans les paramètres de configuration.

Téléchargez l'image du programme d'installation nri-consul .MSI depuis :
https://download.newrelic.com/infrastructure_agent/windows/integrations/nri-consul/nri-consul-amd64.msi
Pour installer à partir de l’invite de commande Windows, exécutez :
```
msiexec.exe /qn /i PATH\TO\nri-consul-amd64.msi
```
Dans le répertoire d’intégration, C:\Program Files\New Relic\newrelic-infra\integrations.d\, créez une copie du fichier configuration d’exemple en exécutant :
```
copy consul-config.yml.sample consul-config.yml
```
Modifiez le fichier consul-config.yml comme décrit dans les paramètres de configuration.

Mettez à jour votre intégration

Cette intégration ne se met pas à jour automatiquement. Pour de meilleurs résultats, mettez régulièrement à jour le package d'intégration et l'agent d'infrastructure.

Tâches post-installation

Une fois l'installation terminée, vous pouvez définir les options de configuration. Certaines configurations sont nécessaires pour que l'intégration fonctionne, tandis que d'autres sont facultatives.

Configurer l'intégration

Si vous avez activé cette intégration via notre intégration ECS ou Kubernetes, consultez ces documents :

Pour l'installation standard sur l'hôte, cette intégration est livrée avec un fichier de configuration YAML, apache-config.yml. Cette configuration vous permet de placer les informations de connexion requises et de configurer la manière dont les données sont collectées. Les options que vous modifiez dépendent de votre configuration et de vos préférences. Il est livré avec un exemple de fichier de configuration apache-config.yml.sample que vous pouvez copier et modifier.

Les paramètres spécifiques liés à Consul sont définis à l'aide de la section env du fichier de configuration. Ces paramètres contrôlent la connexion à votre instance Consul ainsi que d'autres paramètres et fonctionnalités de sécurité.

Important

Si vous utilisez toujours nos legacy fichiers configuration/définition, veuillez vous référer à ce document pour obtenir de l'aide.

Options de configuration du consul

L'intégration Consul collecte à la fois des métriques et des informations d'inventaire. Ce tableau montre à quoi s’applique chaque option de configuration.

' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' '

Paramètre	Description	Défaut	S'applique à
HOSTNAME	nom d'hôte ou IP où Consul est exécuté.	hôte local	MI
PORT	Port sur lequel le consul écoute.	8500	MI
TOKEN	ACL jeton si l'authentification jeton est activée.	N/A	MI
ENABLE_SSL	Connectez-vous en utilisant SSL.	false	MI
CA_BUNDLE_FILE	Fichier groupé d'autorité de certification alternative.	N/A	MI
CA_BUNDLE_DIR	Répertoire de bundles d'autorités de certification alternatives.	N/A	MI
TRUST_SERVER_CERTIFICATE	Si défini sur vrai, le certificat du serveur n'est PAS vérifié pour SSL.	false	MI
FAN_OUT	Si la valeur est vraie, il tentera de collecter les métriques de tous les autres nœuds du cluster Consul.	vrai	M
CHECK_LEADERSHIP	Vérifiez le leadership sur le serveur consulaire. Cela devrait être désactivé sur consul en mode client.	vrai	M
TIMEOUT	Délai d'expiration pour chacun des appels clients du consul.	Années 30	MI
METRICS	Définissez sur `true` pour activer la collecte de métriques uniquement.	false
INVENTORY	Définissez sur `true` pour activer la collecte d'inventaire uniquement.	false

Les valeurs de ces paramètres peuvent être définies de plusieurs manières :

Ajout de la valeur directement dans le fichier de configuration. C'est la manière la plus courante.
Remplacement des valeurs des variables d’environnement à l’aide de la notation {{}} . Cela nécessite l'agent d'infrastructure v1.14.0+. Lire la suite ici ou voir l'exemple ci-dessous.
Utilisation de la gestion des secrets. Utilisez ceci pour protéger les informations sensibles, telles que les mots de passe qui seraient exposés en texte brut dans le fichier de configuration. Pour plus d'informations, voir Gestion des secrets.

Étiquettes

Vous pouvez également décorer vos métriques à l’aide d’étiquettes. Les étiquettes vous permettent d'ajouter des paires d'attributs (valeur clé) à vos métriques, que vous pouvez ensuite utiliser pour interroger, filtrer ou regrouper vos métriques.

Notre fichier de configuration d'exemple par défaut inclut des exemples d'étiquettes mais, comme ils ne sont pas obligatoires, vous pouvez supprimer, modifier ou ajouter de nouvelles étiquettes de votre choix.

labels:
   env: production
   role: load_balancer

Exemple de configuration

Il s'agit de la configuration de base utilisée pour collecter les métriques et l'inventaire à partir de votre hôte local :

integrations:
  - name: nri-consul
    env:
      HOSTNAME: localhost
      PORT: 8500
    interval: 15s
    labels:
      environment: production
    inventory_source: config/consul

Cette configuration collecte des métriques toutes les 30 secondes et un inventaire toutes les 60 secondes avec un délai d'expiration :

integrations:
  - name: nri-consul
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 8500
      TIMEOUT: 10s
    interval: 15s
    labels:
      environment: production

  - name: nri-consul
    env:
      INVENTORY: true
      HOSTNAME: localhost
      PORT: 8500
      TIMEOUT: 10s
    interval: 60s
    labels:
      environment: production
    inventory_source: config/consul

Dans cette configuration nous utilisons la variable d'environnement CONSUL_HOST pour renseigner le paramètre nom d'hôte de l'intégration :

integrations:
  - name: nri-consul
    env:
      METRICS: "true"
      HOSTNAME: {{CONSUL_HOST}}
      PORT: 8500
    interval: 15s
    labels:
      env: production
      role: load_balancer

Dans cette configuration, nous utilisons un jeton ACL pour nous connecter et nous ne collectons pas de métriques à partir d'autres nœuds consul connectés (FAN_OUT : false) :

integrations:
  - name: nri-consul
    env:
      METRICS: "true"
      HOSTNAME: localhost
      PORT: 8500
      TOKEN: my_token
      FAN_OUT: false
    interval: 15s
    labels:
      env: production
      role: load_balancer

Dans cette configuration nous monitoring plusieurs serveurs Consul à partir de la même intégration. Pour la première instance (HOSTNAME: 1st_consul_host), nous collectons des métriques et un inventaire tandis que pour la deuxième instance (HOSTNAME: 2nd_consul_host), nous collecterons uniquement des métriques.

integrations:
  - name: nri-consul
    env:
      METRICS: "true"
      HOSTNAME: 1st_consul_host
      PORT: 8500
    interval: 15s
    labels:
      env: production
      role: load_balancer
  - name: nri-consul
    env:
      INVENTORY: "true"
      HOSTNAME: 1st_consul_host
      PORT: 8500
    interval: 60s
    labels:
      env: production
      role: load_balancer
    inventory_source: config/consul

  - name: nri-consul
    env:
      METRICS: "true"
      HOSTNAME: 2nd_consul_host
      PORT: 8500
    interval: 15s
    labels:
      env: production
      role: load_balancer

Rechercher et utiliser des données

Les données de cette intégration peuvent être trouvées en allant à : one.newrelic.com > Infrastructure > Third-party services > Apache.

Les données Apache sont attachées aux types d'événements ConsulDatacenterSampleet ConsulAgentSample. Vous pouvez interroger ces données à des fins de dépannage ou pour créer des graphiques et des dashboards personnalisés.

Pour en savoir plus sur la recherche et l’utilisation de vos données, consultez Comprendre les données d’intégration.

données métriques

L'intégration HashiCorp Consul collecte l'attribut de données métriques suivant :

Exemples de mesures data center Consul

Ces attributs sont attachés au type d'événement ConsulDatacenterSample :

métrique	Description
`consul.catalog.nodes_critical`	Le nombre de nœuds avec le statut de service `critical` parmi ceux enregistrés.
`consul.catalog.nodes_passing`	Le nombre de nœuds avec le statut de service `passing` parmi ceux enregistrés.
`consul.catalog.nodes_up`	Le nombre de nœuds.
`consul.catalog.nodes_warning`	Le nombre de nœuds avec le statut de service `warning` parmi ceux enregistrés.
`consul.catalog.total_nodes`	Le nombre de nœuds enregistrés dans le cluster consul.
`consul.memberlist.msg.suspect`	Le nombre de fois qu'un agent soupçonne un autre d'avoir échoué lors d'une enquête dans le cadre du protocole de commérages.
`consul.raft.apply`	Le nombre de transactions de radeau en cours.
`consul.raft.commitTime.avg`	Le temps moyen nécessaire pour valider une nouvelle entrée dans le log du radeau sur le leader.
`consul.raft.commitTime.count`	Le nombre d'échantillons de `raft.commitTime`.
`consul.raft.commitTime.max`	Le temps maximum nécessaire pour valider une nouvelle entrée dans le log du radeau sur le leader.
`consul.raft.commitTime.median`	Le temps médian nécessaire pour valider une nouvelle entrée dans le log du radeau sur le leader.
`consul.raft.leader.dispatchLog.avg`	Le temps moyen nécessaire au leader pour écrire les entrées log sur le disque.
`consul.raft.leader.dispatchLog.count`	Le nombre d'échantillons de `raft.leader.dispatchLog`.
`consul.raft.leader.dispatchLog.max`	Le temps maximum nécessaire au leader pour écrire les entrées log sur le disque.
`consul.raft.leader.dispatchLog.median`	Le temps médian nécessaire au leader pour écrire les entrées log sur le disque.
`consul.raft.leader.lastContact.avg`	Le temps moyen écoulé depuis que le leader a pu vérifier pour la dernière fois son bail avec ses partisans.
`consul.raft.leader.lastContact.count`	Le nombre d'échantillons de `raft.leader.lastContact`.
`consul.raft.leader.lastContact.max`	Le temps maximum écoulé depuis que le leader a pu vérifier pour la dernière fois son bail avec ses suiveurs.
`consul.raft.leader.lastContact.median`	Le temps médian écoulé depuis que le leader a pu vérifier pour la dernière fois son bail avec ses suiveurs.
`consul.raft.state.candidate`	Le nombre d'élections de dirigeants initiées.
`consul.raft.state.leader`	Le nombre d’élections de dirigeants terminées.
`consul.serf.member.flap`	Le nombre de fois où un agent est marqué comme mort puis récupère rapidement.

Exemples de mesures d'agent consul

Ces attributs sont attachés au type d'événement ConsulAgentSample :

métrique	Description
`agent.aclCacheHit`	Taux d'accès au cache ACL.
`agent.aclCacheMiss`	Échecs du cache ACL.
`agent.kvStores`	Le nombre d'échantillons de `kvs.apply`.
`agent.kvStoresAvgInMilliseconds`	Le temps moyen nécessaire pour terminer une mise à jour de la boutique KV.
`agent.kvStoresMaxInMilliseconds`	Le temps maximum nécessaire pour terminer une mise à jour de la boutique KV.
`agent.kvStoresMedianInMilliseconds`	Le temps médian nécessaire pour terminer une mise à jour de la boutique KV.
`agent.peers`	Le nombre de pairs dans l’ensemble de pairs.
`agent.staleQueries`	Requête servie dans le seuil d'obsolescence autorisé.
`agent.txnAvgInMilliseconds`	Le temps moyen nécessaire pour appliquer une opération de transaction.
`agent.txnMaxInMilliseconds`	Le temps maximum nécessaire pour appliquer une opération de transaction.
`agent.txnMedianInMilliseconds`	Le temps médian nécessaire pour appliquer une opération de transaction.
`agent.txns`	Le nombre d'échantillons de `txn.apply`.
`client.rpcFailed`	Mesure des requests RPC ayant échoué.
`client.rpcLoad`	Mesure de la quantité de charge qu'un agent effectue sur les serveurs Consul.
`client.rpcRateLimited`	Mesure des requests RPC dont le débit est limité.
`net.agent.maxLatencyInMilliseconds`	Latence maximale de ce nœud vers tous les autres.
`net.agent.medianLatencyInMilliseconds`	Latence médiane de ce nœud à tous les autres.
`net.agent.minLatencyInMilliseconds`	Latence minimale de ce nœud vers tous les autres.
`net.agent.p25LatencyInMilliseconds`	Latence P25 de ce nœud vers tous les autres.
`net.agent.p75LatencyInMilliseconds`	Latence P75 de ce nœud à tous les autres.
`net.agent.p90LatencyInMilliseconds`	Latence P90 de ce nœud vers tous les autres.
`net.agent.p95LatencyInMilliseconds`	Latence P95 de ce nœud à tous les autres.
`net.agent.p99LatencyInMilliseconds`	Latence P99 de ce nœud vers tous les autres.
`runtime.allocations`	Nombre cumulé d'objets de tas alloués.
`runtime.allocationsInBytes`	Les octets actuels alloués par le processus Consul.
`runtime.frees`	Nombre cumulé d'objets de tas libérés.
`runtime.gcCycles`	Le nombre de cycles GC terminés.
`runtime.gcPauseInMilliseconds`	Nanosecondes cumulées dans les pauses GC stop-the-world depuis le démarrage de Consul.
`runtime.goroutines`	Le nombre de goroutines d'exécution.
`runtime.heapObjects`	Le nombre d'objets alloués sur le tas
`runtime.virtualAddressSpaceInBytes`	Taille totale de l'espace d'adressage virtuel réservé par le goruntime.

Données d'inventaire

L'intégration HashiCorp Consul capture les paramètres de configuration et les paramètres actuels des nœuds Consul Agent. Il collecte les résultats des /v1/agent/self points de terminaison d'API REST. Il extrait les sections Config et DebugConfig de cette réponse.

Conseil

Note: Les sections imbriquées dans Config et DebugConfig ne sont pas collectées.

Les données sont disponibles sur la page Inventaire, sous la source config/consul . Pour en savoir plus sur les données d’inventaire, consultez Comprendre les données d’intégration.

Vérifiez le code source

Cette intégration est un logiciel open source. Cela signifie que vous pouvez parcourir son code source et envoyer des améliorations, ou créer votre propre fork et le construire.

Cette traduction automatique est fournie pour votre commodité.

Intégration monitoring HashiCorp Consul

Conseil

Compatibilité et exigences

Démarrage rapide

Installation

ECS

Kubernetes

Linux

Windows

Mettez à jour votre intégration

Tâches post-installation

Configurer l'intégration

Important

Options de configuration du consul

Étiquettes

Exemple de configuration

Configuration de base

configuration de base avec différents intervalles métriques/d'inventaire

Remplacement des variables d'environnement

Métriques uniquement avec jeton et sans Fan Out

multi-instance monitoring

Rechercher et utiliser des données

données métriques

Exemples de mesures data center Consul

Exemples de mesures d'agent consul

Données d'inventaire

Conseil

Vérifiez le code source

Cette traduction automatique est fournie pour votre commodité.

Intégration monitoring HashiCorp Consul

Conseil

Compatibilité et exigences .css-21sua1{background:none;border:none;width:0;padding:0;}

Démarrage rapide

Installation

Kubernetes

Linux

Windows

Mettez à jour votre intégration

Tâches post-installation

Configurer l'intégration

Important

Options de configuration du consul

Étiquettes

Exemple de configuration

Configuration de base

configuration de base avec différents intervalles métriques/d'inventaire

Remplacement des variables d'environnement

Métriques uniquement avec jeton et sans Fan Out

multi-instance monitoring

Rechercher et utiliser des données

données métriques

Exemples de mesures data center Consul

Exemples de mesures d'agent consul

Données d'inventaire

Conseil

Vérifiez le code source

Compatibilité et exigences