MySQL

L'intégration MySQL collecte des 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 MySQL, consultez la page mysql.com.

Prérequis

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

Ce récepteur est compatible avec les versions 5.7 et 8.0 de MySQL.

Configurer l'instance MySQL

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

Configurer l'agent Ops pour MySQL

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 MySQL, 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 MySQL, et de redémarrer l'Agent Ops sous Linux.

# 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
      username: root
      password: Ss123%321
  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

Pour vous connecter à votre instance MySQL à 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 MySQL, vous devez créer des récepteurs pour les journaux produits par MySQL, 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.
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é.
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.
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é.
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.
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é.
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 MySQL, les journaux mysql_error peuvent contenir les champs suivants dans l'entrée 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 MySQL associé au journal
jsonPayload.subsystem chaîne Sous-système MySQL 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 MySQL, vous devez créer un récepteur pour les métriques MySQL, 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
type La valeur doit être égale à mysql.
endpoint localhost:3306 URL exposée par MySQL.
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 MySQL.

Type de métrique
Genre, type
Ressources surveillées
Libellés
workload.googleapis.com/mysql.buffer_pool_operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.buffer_pool_pages
GAUGEDOUBLE
gce_instance
kind
workload.googleapis.com/mysql.buffer_pool_size
GAUGEDOUBLE
gce_instance
kind
workload.googleapis.com/mysql.commands
CUMULATIVEINT64
gce_instance
command
workload.googleapis.com/mysql.double_writes
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.handlers
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.locks
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.log_operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.page_operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.row_locks
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.row_operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.sorts
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.threads
GAUGEDOUBLE
gce_instance
kind

Vérifier la configuration

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

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

  1. Dans le panneau de navigation de la console Google Cloud, sélectionnez Logging, puis Explorateur de journaux :

    Accéder à l'explorateur de journaux

  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 MySQL sont envoyées à Cloud Monitoring, procédez comme suit :

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

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

Afficher le tableau de bord

Pour afficher vos métriques MySQL, vous devez configurer un graphique ou un tableau de bord. L'intégration de MySQL 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 :

  1. Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis  Tableaux de bord :

    Accéder à la page Tableaux de bord

  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.

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 le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis  Intégrations :

    Accéder à la page Intégrations

  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.
  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. L'intégration de MySQL 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 :

  1. Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis  Intégrations :

    Accéder à la page Intégrations

  2. Recherchez l'entrée pour MySQL, puis cliquez sur Afficher les détails.
  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.

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