Couchbase

L'intégration Couchbase collecte des métriques de bucket, telles que les opérations, l'utilisation de la mémoire et les éjections. L'intégration collecte les métriques à partir du serveur Prometheus exposé sur un nœud. L'intégration collecte également les journaux généraux, les journaux d'accès HTTP et les journaux entre centres de données ("goxdcr") de Couchbase.

Pour plus d'informations sur couchbase, consultez la documentation de Couchbase.

Prerequisites

Pour collecter la télémétrie de base, vous devez installer l'agent Ops version 2.18.2 ou ultérieure.

Cette intégration est compatible avec les versions 6.5, 6.6 et 7.0 de votre base de données.

Configurer l'agent Ops pour votre base de données

En suivant le guide de configuration de l'agent Ops, ajoutez les éléments requis pour collecter la télémétrie des instances Couchbase, puis redémarrez l'agent.

Exemple de configuration

La commande suivante crée la configuration permettant de collecter et d'ingérer la télémétrie pour Couchbase, et redémarre l'agent Ops.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    couchbase:
      type: couchbase
      username: admin
      password: password
      collection_interval: 30s
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase

logging:
  receivers:
    couchbase_general:
      type: couchbase_general
    couchbase_http_access:
      type: couchbase_http_access
    couchbase_goxdcr:
      type: couchbase_goxdcr
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase_general
          - couchbase_http_access
          - couchbase_goxdcr

EOF

sudo service google-cloud-ops-agent restart
sleep 30s

Contenu consigné

Le champ logName est dérivé des ID de récepteur spécifiés dans la configuration. Les champs détaillés dans l'entrée de journal (LogEntry) sont les suivants.

Les journaux couchbase_general contiennent les champs suivants dans LogEntry :

Champ	Type	Description
`jsonPayload.message`	chaîne	Message du journal
`jsonPayload.node_name`	chaîne	Nom du nœud émettant le message de journal
`jsonPayload.module_name`	chaîne	Nom du module émettant l'entrée

Les journaux couchbase_http_access contiennent les champs suivants dans LogEntry :

Champ	Type	Description
`jsonPayload.message`	chaîne	Message du journal
`jsonPayload.client_ip`	chaîne	Adresse IP du client appelant la requête HTTP
`jsonPayload.user`	chaîne	Nom de l'utilisateur effectuant la requête HTTP, si l'authentification de base est utilisée.
`jsonPayload.method`	chaîne	Méthode HTTP de la requête
`jsonPayload.status_code`	integer	Code d'état de la réponse à la requête HTTP

Les journaux couchbase_goxdcr contiennent les champs suivants dans LogEntry :

Champ	Type	Description
`jsonPayload.message`	chaîne	Message du journal
`log_type`	chaîne	Nom du composant qui émet le journal entre centres de données

Configurer la collecte de métriques

Pour ingérer des métriques à partir de Couchbase, vous devez créer des récepteurs pour les métriques produites par Couchbase, puis créer un pipeline pour les nouveaux récepteurs.

Pour configurer un récepteur pour vos métriques couchbase, spécifiez les champs suivants :

Champ	Par défaut	Description
`collection_interval`	`60s`	Une valeur time.Duration, telle que `30s` ou `5m`.
`endpoint`	`localhost:8091`	URL du nœud à surveiller.
`password`		Mot de passe utilisé pour se connecter au serveur Couchbase.
`type`		Cette valeur doit être `couchbase`.
`username`		Nom d'utilisateur utilisé pour se connecter au serveur Couchbase.

Métriques surveillées

Le tableau suivant fournit la liste des métriques que l'agent Ops collecte à partir de l'instance Couchbase.

Type de métrique
Genre, type Ressources surveillées	Libellés
`workload.googleapis.com/couchbase.bucket.error.oom.count`
`CUMULATIVE`, `INT64` gce_instance	`bucket_name` `error_type`
`workload.googleapis.com/couchbase.bucket.item.count`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name` `state`
`workload.googleapis.com/couchbase.bucket.item.ejection.count`
`CUMULATIVE`, `INT64` gce_instance	`bucket_name`
`workload.googleapis.com/couchbase.bucket.memory.high_water_mark.limit`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name`
`workload.googleapis.com/couchbase.bucket.memory.low_water_mark.limit`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name`
`workload.googleapis.com/couchbase.bucket.memory.usage`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name`
`workload.googleapis.com/couchbase.bucket.operation.count`
`CUMULATIVE`, `INT64` gce_instance	`bucket_name` `op`
`workload.googleapis.com/couchbase.bucket.vbucket.count`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name` `state`

Exemple de tableau de bord

Pour afficher vos métriques Couchbase, vous devez configurer un graphique ou un tableau de bord. Cloud Monitoring fournit une bibliothèque d'exemples de tableaux de bord pour les intégrations, contenant des graphiques préconfigurés. Pour en savoir plus sur l'installation de ces tableaux de bord, consultez la page Installer des exemples de tableaux de bord.

Vérifier la configuration

Cette section explique comment vérifier que vous avez bien configuré le récepteur Couchbase. La collecte de la télémétrie par l'agent Ops peut prendre une ou deux minutes.

Pour vérifier que les journaux sont ingérés, accédez à l'explorateur de journaux et exécutez la requête suivante pour afficher les journaux Couchbase :

resource.type="gce_instance"
(log_id("couchbase_general") OR log_id("couchbase_http_access") OR log_id("couchbase_goxdcr"))

Pour vérifier que les métriques sont ingérées, accédez à l'explorateur de métriques et exécutez la requête suivante dans l'onglet MQL :

fetch gce_instance
| metric 'workload.googleapis.com/couchbase.bucket.memory.usage'
| every 1m

Étape suivante

Pour accéder à un tutoriel pas à pas expliquant comment utiliser Ansible pour installer l'agent Ops, configurer une application tierce et installer un exemple de tableau de bord, consultez la vidéo Install the Ops Agent to troubleshoot third-party applications (Installer l'agent Ops pour résoudre les problèmes liés à des applications tierces).