MariaDB

L'intégration MariaDB collecte les métriques de performances liées à InnoDB, au pool de mémoire tampon et à diverses autres opérations. Elle collecte également les journaux généraux, d'erreurs et de requêtes lentes, et les analyse dans une charge utile JSON. Les journaux d'erreurs sont analysés pour connaître leur code d'erreur et leur sous-système. Les journaux de requêtes lentes sont analysés en paires clé/valeur décrivant les performances d'une requête, y compris le temps de requête et les lignes examinées.

Pour plus d'informations sur MariaDB, consultez la documentation MariaDB.

Prérequis

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

  • Pour les métriques, installez la version 2.37.0 ou ultérieure.
  • Pour les journaux, installez la version 2.37.0 ou ultérieure.

Cette intégration est compatible avec les versions 10.1.X à 10.7.X de MariaDB.

Configurer l'instance MariaDB

MariaDB est une version dérivée du système de gestion de bases de données relationnelles (SGBDR) MySQL, développée par la communauté et distribuée commercialement. Pour collecter des journaux et des métriques pour MariaDB, utilisez les récepteurs mysql.

Le récepteur de métriques mysql se connecte par défaut à un serveur MariaDB local à l'aide d'un socket Unix et de l'authentification Unix en tant qu'utilisateur root.

Le récepteur de journalisation mysql_error collecte les journaux à partir des chemins de fichiers par défaut indiqués dans le tableau suivant. Sur certaines plates-formes, la journalisation MariaDB est effectuée par défaut sur journald plutôt que dans un fichier. Pour stipuler une journalisation MariaDB dans un fichier, définissez l'option log_error dans la configuration MariaDB. Pour en savoir plus sur la configuration de l'option log_error, consultez la page Écrire le journal d'erreurs dans un fichier.

Configurer l'agent Ops pour MariaDB

En suivant le guide de configuration de l'agent Ops, ajoutez les éléments requis pour collecter les journaux de vos instances MariaDB et redémarrez l'agent.

Exemple de configuration

Les commandes suivantes créent la configuration de collecte et d'ingestion de la télémétrie pour MariaDB et redémarrent 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:
    mysql:
      type: mysql
  service:
    pipelines:
      mysql:
        receivers:
        - mysql
logging:
  receivers:
    mysql_error:
      type: mysql_error
    mysql_general:
      type: mysql_general
    mysql_slow:
      type: mysql_slow
  service:
    pipelines:
      mysql:
        receivers:
          - mysql_error
          - mysql_general
          - mysql_slow
EOF

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

Configurer la collecte de journaux

Pour ingérer des journaux à partir de MariaDB, vous devez créer un récepteur pour les journaux produits par MariaDB, puis créer un pipeline pour le nouveau récepteur.

Pour configurer un récepteur pour vos journaux mysql_error, 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/mysqld.log, /var/log/mysql/mysqld.log, /var/log/mysql/error.log, /run/mysqld/mysqld.err, /var/lib/mysql/${HOSTNAME}.err] 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/mysql/*.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 mysql_error.
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.

Pour configurer un récepteur pour vos journaux mysql_general, 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/lib/mysql/${HOSTNAME}.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.
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 mysql_general.
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.

Pour configurer un récepteur pour vos journaux mysql_slow, 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/lib/mysql/${HOSTNAME}-slow.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.
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 mysql_slow.
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 mysql_error contiennent les champs suivants dans LogEntry :

Champ Type Description
jsonPayload.errorCode chaîne Code d'erreur MySQL associé au journal
jsonPayload.level chaîne Niveau de l'entrée de journal
jsonPayload.message chaîne Message du journal
jsonPayload.subsystem chaîne Sous-système MySQL d'où provient le journal
jsonPayload.tid nombre ID du thread d'où provient le journal
severity chaîne (LogSeverity) Niveau d'entrée de journal (traduit).

Les journaux mysql_general contiennent les champs suivants dans LogEntry :

Champ Type Description
jsonPayload.command chaîne Type d'action de base de données en cours de consignation
jsonPayload.message chaîne Journal de l'action de base de données
jsonPayload.tid nombre ID du thread d'où provient le journal
severity chaîne (LogSeverity) Niveau d'entrée de journal (traduit).

Les journaux mysql_slow contiennent les champs suivants dans LogEntry :

Champ Type Description
jsonPayload.bytesSent nombre Nombre d'octets envoyés à tous les clients
jsonPayload.createdTmpDiskTables  † nombre Nombre de tables temporaires sur disque internes créées par le serveur
jsonPayload.createdTmpTables  † nombre Nombre de tables temporaires internes créées par le serveur
jsonPayload.createdTmpTableSizes  † nombre Nombre d'octets utilisés par les tables temporaires internes créées par le serveur
jsonPayload.database chaîne Base de données où la requête a été exécutée
jsonPayload.filesort  † booléen L'instruction a utilisé le tri de fichiers
jsonPayload.filesortOnDisk  † booléen L'instruction a utilisé filesort, qui nécessitait des tables temporaires sur disque.
jsonPayload.fullJoin  † booléen L'instruction n'a pas utilisé d'index pour joindre des tables
jsonPayload.fullScan  † booléen L'instruction a utilisé une analyse complète de la table
jsonPayload.host chaîne Nom d'hôte à partir duquel le client s'est connecté
jsonPayload.ipAddress chaîne Adresse IP à partir de laquelle le client s'est connecté
jsonPayload.lockTime nombre Temps d'acquisition des verrous en secondes
jsonPayload.message chaîne Texte complet de la requête
jsonPayload.priorityQueue  † booléen L'instruction a utilisé un tri de fichiers de file d'attente de priorité
jsonPayload.queryCacheHit booléen L'instruction a été diffusée à partir du cache de requêtes
jsonPayload.queryTime nombre Temps d'exécution de l'instruction en secondes
jsonPayload.rowsAffected entier Nombre de lignes affectées par l'instruction
jsonPayload.rowsExamined nombre Nombre de lignes examinées par la couche serveur
jsonPayload.rowsSent nombre Nombre de lignes envoyées au client
jsonPayload.sortMergePasses  † nombre Nombre de tentatives de fusion que l'algorithme de tri a dû effectuer
jsonPayload.storedRoutine chaîne Nom de la routine stockée en cours d'exécution
jsonPayload.tid nombre ID du thread dans lequel la requête a été consignée
jsonPayload.user chaîne Utilisateur authentifié qui a exécuté la requête
severity chaîne (LogSeverity) Niveau d'entrée de journal (traduit).

† Ces champs ne sont fournis que si la variable système log_slow_verbosity contient 'query_plan'.

Configurer la collecte de métriques

Pour ingérer des métriques à partir de MariaDB, vous devez créer un récepteur pour les métriques produites par MariaDB, 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 mysql, spécifiez les champs suivants :

Champ Par défaut Description
collection_interval 60s Une valeur time duration, telle que 30s ou 5m.
endpoint /var/run/mysqld/mysqld.sock Chemin d'accès au socket hostname:port ou Unix commençant par / utilisé pour se connecter au serveur MariaDB.
password Mot de passe utilisé pour se connecter au serveur.
type Cette valeur doit être mysql.
username root 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 MariaDB.

Type de métrique
Genre, type
Ressources surveillées		 Étiquettes
workload.googleapis.com/mysql.buffer_pool_data_pages
GAUGE, INT64
gce_instance 		status
workload.googleapis.com/mysql.buffer_pool_limit
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mysql.buffer_pool_operations
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/mysql.buffer_pool_page_flushes
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/mysql.buffer_pool_pages
GAUGE, DOUBLE
gce_instance 		kind
workload.googleapis.com/mysql.buffer_pool_size
GAUGE, DOUBLE
gce_instance 		kind
workload.googleapis.com/mysql.commands
CUMULATIVE, INT64
gce_instance 		command
workload.googleapis.com/mysql.double_writes
CUMULATIVE, INT64
gce_instance 		kind
workload.googleapis.com/mysql.handlers
CUMULATIVE, INT64
gce_instance 		kind
workload.googleapis.com/mysql.locks
CUMULATIVE, INT64
gce_instance 		kind
workload.googleapis.com/mysql.log_operations
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/mysql.operations
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/mysql.page_operations
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/mysql.replica.sql_delay
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mysql.replica.time_behind_source
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mysql.row_locks
CUMULATIVE, INT64
gce_instance 		kind
workload.googleapis.com/mysql.row_operations
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/mysql.sorts
CUMULATIVE, INT64
gce_instance 		kind
workload.googleapis.com/mysql.threads
GAUGE, DOUBLE
gce_instance 		kind

Vérifier la configuration

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

Pour vérifier que les journaux MariaDB sont envoyés à Cloud Logging, procédez comme suit :

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

  2. Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :
    resource.type="gce_instance"
(log_id("mysql_error") OR log_id("mysql_general") OR log_id("mysql_slow"))

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

  1. Dans la console Google Cloud, accédez à la page 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 Monitoring.

  2. Dans la barre d'outils du volet de création de requêtes, sélectionnez le bouton nommé  MQL ou  PromQL.
  3. 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.
  4. Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :
    fetch gce_instance
| metric 'workload.googleapis.com/mysql.threads'
| every 1m

Afficher le tableau de bord

Pour afficher vos métriques MariaDB, vous devez configurer un graphique ou un tableau de bord. MariaDB utilise les mêmes tableaux de bord que MySQL. 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 :

  1. 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 Monitoring.

  2. Sélectionnez l'onglet Liste des tableaux de bord, puis choisissez la catégorie Intégrations.
  3. Cliquez sur le nom du tableau de bord que vous souhaitez afficher. MariaDB utilise les mêmes tableaux de bord que MySQL.

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 :

  1. 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 Monitoring.

  2. Cliquez sur le filtre de plate-forme de déploiement Compute Engine.
  3. Recherchez l'entrée pour MySQL, puis cliquez sur Afficher les détails. MariaDB utilise les mêmes tableaux de bord que MySQL.
  4. 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. MariaDB utilise les mêmes règles d'alerte que MySQL. 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 :

  1. 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 Monitoring.

  2. Recherchez l'entrée pour MySQL, puis cliquez sur Afficher les détails. MariaDB utilise les mêmes règles d'alerte que MySQL.
  3. Sélectionnez l'onglet Alertes. Cet onglet fournit une description des règles d'alerte disponibles et fournit une interface pour les installer.
  4. 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.

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