Intégration monitoring Couchbase

Notre intégration Couchbase collecte et envoie les données d'inventaire et de métrique de votre cluster Couchbase à la plateforme New Relic, où vous pouvez rapidement voir l'état de votre environnement Couchbase. Nous collectons des données au niveau du cluster, du nœud, du moteur de requête et du bucket afin que vous puissiez trace un problème jusqu'à sa source.

Lisez la suite pour installer l’intégration et voir quelles données nous collectons.

Compatibilité et exigences

Notre intégration est compatible avec Couchbase version 4.0 ou supérieure.

Démarrage rapide

Si vous n'exécutez pas Couchbase dans des environnements Kubernetes ou ECS, nous vous recommandons notre installation guidée. Notre guide d'installation utilise notre agent infrastructure et notre CLI pour configurer l'intégration Couchbase, 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 Couchbase, suivez les instructions correspondant à votre environnement :

' '

Installez l'agent d'infrastructure et remplacez la variable INTEGRATION_FILE_NAME par nri-couchbase.
Changer de répertoire vers le dossier d'intégration :
```
cd /etc/newrelic-infra/integrations.d
```

Copie du fichier de configuration d'exemple :

sudo cp couchbase-config.yml.sample couchbase-config.yml

Modifiez le fichier couchbase-config.yml comme décrit dans les paramètres de configuration.

Téléchargez l'image du programme d'installation nri-couchbase .MSI depuis :
https://download.newrelic.com/infrastructure_agent/windows/integrations/nri-couchbase/nri-couchbase-amd64.msi
Pour installer à partir de l’invite de commande Windows, exécutez :
```
msiexec.exe /qn /i PATH\TO\nri-couchbase-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 couchbase-config.yml.sample couchbase-config.yml
```
Modifiez le fichier couchbase-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.

Le fichier configuration contient des paramètres communs applicables à toutes les intégrations, tels que interval, timeout, inventory_source. Pour tout savoir sur ces paramètres courants, reportez-vous à notre document Format de configuration .

Les paramètres spécifiques liés à Couchbase sont définis à l'aide de la section env du fichier de configuration. Ces paramètres contrôlent la connexion à votre instance Couchbase ainsi que d'autres paramètres et fonctionnalités de sécurité. La liste des paramètres valides est décrite dans la section suivante de ce document.

Options de configuration de Couchbase

L'intégration Couchbase 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ù Couchbase est exécuté.	hôte local	MI
PORT	Port sur lequel l'API Couchbase écoute.	8091	MI
QUERY_PORT	Port sur lequel le service Couchbase N1QL écoute.	8093	MI
USERNAME	Nom d'utilisateur pour accéder à l'API Couchbase.	N/A	MI
PASSWORD	Mot de passe pour l'utilisateur donné.	N/A	MI
USE_SSL	Utilisez SSL lors de la communication avec Couchbase.	false	MI
CA_BUNDLE_FILE	Emplacement du certificat SSL sur l'hôte. Requis uniquement si `USE_SSL` est vrai.	N/A	MI
CA_BUNDLE_DIR	Répertoire de bundles d'autorités de certification alternatives.	N/A	MI
TIMEOUT	Délai d'expiration requests API, en secondes.	30	MI
ENABLE_BUCKETS	Si vrai, collecte les ressources du bucket.	vrai	M
ENABLE_BUCKET_STATS	Si vrai, collecte des statistiques de bucket supplémentaires.	vrai	M
ENABLE_CLUSTER_AND_NODES	Si vrai, collecte les ressources du cluster et du nœud.	vrai	M
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 (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 version 1.14.0 ou supérieure. Pour plus d'informations, consultez Configuration de l'infrastructure ou consultez l'exemple de variable d'environnement.
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-couchbase
    env:
      HOSTNAME: localhost
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      environment: production
    inventory_source: config/couchbase

Cette configuration collecte des métriques toutes les 15 secondes et un inventaire toutes les 60 secondes :

integrations:
  - name: nri-couchbase
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      environment: production

  - name: nri-couchbase
    env:
      INVENTORY: true
      HOSTNAME: localhost
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 60s
    labels:
      environment: production
    inventory_source: config/couchbase

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

integrations:
  - name: nri-couchbase
    env:
      METRICS: "true"
      HOSTNAME: {{COUCHBASE_HOST}}
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      env: production
      role: load_balancer

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

integrations:
  - name: nri-couchbase
    env:
      METRICS: "true"
      HOSTNAME: 1st_couchbase_host
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      env: production
      role: load_balancer
  - name: nri-couchbase
    env:
      INVENTORY: "true"
      HOSTNAME: 1st_couchbase_host
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 60s
    labels:
      env: production
      role: load_balancer
    inventory_source: config/couchbase

  - name: nri-couchbase
    env:
      METRICS: "true"
      HOSTNAME: 2nd_couchbase_host
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      env: production
      role: load_balancer

Rechercher et utiliser des données

les données d'intégration sont rapportées au dashboard d'intégration.

Les données Couchbase sont attachées aux types d’événements suivants :

CouchbaseBucketSample
CouchbaseClusterSample
CouchbaseNodeSample
CouchbaseQueryEngineSample

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 Couchbase collecte l'attribut de données métriques suivant. Certains noms métriques sont préfixés par un indicateur de catégorie et un point, tels que cluster. ou node..

Exemples de mesures du bucket Couchbase

Ces attributs sont attachés au type d'événement CouchbaseBucketSample .

métrique	Description
`bucket.activeResidentItemsRatio`	Pourcentage d'éléments actifs mis en cache dans la RAM dans ce bucket.
`bucket.averageDiskCommitTimeInMilliseconds`	Le temps moyen de validation du disque du bucket, en millisecondes.
`bucket.averageDiskUpdateTimeInMilliseconds`	Le temps moyen de mise à jour du disque du bucket, en millisecondes.
`bucket.cacheMissRatio`	Pourcentage de lectures par seconde dans ce bucket à partir du disque par opposition à la RAM.
`bucket.currentConnections`	Nombre de connexions à ce serveur, y compris les connexions provenant de SDK clients externes, de proxys, requests TAP et de collecte de statistiques internes.
`bucket.dataUsedInBytes`	Quantité de données utilisées par ce bucket, en octets.
`bucket.decrementHitsPerSecond`	Le nombre de décrémentations par seconde du bucket.
`bucket.decrementMissesPerSecond`	Le nombre d'échecs de décrémentation par seconde du bucket.
`bucket.deleteHitsPerSecond`	Le nombre de suppressions par seconde pour ce bucket.
`bucket.deleteMissesPerSecond`	Le nombre d'échecs de suppression par seconde pour ce bucket.
`bucket.diskCreateOperationsPerSecond`	Nombre de nouveaux éléments créés sur le disque par seconde pour ce bucket.
`bucket.diskFetchesPerSecond`	Le nombre d'opérations requises par seconde pour récupérer des éléments du disque sur le bucket.
`bucket.diskUpdateOperationsPerSecond`	Nombre d'éléments mis à jour sur le disque par seconde pour ce bucket.
`bucket.diskUsedInBytes`	La quantité d'espace disque utilisée pour le bucket, en octets.
`bucket.diskWriteQueue`	Nombre d'éléments en attente d'être écrits sur le disque dans le bucket.
`bucket.ejectionsPerSecond`	Nombre total d'éléments par seconde éjectés sur le disque dans ce compartiment
`bucket.evictionPolicy`	La politique d'expulsion du seau.
`bucket.evictionsPerSecond`	Le nombre d'éléments par seconde expulsés du bucket.
`bucket.getHitsPerSecond`	Nombre d'opérations d'obtention par seconde pour les données contenues dans ce bucket.
`bucket.getMissesPerSecond`	Nombre d'opérations d'obtention par seconde pour les données que ce bucket ne contient pas.
`bucket.hitRatio`	Pourcentage de requêtes GET traitées avec des données de ce bucket.
`bucket.incrementHitsPerSecond`	Le nombre d'incréments par seconde du bucket.
`bucket.incrementMissesPerSecond`	Le nombre d'échecs d'incrémentation par seconde du bucket.
`bucket.itemCount`	Le nombre d'objets stockés dans le bucket.
`bucket.memoryHighWaterMarkInBytes`	Limite supérieure pour les expulsions automatiques sur le bucket, en octets.
`bucket.memoryLowWaterMarkInBytes`	Limite d'eau basse pour les expulsions automatiques sur le bucket, en octets.
`bucket.memoryUsedInBytes`	La quantité de RAM utilisée pour le bucket, en octets.
`bucket.metadataInRAMInBytes`	Quantité de RAM utilisée pour les métadonnées sur ce bucket, en octets.
`bucket.missesPerSecond`	Le nombre d'échecs par seconde du bucket.
`bucket.nodeLocator`	Type de localisateur de nœuds.
`bucket.outOfMemoryErrorsPerSecond`	Nombre d'erreurs matérielles de manque de mémoire pour ce bucket.
`bucket.OverheadInBytes`	La mémoire supplémentaire utilisée par les données transitoires (files d'attente de persistance, files d'attente de réplication, points de contrôle, etc.) sur le bucket, en octets.
`bucket.pendingResidentItemsRatio`	Pourcentage d'éléments en attente mis en cache dans la RAM dans ce bucket.
`bucket.quotaUtilization`	Le pourcentage du quota de RAM actuellement utilisé sur le bucket.
`bucket.readOperationsPerSecond`	Le nombre de lectures (opérations d'obtention) par seconde à partir de ce bucket.
`bucket.readRatePerSecond`	Les octets lus par seconde du bucket.
`bucket.replicaIndex`	Définit si les index de réplication sont activés pour le bucket.
`bucket.replicaNumber`	Nombre de répliques de ce bucket.
`bucket.replicaResidentItemsRatio`	Pourcentage d'éléments de réplique mis en cache dans la RAM dans ce bucket.
`bucket.residentItemsRatio`	Pourcentage de tous les éléments mis en cache dans la RAM dans ce bucket.
`bucket.temporaryOutOfMemoryErrorsPerSecond`	Nombre de back-offs envoyés par seconde aux SDK clients en raison de situations de manque de mémoire à partir de ce bucket.
`bucket.threadsNumber`	Le nombre de lecteurs et d’écrivains simultanés pour le compartiment de données.
`bucket.totalOperationsPerSecond`	Le nombre total d'opérations par seconde du bucket.
`bucket.writeOperationsPerSecond`	Le nombre d'écritures (opérations de définition) par seconde dans ce bucket.
`bucket.writeRatePerSecond`	Les octets écrits dans le bucket.

Exemples de mesures cluster Couchbase

Ces attributs sont attachés au type d'événement CouchbaseClusterSample .

métrique	Description
`cluster.autoFailoverCount`	Le nombre de basculements automatiques sur le cluster.
`cluster.autoFailoverEnabled`	Indique si le basculement est activé sur le cluster.
`cluster.databaseFragmentationThreshold`	Le niveau de pourcentage dans la base de données auquel le compactage se produit.
`cluster.diskFreeInBytes`	L'espace disque libre sur ce cluster, en octets.
`cluster.diskQuotaTotalInBytes`	Espace disque total disponible pour Couchbase, en octets.
`cluster.diskTotalInBytes`	Espace disque total disponible, en octets.
`cluster.diskUsedbyDataInBytes`	Disque utilisé par les données du bucket sur ce cluster, en octets.
`cluster.diskUsedInBytes`	L'espace disque utilisé sur ce cluster, en octets.
`cluster.indexFragmentationThreshold`	Le niveau de pourcentage dans les indices auquel le compactage se produit.
`cluster.maximumBucketCount`	Nombre maximal de buckets pris en charge par ce cluster.
`cluster.memoryQuotaTotalInBytes`	RAM totale disponible pour Couchbase, en octets.
`cluster.memoryQuotaTotalPerNodeInBytes`	RAM totale disponible pour Couchbase, par nœud, en octets.
`cluster.memoryQuotaUsedInBytes`	RAM totale utilisée par Couchbase, en octets.
`cluster.memoryQuotaUsedPerNodeInBytes`	RAM totale utilisée par Couchbase, par nœud, en octets.
`cluster.memoryTotalInBytes`	La RAM totale sur ce cluster, en octets.
`cluster.memoryUsedByDataInBytes`	RAM totale utilisée par les données du bucket sur ce cluster, en octets.
`cluster.memoryUsedInBytes`	La RAM totale utilisée sur ce cluster, en octets.
`cluster.viewFragmentationThreshold`	Le pourcentage de fragmentation dans tous les fichiers d'index de vue auquel le compactage est déclenché.

Exemples de mesures du nœud Couchbase

Ces attributs sont attachés au type d'événement CouchbaseNodeSample .

métrique	Description
`node.cpuUtilization`	L'utilisation du processeur du nœud.
`node.memoryFreeInBytes`	La mémoire libre du nœud, en octets.
`node.memoryTotalInBytes`	La mémoire totale allouée au nœud, en octets.
`node.recoveryType`	Le type de récupération du nœud.
`node.services`	Les services du nœud.
`node.status`	L'état du nœud. (`0` = malsain, `1` = sain)
`node.swapTotalInBytes`	L'espace d'échange total du nœud, en octets.
`node.swapUsedInBytes`	L'espace de swap utilisé par le nœud, en octets.
`node.uptimeInMilliseconds`	Le temps de disponibilité du nœud, en millisecondes.

Exemples de mesures du moteur de requête Couchbase

Ces attributs sont attachés au type d'événement CouchbaseQueryEngineSample .

métrique	Description
`queryengine.activeRequests`	Nombre actuel de requests actives.
`queryengine.averageRequestTimeInMilliseconds`	Temps de requête moyen de ce moteur de requête, en millisecondes.
`queryengine.completedLimit`	Nombre de requêtes que Couchbase conservera dans le log des requêtes.
`queryengine.completedRequests`	Nombre actuel de requests complétées.
`queryengine.completedThresholdInMilliseconds`	Temps minimum que la requête doit prendre pour être enregistrée dans le log des requêtes Couchbase, en millisecondes.
`queryengine.cores`	Nombre de cœurs disponibles pour ce moteur de requête.
`queryengine.garbageCollectionNumber`	Numéro du dernier ramasse-miettes.
`queryengine.garbageCollectionPaused`	Pourcentage de temps pendant lequel le ramassage des déchets est suspendu.
`queryengine.garbageCollectionTimePausedInMilliseconds`	Nombre de millisecondes pendant lesquelles le ramassage des déchets est suspendu, en millisecondes.
`queryengine.medianRequestTimeInMilliseconds`	Temps de requête médian de ce moteur de requête, en millisecondes.
`queryengine.preparedStatementUtilization`	Pourcentage de requests qui sont des déclarations préparées.
`queryengine.requestsLast15MinutesPerSecond`	Requêtes par seconde en moyenne au cours des 15 dernières minutes.
`queryengine.requestsLast1MinutesPerSecond`	Requêtes par seconde en moyenne au cours de la dernière minute.
`queryengine.requestsLast5MinutesPerSecond`	Requêtes par seconde en moyenne au cours des 5 dernières minutes.
`queryengine.requestTime80thPercentileInMilliseconds`	80e percentile du temps de requête de ce moteur de requête, en millisecondes.
`queryengine.requestTime95thPercentileInMilliseconds`	95e percentile du temps de requête de ce moteur de requête, en millisecondes.
`queryengine.requestTime99thPercentileInMilliseconds`	99e percentile du temps de requête de ce moteur de requête, en millisecondes.
`queryengine.systemCPUUtilization`	Utilisation du processeur de ce moteur de requête
`queryengine.systemMemoryInBytes`	L'espace d'adressage virtuel réservé par ce moteur de requête, en octets.
`queryengine.totalMemoryInBytes`	Quantité cumulée de mémoire allouée aux objets de tas par ce moteur de requête, en octets.
`queryengine.totalThreads`	Nombre total de threads utilisés par ce moteur de requête.
`queryengine.uptimeInMilliseconds`	temps de disponibilité de ce moteur de requêtes, en millisecondes
`queryengine.usedMemoryInBytes`	Quantité de mémoire allouée aux objets de tas pour ce moteur de requête, en octets.
`queryengine.userCPUUtilization`	Utilisation du processeur par l'utilisateur de ce moteur de requête.

Données d'inventaire

L'intégration Couchbase capture les paramètres de configuration de la base de données Couchbase. Les données sont disponibles sur la page Inventaire dans l'UI infrastructure, sous la source config/couchbase. Pour en savoir plus sur les données d’inventaire, voir Comprendre les données.

L'intégration capture les données pour les paramètres de configuration Couchbase suivants :

Nom	Description
`Node locator`	Type de localisateur de nœuds.
`Proxy port`	Port proxy sur lequel le bucket communique.
`Type`	Le type de seau.
`UUID`	L'UUID du bucket.

Nom	Description
`Collection node`	Le nœud utilisé pour collecter les métriques.
`Couchbase version`	La version de Couchbase exécutée sur ce cluster.
`UUID`	L'UUID du cluster.

Nom	Description
`Cluster membership`	L'appartenance au cluster du nœud.
`Hostname`	Le nom d'hôte du nœud.
`Operating system`	Le système d'exploitation du nœud.
`Port`	Le port du nœud.
`Recovery type`	Le type de récupération du nœud.
`Services`	Une liste séparée par des virgules des services du nœud.
`Version`	La version de Couchbase exécutée sur ce nœud.

Nom	Description
`Node hostname`	Le nom d'hôte du nœud sur lequel ce moteur de requête s'exécute.
`Node port`	Le port du nœud sur lequel ce moteur de requête s'exécute.
`Version`	La version de ce moteur de requête.

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é.

Compatibilité et exigences

Démarrage rapide

Installation

ECS

Kubernetes

Linux

Windows

Mettez à jour votre intégration

Tâches post-installation

Configurer l'intégration

Options de configuration de Couchbase

Étiquettes

Exemple de configuration

Configuration de base

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

Remplacement des variables d'environnement

multi-instance monitoring

Rechercher et utiliser des données

données métriques

Exemples de mesures du bucket Couchbase

Exemples de mesures cluster Couchbase

Exemples de mesures du nœud Couchbase

Exemples de mesures du moteur de requête Couchbase

Données d'inventaire

Paramètres du bucket

Paramètres Cluster

Paramètres du nœud

Paramètres du moteur de requête

Vérifiez le code source

Cette traduction automatique est fournie pour votre commodité.

Intégration monitoring Couchbase

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

Options de configuration de Couchbase

Étiquettes

Exemple de configuration

Configuration de base

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

Remplacement des variables d'environnement

multi-instance monitoring

Rechercher et utiliser des données

données métriques

Exemples de mesures du bucket Couchbase

Exemples de mesures cluster Couchbase

Exemples de mesures du nœud Couchbase

Exemples de mesures du moteur de requête Couchbase

Données d'inventaire

Paramètres du bucket

Paramètres Cluster

Paramètres du nœud

Paramètres du moteur de requête

Vérifiez le code source

Compatibilité et exigences