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 en savoir plus sur MariaDB, consultez la page mariadb.org.

Prérequis

Pour collecter les données de télémétrie MariaDB, vous devez installer l'agent Ops, version 2.8.0 ou ultérieure.

Ce récepteur 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 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.

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 et les métriques de vos instances MariaDB, puis redémarrez l'agent.

Exemple de configuration

La commande suivante crée le fichier de configuration permettant de collecter et d'ingérer des journaux et des métriques de MariaDB, et de redémarrer l'agent Ops sous Linux.

sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
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
metrics:
  receivers:
    mysql:
      type: mysql
  service:
    pipelines:
      mysql:
        receivers:
          - mysql
EOF
sudo service google-cloud-ops-agent restart

Pour vous connecter à votre instance MariaDB à l'aide d'une connexion TCP avec un nom d'utilisateur et un mot de passe, spécifiez le nom d'utilisateur et le mot de passe dans votre récepteur de métriques. Exemple :

metrics:
  receivers:
    mysql:
      type: mysql
      endpoint: localhost:3306
      password: pwd
      username: usr
  service:
    pipelines:
      mysql:
        receivers:
          - mysql

Configurer la collecte de journaux

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

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

Champ	Par défaut	Description
`type`		Cette valeur doit être `mysql_error`.
`include_paths`	`[/var/log/mysqld.log, /var/log/mysql/mysqld.log, /var/log/mysql/error.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/mysql/.log`.
`exclude_paths`	`[]`	Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à `include_paths`.
`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
`type`		Cette valeur doit être `mysql_general`.
`include_paths`	`[/var/lib/mysql/${HOSTNAME}.log]`	Fichiers journaux à lire
`exclude_paths`	`[]`	Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à `include_paths`.
`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
`type`		Cette valeur doit être `mysql_slow`.
`include_paths`	`[/var/lib/mysql/${HOSTNAME}-slow.log]`	Fichiers journaux à lire
`exclude_paths`	`[]`	Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à `include_paths`.
`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 logName des journaux mysql_error, mysql_general et mysql_slow est dérivé des ID de récepteur spécifiés dans la configuration.

Selon votre version de MariaDB, les journaux mysql_error peuvent contenir les champs suivants dans le LogEntry :

Champ	Type	Description
`jsonPayload.level`	chaîne	Niveau de l'entrée de journal
`jsonPayload.tid`	nombre	ID du thread d'où provient le journal
`jsonPayload.errorCode`	chaîne	Code d'erreur MariaDB associé au journal
`jsonPayload.subsystem`	chaîne	Sous-système MariaDB d'où provient le journal
`jsonPayload.message`	chaîne	Message du journal
`severity`	chaîne (`LogSeverity`)	Niveau d'entrée de journal (traduit)
`timestamp`	chaîne (`Timestamp`)	Heure de réception de la requête

Tous les champs vides ou manquants ne seront pas présents dans l'entrée de journal.

Les journaux
mysql_general contiennent les champs suivants dans LogEntry :

Champ	Type	Description
`jsonPayload.tid`	nombre	ID du thread d'où provient le journal
`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
`timestamp`	chaîne (`Timestamp`)	Heure à laquelle l'entrée a été consignée

Les journaux
mysql_slow contiennent les champs suivants dans LogEntry :

Champ	Type	Description
`jsonPayload.user`	chaîne	Utilisateur ayant exécuté la requête
`jsonPayload.database`	chaîne	Base de données où la requête a été exécutée
`jsonPayload.host`	chaîne	Hôte de l'instance de base de données
`jsonPayload.ipAddress`	chaîne	Adresse de l'instance de base de données
`jsonPayload.tid`	nombre	ID du thread dans lequel la requête a été consignée
`jsonPayload.queryTime`	nombre	Temps d'exécution de l'instruction en secondes
`jsonPayload.lockTime`	nombre	Temps d'acquisition des verrous en secondes
`jsonPayload.rowsSent`	nombre	Nombre de lignes envoyées au client
`jsonPayload.rowsExamined`	nombre	Nombre de lignes examinées par la couche serveur
`jsonPayload.errorNumber`^†	nombre	Numéro d'erreur de l'instruction, ou 0 si aucune erreur ne s'est produite
`jsonPayload.killed`^†	nombre	Si l'instruction a été interrompue, numéro d'erreur indiquant la raison, ou 0 si l'instruction s'est terminée normalement
`jsonPayload.bytesReceived`^†	nombre	Nombre d'octets reçus de tous les clients
`jsonPayload.bytesSent`^†	nombre	Nombre d'octets envoyés à tous les clients
`jsonPayload.readFirst`^†	nombre	Nombre de fois que la première entrée d'un index a été lue
`jsonPayload.readLast`^†	nombre	Nombre de requêtes de lecture de la dernière clé d'un index
`jsonPayload.readKey`^†	nombre	Nombre de requêtes de lecture d'une ligne basée sur une clé
`jsonPayload.readNext`^†	nombre	Nombre de requêtes de lecture de la ligne suivante par ordre de clé
`jsonPayload.readPrev`^†	nombre	Nombre de requêtes de lecture de la ligne précédente par ordre de clé
`jsonPayload.readRnd`^†	nombre	Nombre de requêtes de lecture d'une ligne basée sur une position fixe
`jsonPayload.readRndNext`^†	nombre	Nombre de requêtes de lecture de la ligne suivante dans le fichier de données
`jsonPayload.sortMergePasses`^†	nombre	Nombre de tentatives de fusion que l'algorithme de tri a dû effectuer
`jsonPayload.sortRangeCount`^†	nombre	Nombre de tris effectués à l'aide de plages
`jsonPayload.sortRows`^†	nombre	Nombre de lignes triées
`jsonPayload.sortScanCount`^†	nombre	Nombre de tris effectués en analysant la table
`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.startTime`^†	chaîne	Heure de début de l'exécution de l'instruction
`jsonPayload.endTime`^†	chaîne	Heure de fin de l'exécution de l'instruction
`jsonPayload.message`	chaîne	Texte complet de la requête
`timestamp`	chaîne (`Timestamp`)	Heure à laquelle l'entrée a été consignée

^† Ces champs ne sont fournis que si la variable système log_slow_extra est définie sur 'ON'. Cette variable est disponible à partir de MySQL 8.0.14.

Pour en savoir plus sur ces champs, consultez la documentation MySQL.

Configurer la collecte de métriques

Pour collecter des métriques à partir de MariaDB, vous devez créer un récepteur pour les métriques MariaDB, puis créer un pipeline pour le nouveau récepteur. Pour configurer un récepteur pour vos métriques MariaDB, spécifiez les champs suivants :

Champ	Par défaut	Description
`type`		La valeur doit être égale à `mysql`.
`endpoint`	`localhost:3306`	URL exposée par MariaDB.
`collection_interval`	`60s`	Une valeur time.Duration, telle que `30s` ou `5m`.
`username`	`root`	Nom d'utilisateur utilisé pour se connecter au serveur.
`password`		Mot de passe 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	Libellés
`workload.googleapis.com/mysql.buffer_pool_operations`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`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.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

Vous pouvez utiliser l'explorateur de journaux et l'explorateur de métriques pour vérifier que vous avez correctement configuré le récepteur MariaDB. La collecte des journaux et des métriques 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 MariaDB :

resource.type="gce_instance"
logName=("projects/PROJECT_ID/logs/mysql_error" OR "projects/PROJECT_ID/logs/mysql_general" OR "projects/PROJECT_ID/logs/mysql_slow")

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/mysql.commands'
| align rate(1m)
| 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).