L'intégration MongoDB collecte principalement des métriques de base de données, telles que le nombre d'opérations et d'objets, ainsi que l'utilisation des ressources. L'intégration collecte également les journaux et les analyse dans une charge utile JSON. Le résultat inclut des champs de contexte, de composant, de niveau et de message.
Pour plus d'informations sur MongoDB, consultez la documentation MongoDB.
Prérequis
Pour collecter les données de télémétrie MongoDB, vous devez installer l'agent Ops :
- Pour les métriques, installez la version 2.19.0 ou ultérieure.
- Pour les journaux, installez la version 2.10.0 ou ultérieure.
Cette intégration est compatible avec les versions 2.6, 3.x, 4.x, 5.0 et 6.0 de MongoDB.
Configurer l'agent Ops pour MongoDB
Suivez le guide Configurer l'agent un agent, ajoutez les éléments requis ; pour collecter la télémétrie à partir d'instances MongoDB redémarrez l'agent.
Exemple de configuration
Les commandes suivantes créent la configuration permettant de collecter et d'ingérer des données de télémétrie pour MongoDB et redémarrez l'agent Ops.
Configurer la collecte de journaux
Pour ingérer des journaux à partir de MongoDB, vous devez créer un récepteur pour les journaux produit par MongoDB, puis créer un pipeline pour le nouveau récepteur.
Pour configurer un récepteur pour vos journaux mongodb
, 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/mongodb/mongod.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/mongodb/*.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 |
Cette valeur doit être mongodb . |
|
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. |
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 mongodb
contiennent les champs suivants dans LogEntry
:
Champ | Type | Description |
---|---|---|
jsonPayload.attributes |
Objet (facultatif). | Objet contenant une ou plusieurs paires clé/valeur pour tous les attributs supplémentaires fournis. |
jsonPayload.component |
chaîne | Catégorisation du message de journal. Une liste complète est disponible dans la documentation MongoDB. |
jsonPayload.context |
chaîne | |
jsonPayload.ctx |
chaîne | Nom du thread émettant l'instruction de journalisation |
jsonPayload.id |
Nombre | ID journal |
jsonPayload.message |
chaîne | Message du journal |
jsonPayload.severity |
chaîne | Niveau de l'entrée de journal |
severity |
chaîne (LogSeverity ) |
Niveau d'entrée de journal (traduit). |
Configurer la collecte de métriques
Pour ingérer des métriques à partir de MongoDB, vous devez créer un récepteur pour les métriques produites par MongoDB, 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 mongodb
, spécifiez les champs suivants :
Champ | Par défaut | Description |
---|---|---|
ca_file |
Chemin d'accès au certificat CA. En tant que client, cela vérifie le certificat du serveur. Si ce champ est vide, le récepteur utilise l'autorité de certification racine du système. | |
cert_file |
Chemin d'accès au certificat TLS à utiliser pour les connexions mTLS requises. | |
collection_interval |
60s |
Une valeur time duration, telle que 30s ou 5m . |
endpoint |
localhost:27017 |
Nom d'hôte, adresse IP ou socket de domaine UNIX. Un port peut être spécifié, par exemple <hostname>:<port> . Si aucun port n'est spécifié, le port 27017 par défaut est utilisé. |
insecure |
true |
Indique si une connexion TLS sécurisée doit être utilisée. Si ce paramètre est défini sur false , TLS est activé. |
insecure_skip_verify |
false |
Indique si la validation du certificat doit être ignorée ou non. Si insecure est défini sur true , la valeur insecure_skip_verify n'est pas utilisée. |
key_file |
Chemin d'accès à la clé TLS à utiliser pour les connexions nécessitant mTLS, par exemple, la clé utilisée dans --tlsCertificateKeyFile . |
|
password |
Mot de passe pour l'authentification auprès de l'instance MongoDB. Obligatoire si username est défini. |
|
type |
Cette valeur doit être mongodb . |
|
username |
Nom d'utilisateur pour l'authentification auprès de l'instance MongoDB. Obligatoire si password est défini. |
Métriques surveillées
Le tableau suivant fournit la liste des métriques que l'agent Ops collecte à partir de l'instance MongoDB.
Type de métrique | |
---|---|
Genre, type Ressources surveillées |
Étiquettes |
workload.googleapis.com/mongodb.cache.operations
|
|
CUMULATIVE , INT64 gce_instance |
type
|
workload.googleapis.com/mongodb.collection.count
|
|
GAUGE , INT64 gce_instance |
database
|
workload.googleapis.com/mongodb.connection.count
|
|
GAUGE , INT64 gce_instance |
database type
|
workload.googleapis.com/mongodb.cursor.count
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/mongodb.cursor.timeout.count
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/mongodb.data.size
|
|
GAUGE , INT64 gce_instance |
database
|
workload.googleapis.com/mongodb.database.count
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/mongodb.document.operation.count
|
|
GAUGE , INT64 gce_instance |
database operation
|
workload.googleapis.com/mongodb.global_lock.time
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/mongodb.index.access.count
|
|
GAUGE , INT64 gce_instance |
collection database
|
workload.googleapis.com/mongodb.index.count
|
|
GAUGE , INT64 gce_instance |
database
|
workload.googleapis.com/mongodb.index.size
|
|
GAUGE , INT64 gce_instance |
database
|
workload.googleapis.com/mongodb.memory.usage
|
|
GAUGE , INT64 gce_instance |
database type
|
workload.googleapis.com/mongodb.network.io.receive
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/mongodb.network.io.transmit
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/mongodb.network.request.count
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/mongodb.object.count
|
|
GAUGE , INT64 gce_instance |
database
|
workload.googleapis.com/mongodb.operation.count
|
|
CUMULATIVE , INT64 gce_instance |
operation
|
workload.googleapis.com/mongodb.operation.time
|
|
CUMULATIVE , INT64 gce_instance |
operation
|
workload.googleapis.com/mongodb.session.count
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/mongodb.storage.size
|
|
CUMULATIVE , INT64 gce_instance |
database
|
Vérifier la configuration
Cette section explique comment vérifier que vous avez bien configuré le récepteur MongoDB. La collecte de la télémétrie par l'agent Ops peut prendre une ou deux minutes.
Pour vérifier que les journaux MongoDB sont envoyés à Cloud Logging, procédez comme suit :
-
Dans la console Google Cloud, accédez à la page Explorateur de journaux.
Accéder à l'explorateur de journaux
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.
- Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :
resource.type="gce_instance" log_id("mongodb")
Pour vérifier que les métriques MongoDB sont envoyées à Cloud Monitoring, procédez comme suit :
-
Dans la console Google Cloud, accédez à la page leaderboard Explorateur de métriques :
Accéder à l'explorateur de métriques
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Surveillance.
- Dans la barre d'outils du volet de création de requêtes, sélectionnez le bouton nommé code MQL ou code PromQL.
- Vérifiez que MQL est sélectionné dans le bouton d'activation 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/mongodb.memory.usage' | every 1m
Afficher le tableau de bord
Pour afficher vos métriques MongoDB, vous devez configurer un graphique ou un tableau de bord. L'intégration MongoDB 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 la console Google Cloud, accédez à la page Tableaux de bord
.
Accéder à la page Tableaux de bord
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Surveillance.
- 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 la console Google Cloud, accédez à la page Intégrations
:
Accéder à la page Intégrations
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Surveillance.
- Cliquez sur le filtre de plate-forme de déploiement Compute Engine.
- Recherchez l'entrée pour MongoDB et 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 MongoDB 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 la console Google Cloud, accédez à la page Intégrations
:
Accéder à la page Intégrations
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Surveillance.
- Recherchez l'entrée pour MongoDB et 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 :
- Dans la liste des règles d'alerte disponibles, sélectionnez celles que vous souhaitez installer.
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.
- 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.
É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).