Apache CouchDB

L'intégration Apache CouchDB collecte des métriques liées au trafic, telles que le nombre de requêtes adressées à un nœud et les réponses du nœud. Elle collecte également les métriques des bases de données, telles que le nombre de bases de données ouvertes et le nombre d'opérations. L'intégration collecte les journaux d'accès et CouchDB généraux, puis les analyse en une charge utile JSON. Le résultat inclut les champs d'utilisateur, d'hôte, de niveau et de message.

Pour en savoir plus sur CouchDB, consultez la documentation Apache CouchDB.

Prerequisites

Pour collecter les données de télémétrie CouchDB, vous devez installer l'agent Ops :

Pour les métriques, installez la version 2.10.0 ou ultérieure.
Pour les journaux, installez la version 2.11.0 ou ultérieure.

Cette intégration est compatible avec CouchDB versions 2.3.x, 3.1 et ultérieures.

Configurer l'agent Ops pour CouchDB

En suivant le guide de configuration de l'agent Ops, ajoutez les éléments requis pour collecter les journaux de vos instances CouchDB et 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 CouchDB, et redémarre l'agent Ops.

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

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    couchdb:
      type: couchdb
      username: admin
      password: otelp
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb

logging:
  receivers:
    couchdb:
      type: couchdb
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
EOF

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

Configurer la collecte de journaux

Pour ingérer des journaux à partir de CouchDB, vous devez créer des récepteurs pour les journaux produits par CouchDB, puis créer un pipeline pour les nouveaux récepteurs.

Pour configurer un récepteur pour vos journaux couchdb, spécifiez les champs suivants :

Champ	Par défaut	Description
`exclude_paths`		Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à `include_paths`.
`include_paths`	`[/var/log/couchdb/couchdb.log]`	Liste des chemins d'accès du système de fichiers à lire en affichant chaque fichier. Un caractère générique (``) peut être utilisé dans les chemins d'accès. Exemple : `/var/log/couchdb/*.log`.
`record_log_file_path`	`false`	Si cette valeur est définie sur `true`, le chemin d'accès au fichier spécifique à partir duquel l'enregistrement de journal a été obtenu apparaît dans l'entrée de journal de sortie en tant que valeur du libellé `agent.googleapis.com/log_file_path`. Lorsque vous utilisez un caractère générique, seul le chemin du fichier à partir duquel l'enregistrement a été obtenu est enregistré.
`type`		La valeur doit être égale à `couchdb`.
`wildcard_refresh_interval`	`60s`	Intervalle d'actualisation pour les chemins d'accès de fichiers utilisant des caractères génériques dans `include_paths`. Renseigné sous la forme d'une durée, par exemple, `30s` ou `2m`. Cette propriété peut s'avérer utile lorsque le débit de journalisation est élevé et que les fichiers journaux sont alternés plus rapidement que l'intervalle par défaut. La valeur doit être un multiple de 1 s.

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 couchdb contiennent les champs suivants dans LogEntry :

Champ	Type	Description
`httpRequest`	objet	Consultez `HTTPRequest`
`jsonPayload.host`	chaîne	Nom de l'instance hôte
`jsonPayload.level`	chaîne	Niveau de l'entrée de journal
`jsonPayload.message`	chaîne	Message du journal
`jsonPayload.node`	chaîne	Nom de l'instance de nœud
`jsonPayload.path`	chaîne	Chemin de requête
`jsonPayload.pid`	chaîne	ID du processus
`jsonPayload.remote_user`	chaîne	Nom d'utilisateur authentifié pour la requête
`jsonPayload.status_message`	chaîne	Message de code d'état
`severity`	chaîne (`LogSeverity`)	Niveau d'entrée de journal (traduit).

Les entrées de journal ne contiennent aucun champ vide ni manquant.

Configurer la collecte de métriques

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

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

Champ	Par défaut	Description
`collection_interval`	`60s`	Une valeur time.Duration, telle que `30s` ou `5m`.
`password`		Mot de passe utilisé pour se connecter au serveur.
`server_status_url`	`http://localhost:5984`	URL exposée par CouchDB.
`type`		La valeur doit être égale à `couchdb`.
`username`		Nom d'utilisateur utilisé pour se connecter au serveur.

Métriques surveillées

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

Type de métrique
Genre, type Ressources surveillées	Étiquettes
`workload.googleapis.com/couchdb.average_request_time`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/couchdb.database.open`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/couchdb.database.operations`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/couchdb.file_descriptor.open`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/couchdb.httpd.bulk_requests`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/couchdb.httpd.requests`
`CUMULATIVE`, `INT64` gce_instance	`http_method`
`workload.googleapis.com/couchdb.httpd.responses`
`CUMULATIVE`, `INT64` gce_instance	`http_status_code`
`workload.googleapis.com/couchdb.httpd.views`
`CUMULATIVE`, `INT64` gce_instance	`view`

Exemple de tableau de bord

Pour afficher vos métriques CouchDB, 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, qui contiennent 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 CouchDB. 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 CouchDB :

resource.type="gce_instance"
log_id("couchdb")

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/couchdb.database.open'
| every 1m

Étapes suivantes

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