Redis

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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

Prerequisites

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 les journaux de vos instances Redis et redémarrez l'agent.

Exemple de configuration

Les commandes suivantes créent la configuration permettant de collecter et d'ingérer la télémétrie pour Redis et redémarre 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 des récepteurs pour les journaux produits par Redis, puis créer un pipeline pour les nouveaux récepteurs.

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. Vous pouvez utiliser un caractère générique (*) dans les chemins (par 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. Indiquée sous la forme d'une durée parsable par time.ParseDuration, 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 des récepteurs pour les métriques produites par Redis, puis créer un pipeline pour les nouveaux récepteurs.

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
Libellés
workload.googleapis.com/redis.clients.blocked
GAUGEINT64
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
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/redis.connections.received
CUMULATIVEINT64
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
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/redis.keys.expired
CUMULATIVE, INT64
gce_instance
 
workload.googleapis.com/redis.keyspace.hits
CUMULATIVEINT64
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
GAUGEINT64
gce_instance
 
workload.googleapis.com/redis.memory.peak
GAUGE, INT64
gce_instance
 
workload.googleapis.com/redis.memory.rss
GAUGEINT64
gce_instance
 
workload.googleapis.com/redis.memory.used
GAUGE, INT64
gce_instance
 
workload.googleapis.com/redis.net.input
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/redis.net.output
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/redis.rdb.changes_since_last_save
GAUGEINT64
gce_instance
 
workload.googleapis.com/redis.replication.backlog_first_byte_offset
GAUGEINT64
gce_instance
 
workload.googleapis.com/redis.replication.offset
GAUGE, INT64
gce_instance
 
workload.googleapis.com/redis.slaves.connected
GAUGEINT64
gce_instance
 

Exemple de tableau de bord

Pour afficher vos métriques Redis, vous devez configurer un graphique ou un tableau de bord. Cloud Monitoring fournit une bibliothèque d'exemples de tableaux de bord pour les intégrations, contenant des graphiques préconfigurés. Pour en savoir plus sur l'installation de ces tableaux de bord, consultez la page Installer des exemples de tableaux de bord.

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 sont ingérés, accédez à l'explorateur de journaux et exécutez la requête suivante pour afficher les journaux Redis :

resource.type="gce_instance"
log_id("redis")

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/redis.clients.max_input_buffer'
| every 1m

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