Redis

L'intégration Redis collecte des métriques liées aux performances et à l'utilisation. Les métriques de performances sont axées sur le processeur, la mémoire et le débit du réseau, tandis que les métriques d'utilisation se concentrent sur les clés, les commandes et la réplication. L'intégration collecte également les journaux Redis et les analyse dans une charge utile JSON. Au cours de ce processus, les symboles de rôle et de niveau sont transformés dans un format lisible.

Pour en savoir plus sur Redis, consultez la documentation Redis.

Prérequis

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

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

Cette intégration est compatible avec Redis version 6.2.

Configurer l'agent Ops pour Redis

En suivant le guide de configuration de l'agent Ops, ajoutez les éléments requis pour collecter la télémétrie des instances Redis 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 Redis 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:
    redis:
      type: redis
  service:
    pipelines:
      redis:
        receivers:
        - redis
logging:
  receivers:
    redis:
      type: redis
  service:
    pipelines:
      redis:
        receivers:
        - redis
EOF

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

Configurer la collecte de journaux

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

Pour configurer un récepteur pour vos journaux redis, 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/redis/redis-server.log, /var/log/redis_6379.log, /var/log/redis/redis.log, /var/log/redis/default.log, /var/log/redis/redis_6379.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/redis/*.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 redis.
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 redis contiennent les champs suivants dans LogEntry :

Champ Type Description
jsonPayload.level chaîne Niveau de l'entrée de journal
jsonPayload.message chaîne Message de journal, y compris la trace détaillée de la pile, le cas échéant
jsonPayload.pid nombre ID du processus émettant le journal.
jsonPayload.role chaîne Traduit du caractère de rôle redis (sentinel, RDB/AOF_writing_child, esclave, maître)
jsonPayload.roleChar chaîne Caractère de rôle Redis (X, C, S, M)
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 Redis, vous devez créer un récepteur pour les métriques produites par Redis, 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 redis, spécifiez les champs suivants :

Champ Par défaut Description
address localhost:6379 URL exposée par Redis.
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.
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 mTLS requises.
password Mot de passe utilisé pour se connecter au serveur.
type Cette valeur doit être redis.

Métriques surveillées

Le tableau suivant fournit la liste des métriques que l'agent Ops collecte à partir de l'instance Redis.

Type de métrique
Genre, type
Ressources surveillées		 Étiquettes
workload.googleapis.com/redis.clients.blocked
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.clients.connected
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.clients.max_input_buffer
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.clients.max_output_buffer
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.commands.processed
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.connections.received
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.connections.rejected
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.cpu.time
CUMULATIVE, DOUBLE
gce_instance 		state
workload.googleapis.com/redis.keys.evicted
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.keys.expired
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.keyspace.hits
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.keyspace.misses
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.latest_fork
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.memory.fragmentation_ratio
GAUGE, DOUBLE
gce_instance 		 
workload.googleapis.com/redis.memory.lua
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.memory.peak
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.memory.rss
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.memory.used
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.net.input
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.net.output
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.rdb.changes_since_last_save
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.replication.backlog_first_byte_offset
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.replication.offset
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.slaves.connected
GAUGE, INT64
gce_instance 		 

Vérifier la configuration

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

Pour vérifier que les journaux Redis 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("redis")

Pour vérifier que les métriques Redis 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/redis.clients.max_input_buffer'
| every 1m

Afficher le tableau de bord

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

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 Redis et 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 Redis 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 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 Redis et 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.

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