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.

Prérequis

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 un récepteur pour les métriques produites par CouchDB, puis créer un pipeline pour le nouveau récepteur.

Ce récepteur ne permet pas d'utiliser plusieurs instances dans la configuration, par exemple pour surveiller plusieurs points de terminaison. Toutes ces instances écrivent dans la même série temporelle, et Cloud Monitoring n'a aucun moyen de les distinguer.

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	Libellés
`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`

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 CouchDB sont envoyés à Cloud Logging, procédez comme suit:

Dans le panneau de navigation de la console Google Cloud, sélectionnez Logging, puis Explorateur de journaux :
Accéder à l'explorateur de journaux
Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :
```
resource.type="gce_instance"
log_id("couchdb")
```

Pour vérifier que les métriques CouchDB sont envoyées à Cloud Monitoring, procédez comme suit:

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Explorateur de métriques :
Accéder à l'explorateur de métriques
Dans la barre d'outils du volet de création de requêtes, sélectionnez le bouton dont le nom est MQL ou PromQL.
Vérifiez que MQL est sélectionné dans le bouton Langage. Le bouton de langage se trouve dans la barre d'outils qui vous permet de mettre en forme votre requête.

Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :

fetch gce_instance
| metric 'workload.googleapis.com/couchdb.database.open'
| every 1m

Afficher le tableau de bord

Pour afficher vos métriques CouchDB, vous devez configurer un graphique ou un tableau de bord. L'intégration CouchDB inclut un ou plusieurs tableaux de bord. Tous les tableaux de bord sont automatiquement installés après la configuration de l'intégration et que l'agent Ops a commencé à collecter des données de métriques.

Vous pouvez également afficher des aperçus statiques de tableaux de bord sans installer l'intégration.

Pour afficher un tableau de bord installé, procédez comme suit :

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Tableaux de bord :
Accéder à la page Tableaux de bord
Sélectionnez l'onglet Liste des tableaux de bord, puis choisissez la catégorie Intégrations.
Cliquez sur le nom du tableau de bord que vous souhaitez afficher.

Si vous avez configuré une intégration, mais que le tableau de bord n'a pas été installé, vérifiez que l'agent Ops est en cours d'exécution. Lorsqu'un graphique ne contient aucune donnée de métrique, l'installation du tableau de bord échoue. Une fois que l'agent Ops a commencé à collecter des métriques, le tableau de bord est installé.

Pour afficher un aperçu statique du tableau de bord, procédez comme suit :

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Intégrations :
Accéder à la page Intégrations
Cliquez sur le filtre de plate-forme de déploiement Compute Engine.
Recherchez l'entrée pour CouchDB, puis cliquez sur Afficher les détails.
Cliquez sur l'onglet Tableaux de bord pour afficher un aperçu statique. Si le tableau de bord est installé, vous pouvez y accéder en cliquant sur Afficher le tableau de bord.

Pour en savoir plus sur les tableaux de bord dans Cloud Monitoring, consultez la page Tableaux de bord et graphiques.

Pour en savoir plus sur l'utilisation de la page Intégrations, consultez la page Gérer les intégrations.

Installer des règles d'alerte

Les règles d'alerte indiquent à Cloud Monitoring de vous avertir lorsque des conditions spécifiées se produisent. L'intégration CouchDB inclut une ou plusieurs règles d'alerte. Vous pouvez afficher et installer ces règles d'alerte à partir de la page Intégrations dans Monitoring.

Pour afficher la description des règles d'alerte disponibles et les installer, procédez comme suit :

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Intégrations :
Accéder à la page Intégrations
Recherchez l'entrée pour CouchDB, puis cliquez sur Afficher les détails.
Sélectionnez l'onglet Alertes. Cet onglet fournit une description des règles d'alerte disponibles et fournit une interface pour les installer.
Installez les règles d'alerte. Les règles d'alerte doivent savoir où envoyer des notifications indiquant que l'alerte a été déclenchée. Elles nécessitent donc des informations de votre part pour l'installation. Pour installer des règles d'alerte, procédez comme suit :
1. Dans la liste des règles d'alerte disponibles, sélectionnez celles que vous souhaitez installer.
2. Dans la section Configurer les notifications, sélectionnez un ou plusieurs canaux de notification. Vous avez la possibilité de désactiver l'utilisation des canaux de notification. Toutefois, si vous le faites, vos règles d'alerte se déclenchent en mode silencieux. Vous pouvez vérifier leur état dans Monitoring, mais vous ne recevez aucune notification.
  
  Pour plus d'informations sur les canaux de notification, consultez la section Gérer les canaux de notification.
3. Cliquez sur Créer des règles.

Pour plus d'informations sur les règles d'alerte dans Cloud Monitoring, consultez la section Présentation des alertes.

Pour en savoir plus sur l'utilisation de la page Intégrations, consultez la page Gérer les intégrations.

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