Redis monitoring Intégration

Notre intégration Redis signale les données de performances critiques de votre serveur Redis aux produits New Relic. Vous pouvez afficher ces données métriques et ces données d'inventaire dans un dashboard prédéfini, créer une règle d'alerte et créer des requêtes et des graphiques personnalisés. Vous pouvez également spécifier les clés importantes pour votre application et obtenir des informations sur leur longueur.

Lisez la suite pour installer l’intégration et voir quelles données nous collectons.

Compatibilité et exigences

Notre intégration est compatible avec les versions Redis de 3.0 à 7.0.

Avant d’installer l’intégration, assurez-vous que vous répondez aux exigences suivantes :

Un compte New Relic. Vous n'en avez pas ? Inscrivez-vous gratuitement ! Aucune carte de crédit requise.
Si Redis ne s'exécute pas sur Kubernetes ou Amazon ECS, vous devez installer l'agent d'infrastructure sur un hôte de système d'exploitation Linux qui exécute Redis. Sinon:
- Si vous exécutez sur Kubernetes, consultez ces exigences.
- Si vous utilisez ECS, consultez ces exigences.

L'intégration obtient des données en exécutant des commandes Redis :

CommandeINFO : Les données de la commande INFO renseignent les données métriques et certaines données d'inventaire.
CommandeCONFIG GET : la plupart des données d’inventaire proviennent de cette commande.
- Dans les installations Redis gérées sans autorisations pour exécuter la commande CONFIG (par exemple, AWS ElastiCache), l'exécution de cette commande peut être désactivée avec l'option de configuration config_inventory: false .
Acquisition de la longueur de clé : Selon le type de clé, ces commandes sont utilisées :
- LLEN pour list
- SCARD pour set
- ZCOUNT pour zset
- HLEN pour le type hash .

Pour la collecte de données sur la longueur des clés, l'agent utilise le pipeline pour minimiser l'impact sur vos performances Redis. Cependant, si vous collectez la longueur de nombreuses clés, les performances de Redis peuvent être affectées. Pour cette raison, l'agent inclut une limite de clé par défaut (mais cette limite peut être écrasée).

Important

Si vous avez modifié les noms des commandes Redis mentionnées ci-dessus, l'intégration ne pourra pas récupérer les données Redis.

Démarrage rapide

instrumentez votre serveur Redis rapidement et envoyez vos données télémétriques avec installation guidée. Notre installation guidée crée une commande CLI personnalisée pour votre environnement qui télécharge et installe la CLI New Relic et l'agent d'infrastructure.

Prêt à commencer ? Cliquez sur l'un de ces boutons pour l'essayer.

Installation guidée

Guide d'installation de l'UE

Installer et activer

Pour installer l'intégration Redis, suivez les instructions correspondant à votre environnement :

Notes supplémentaires :

Advanced: intégration sont également disponibles au formattarball pour permettre une installation en dehors d'un gestionnaire de paquets.
On-host integrations do not automatically update. Pour de meilleurs résultats, mettez régulièrement à jour le package d'intégration et l'agent d'infrastructure.

' '

Installez l'agent d'infrastructure et remplacez la variable INTEGRATION_FILE_NAME par nri-redis.
Changez le répertoire vers le dossier configuration de l'intégration :
bash
```
$cd /etc/newrelic-infra/integrations.d
```
Copiez l’exemple de fichier de configuration :
bash
```
$sudo cp redis-config.yml.sample redis-config.yml
```
Modifiez le fichier redis-config.yml en fonction de vos méthodes de connexion au serveur Redis :
Si vous vous connectez en utilisant un socket Unix, spécifiez unix_socket_path dans le fichier de configuration. S'il existe plusieurs Redis instance utilisant des sockets Unix, assurez-vous de définir use_unix_socket sur true dans le configuration fichier .
Assurez-vous que l’utilisateur exécutant l’intégration Redis dispose des autorisations appropriées pour accéder à ce socket Unix. Les permissions du socket Unix sont définies dans la configuration Redis (valeur de unixsocketperm).
Si nécessaire, définissez d’autres paramètres de fichier configuration en fonction de votre configuration Redis , comme décrit dans la configuration.
Pour activer l'analyse automatique des erreurs Redis et logtransfert, copiez (ou renommez) le fichier redis-log.yml.example en redis-log.yml. Pas besoin de redémarrer l'agent.
Example:
bash
```
$sudo cp /etc/newrelic-infra/logging.d/redis-log.yml.example /etc/newrelic-infra/logging.d/redis-log.yml
```

Téléchargez l'image du programme d'installation nri-redis .MSI depuis :
https://download.newrelic.com/infrastructure_agent/windows/integrations/nri-redis/nri-redis-amd64.msi
Pour installer à partir de l’invite de commande Windows, exécutez :
bash
```
$msiexec.exe /qn /i PATH\TO\nri-redis-amd64.msi
```
ou double-cliquez sur le fichier dans l'Explorateur.
Dans le répertoire d’intégration, C:\Program Files\New Relic\newrelic-infra\integrations.d\, créez une copie du fichier configuration d’exemple en exécutant :
bash
```
$copy redis-win-config.yml.sample redis-win-config.yml
```
Modifiez le fichier redis-win-config.yml comme décrit dans les paramètres de configuration.

Ce document vous a-t-il aidé lors de votre installation ?

Créez un utilisateur New Relic pour votre serveur Redis

Si vous utilisez Redis 6+ et utilisez des listes de contrôle d'accès (ACL) pour contrôler l'accès à votre instance, vous souhaiterez peut-être créer un utilisateur newrelic pour l'intégration. Utilisez cette commande pour créer et accorder les autorisations requises à votre utilisateur :

bash

$ACL SETUSER newrelic on >'YOUR_SELECTED_PASSWORD' ~* +INFO +CONFIG|GET +SELECT +TYPE +LLEN +SCARD +ZCOUNT +HLEN

Configurer l'intégration

Il existe plusieurs façons de configurer l'intégration, selon la manière dont elle a été installée :

Si activé via Kubernetes: voir les services de monitoring exécutés sur Kubernetes.
Si activé via Amazon ECS : voir les services de monitoring exécutés sur ECS.
Si installé sur l'hôte : modifiez la configuration dans le fichier de configuration YAML de l'intégration redis-config.yml.

Utilisez la configuration YAML pour placer les informations de connexion requises et configurer la manière dont vos données sont collectées, en fonction de votre configuration et de vos préférences.

Le fichier configuration contient des paramètres communs applicables à toutes les intégrations, comme interval, timeout, inventory_source. Pour en savoir plus sur ces paramètres courants, consultez notre format de configuration YAML.

Important

Si vous utilisez toujours nos legacy fichiers configuration/définition, utilisez notre ancien format configuration standard.

Les paramètres spécifiques liés à Redis sont définis à l'aide de la section env du fichier de configuration. Ces paramètres contrôlent la connexion à votre Redis instance ainsi que d'autres paramètres et fonctionnalités de sécurité.

Paramètres de l'instance Redis

L'intégration Redis collecte à la fois les informations Métriques(M) et Inventaire(I). Dans le tableau, utilisez la colonne Applies To pour les paramètres disponibles pour chaque collection :

' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' '

Paramètre	Description	Défaut	S'applique à
`HOSTNAME`	Nom d'hôte du serveur Redis .	`localhost`	MI
`PORT`	Port sur lequel le serveur Redis écoute.	`6379`	MI
`USERNAME`	Nom d'utilisateur à utiliser lors de la connexion au serveur Redis. Utiliser uniquement avec Redis 6+ si ACL est activé.	N/A	MI
`PASSWORD`	Mot de passe à utiliser lors de la connexion au serveur Redis. Utiliser uniquement avec les serveurs Redis si `REQUIREPASS` ou ACL est activé.	N/A	MI
`UNIX_SOCKET_PATH`	Chemin vers le fichier de socket Unix sur lequel le serveur Redis écoute. Utilisez ceci à la place du nom d'hôte/Port.	N/A	MI
`USE_UNIX_SOCKET`	Définissez sur `true` pour identifier de manière unique l'entité du moniteur lors de l'utilisation de sockets Unix.	`false`	MI
`USE_TLS`	Utilisez TLS lors de la communication avec le serveur Redis.	`false`	MI
`TLS_INSECURE_SKIP_VERIFY`	Désactiver la vérification du nom du serveur lors de la connexion via TLS.	`false`	MI
`KEYS`	Liste des clés permettant de récupérer leurs longueurs.	N/A	M
`KEYS_LIMIT`	Nombre maximum de clés pour récupérer leurs longueurs.	`30`	M
`CONFIG_INVENTORY`	Définissez sur « false » dans les environnements où la commande Redis CONFIG n'est pas autorisée (par exemple, AWS ou ElastiCache).	`true`	je
`RENAMED_COMMANDS`	Mappez les commandes Redis par défaut à leur forme renommée.	N/A	MI
`REMOTE_MONITORING`	Activer monitoring multi-locataire.	`true`	MI
`METRICS`	Définissez sur `true` pour activer la collecte de métriques uniquement.	`false`
`INVENTORY`	Définissez sur `true` pour activer la collecte d'inventaire uniquement.	`false`

Les valeurs de ces paramètres peuvent être définies de plusieurs manières :

Ajoutez la valeur directement au fichier de configuration. C'est la manière la plus courante.
Remplacez les valeurs des variables d’environnement en utilisant la notation {{}} . Cela nécessite l'agent d'infrastructure 1.14.0+. Pour en savoir plus, consultez la rubrique « Plus d'informations sur les variables d'environnement de transfert de l'agent d'infrastructure ».
Utilisez la gestion des secrets pour protéger les informations sensibles, telles que les mots de passe, afin qu'elles ne soient pas exposées en texte brut dans le fichier de configuration. Pour plus d'informations, voir gestion des secrets.

Libellés et attribut personnalisé

Vous pouvez également décorer vos métriques avec des étiquettes. Les étiquettes vous permettent d'ajouter un attribut de paire valeur clé à vos métriques afin que vous puissiez interroger, filtrer ou regrouper vos métriques.

Même si notre fichier de configuration d'exemple par défaut inclut des exemples d'étiquettes, ils sont facultatifs. Vous pouvez en supprimer, en modifier ou en ajouter de nouveaux.

labels:
  env: production
  role: load_balancer

Exemple de configuration

Il s'agit de la configuration de base utilisée pour collecter les métriques et l'inventaire à partir de votre hôte local :

integrations:
  - name: nri-redis
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 6379
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      environment: production

  - name: nri-redis
    env:
      INVENTORY: true
      HOSTNAME: localhost
      PORT: 6379
      REMOTE_MONITORING: true
    interval: 60s
    labels:
      environment: production
    inventory_source: config/redis

Cette configuration se connecte à Redis à l'aide d'une authentification de base. Remplacez my_password par votre mot de passe REQUIREPASS :

integrations:
  - name: nri-redis
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 6379
      PASSWORD: "my_password"
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      environment: production

  - name: nri-redis
    env:
      INVENTORY: true
      HOSTNAME: localhost
      PORT: 6379
      PASSWORD: "my_password"
      REMOTE_MONITORING: true
    interval: 60s
    labels:
      environment: production
    inventory_source: config/redis

Dans Redis 6+, vous pouvez protéger votre instance avec des listes de contrôle d'accès (ACL). Pour les ACL, remplacez les valeurs USERNAME et PASSWORD par vos informations d'identification :

integrations:
  - name: nri-redis
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 6379
      USERNAME: my_user
      PASSWORD: "my_password"
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      environment: production

  - name: nri-redis
    env:
      INVENTORY: true
      HOSTNAME: localhost
      PORT: 6379
      USERNAME: my_user
      PASSWORD: "my_password"
      REMOTE_MONITORING: true
    interval: 60s
    labels:
      environment: production
    inventory_source: config/redis

Utiliser pour se connecter à Redis avec TLS. Vous pouvez ajouter TLS_INSECURE_SKIP_VERIFY : true pour désactiver la vérification du nom du serveur :

integrations:
  - name: nri-redis
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 6379
      USE_TLS: true
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      environment: production

Utilisé pour se connecter à Redis à l'aide d'un fichier socket. Il s'agit d'une alternative à une connexion TCP nom d'hôte/port :

integrations:
  - name: nri-redis
    env:
      METRICS: true
      UNIX_SOCKET_PATH: /var/run/redis/redis.sock
      USE_UNIX_SOCKET: true
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      environment: production

Utilisez ceci pour collecter vos métriques/inventaire si vous avez utilisé le rename-command pour protéger votre instance :

integrations:
  - name: nri-redis
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 6379
      RENAMED_COMMANDS: '{"CONFIG":"b840fc9f15f59e41cb7be6c52","LLEN":"c940fc2d15f59e41cb7be6c21"}'
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      environment: production

  - name: nri-redis
    env:
      INVENTORY: true
      HOSTNAME: localhost
      PORT: 6379
      RENAMED_COMMANDS: '{"CONFIG":"b840fc9f15f59e41cb7be6c52"}'
      REMOTE_MONITORING: true
    interval: 60s
    labels:
      environment: production
    inventory_source: config/redis

Utilisez ceci si vous devez collecter des métriques à partir de deux serveurs Redis différents à l'aide de la même intégration.

Le premier exemple instance collecte uniquement KEY_1 et KEY_2 à partir de la base de données Redis 0. Le deuxième exemple instance montre comment collecter à partir de différentes bases de données avec {"DB":"KEYS"}.

integrations:
  - name: nri-redis
    env:
      METRICS: true
      HOSTNAME: redis_host_1
      PORT: 6379
      KEYS: '["KEY_1","KEY_2"]'
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      environment: production

  - name: nri-redis
    env:
      METRICS: true
      HOSTNAME: redis_host_2
      PORT: 6379
      KEYS: '{"0":["KEY_1","KEY_2"],"1":["KEY_3"]}'
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      environment: production

Rechercher et utiliser des données

Les données de ce service sont signalées à un dashboard d'intégration.

Les métriques sont attachées aux types d'événement RedisSample et RedisKeyspaceSample . Vous pouvez interroger ces données à des fins de dépannage ou pour créer des graphiques et des dashboards personnalisés.

Pour en savoir plus sur la recherche et l’utilisation de vos données, consultez Comprendre les données d’intégration.

données métriques

L'intégration Redis collecte l'attribut de données métriques suivant :

Métriques d'échantillons Redis

Ces attributs sont attachés au type d'événement RedisSample :

Nom	Description
`cluster.connectedSlaves`	Nombre d'esclaves connectés.
`db.aofLastRewriteTimeInMilliseconds`	Durée de la dernière opération de réécriture AOF en millisecondes.
`db.aofLastBgrewriteStatus`	Booléen représentant l'état de la dernière opération de réécriture d'arrière-plan AOF.
`db.aofLastWriteStatus`	Booléen représentant l'état de la dernière opération d'écriture AOF.
`db.evictedKeysPerSecond`	Nombre de clés expulsées en raison de la limite de mémoire maximale par seconde.
`db.expiredKeysPerSecond`	Nombre d'événements d'expiration de clé par seconde.
`db.keyspaceHitsPerSecond`	Nombre de recherches réussies de clés dans le dictionnaire principal par seconde.
`db.keyspaceMissesPerSecond`	Nombre de recherches infructueuses de clés dans le dictionnaire principal par seconde.
`db.latestForkUsecMilliseconds`	Durée de la dernière opération de fork en millisecondes.
`db.rdbBgsaveInProgress`	Booléen. Un indicateur indiquant qu'une sauvegarde RDB est en cours.
`db.rdbChangesSinceLastSave`	Nombre de modifications depuis le dernier vidage.
`db.rdbLastBgsaveStatus`	Booléen représentant l'état de la dernière opération de sauvegarde RDB.
`db.rdbLastBgsaveTimeMilliseconds`	Durée de la dernière opération de sauvegarde RDB en millisecondes.
`db.rdbLastSaveTime`	Horodatage basé sur l'époque de la dernière sauvegarde RDB réussie en secondes.
`db.syncFull`	Compte du nombre de fois où les esclaves se sont entièrement synchronisés avec ce maître.
`db.syncPartialErr`	Nombre de fois où les synchronisations partielles n'ont pas abouti.
`db.syncPartialOk`	Compte du nombre de fois où les synchronisations partielles ont été terminées.
`net.blockedClients`	Nombre de clients en attente d'un appel bloquant (`BLPOP`, `BRPOP`, `BRPOPLPUSH`).
`net.clientBiggestInputBufBytes`	Le plus grand tampon d'entrée parmi les connexions client actuelles.
`net.clientLongestOutputList`	La liste de sortie la plus longue parmi les connexions client actuelles.
`net.commandsProcessedPerSecond`	Nombre de commandes traitées par le serveur par seconde.
`net.connectedClients`	Nombre de connexions client (hors connexions des esclaves).
`net.connectionsReceivedPerSecond`	Nombre de connexions acceptées par le serveur par seconde.
`net.inputBytesPerSecond`	Nombre total d'octets entrés par seconde.
`net.outputBytesPerSecond`	Nombre total d'octets générés par seconde.
`net.pubsubChannels`	Nombre global de canaux pub/sub avec abonnement client.
`net.pubsubPatterns`	Nombre global de modèles de publication/abonnement avec abonnements clients.
`net.rejectedConnectionsPerSecond`	Nombre de connexions par seconde rejetées en raison de la limite maxclients.
`software.uptimeMilliseconds`	Nombre de millisecondes depuis le démarrage du serveur Redis.
`system.memFragmentationRatio`	Rapport entre `used_memory_rss` et `used_memory`.
`system.totalSystemMemoryBytes`	La quantité de mémoire en octets disponible dans l'instance où Redis est en cours d'exécution.
`system.usedCpuSysMilliseconds`	CPU système consommé par le serveur Redis en millisecondes.
`system.usedCpuSysChildrenMilliseconds`	CPU système consommé par les processus d'arrière-plan en millisecondes.
`system.usedCpuUserMilliseconds`	CPU utilisateur consommé par le serveur Redis en millisecondes.
`system.usedCpuUserChildrenMilliseconds`	CPU utilisateur consommé par les processus d'arrière-plan en millisecondes.
`system.usedMemoryBytes`	Le nombre total d'octets alloués par Redis à l'aide de son allocateur (soit le standard `libc`, `jemalloc`, soit un allocateur alternatif tel que `tcmalloc`).
`system.usedMemoryLuaBytes`	Nombre d'octets utilisés par le moteur Lua.
`system.usedMemoryPeakBytes`	La mémoire maximale consommée par Redis en octets.
`system.usedMemoryRssBytes`	Nombre d'octets alloués par Redis tel que vu par le système d'exploitation (également appelé taille de l'ensemble résident). Il s’agit du nombre rapporté par des outils tels que `top(1)` et `ps(1)`.

espace clés métriques

L'intégration Redis collecte les métadonnées et les métriques d'espace clé suivantes. Ces attributs sont attachés au type d'événement RedisKeyspaceSample :

Nom	Description
`db.avgTtl`	La durée de vie moyenne (TTL) en millisecondes des clés dont la date d'expiration est définie dans la base de données faisant l'objet du rapport.
`db.keys`	Nombre de clés dans la base de données faisant l'objet du rapport.
`db.keyspace`	Index de la base de données Redis, qui est le nombre entier (généralement un nombre compris entre `0` et `15`). Format : `db` suivi de l'index de la base de données. Par exemple : `db0`, `db1`, `db2`, etc.
`db.expires`	Nombre de clés avec une expiration dans la base de données signalée.

Données d'inventaire

les données d'inventaire incluent tout ce qui est rapporté par la commande Redis CONFIG GET , à l'exception de requirepass, qui stocke le mot de passe du serveur Redis . Pour en savoir plus sur les données d’inventaire, voir Comprendre les données d’inventaire.

Autres données du système

L'intégration Redis collecte ces attributs supplémentaires sur votre service Redis :

Nom	Description
`software.version`	La version du serveur Redis. Exemple : `3.2.3`.
`cluster.role`	Soit `master` ou `slave,` selon le rôle du nœud Redis monitoré.

Vérifiez le code source

Cette intégration est un logiciel open source. Cela signifie que vous pouvez parcourir son code source et envoyer des améliorations, ou créer votre propre fork et le construire.

Cette traduction automatique est fournie pour votre commodité.

Compatibilité et exigences

Important

Démarrage rapide

Installer et activer

ECS

Kubernetes

Linux

Se connecter avec le socket Unix

Se connecter avec TCP

Windows

Ce document vous a-t-il aidé lors de votre installation ?

Créez un utilisateur New Relic pour votre serveur Redis

Configurer l'intégration

Important

Paramètres de l'instance Redis

Libellés et attribut personnalisé

Exemple de configuration

Configuration de base

Authentification de base

Authentification ACL REDIS 6+

Métriques uniquement avec connexion TLS

Connexion Métriques uniquement sur prise

Utilisation de commandes renommées

multi-instance monitoring avec filtrage des clés

Rechercher et utiliser des données

données métriques

Métriques d'échantillons Redis

espace clés métriques

Données d'inventaire

Autres données du système

Vérifiez le code source

Cette traduction automatique est fournie pour votre commodité.

Redis monitoring Intégration

Compatibilité et exigences .css-21sua1{background:none;border:none;width:0;padding:0;}

Important

Démarrage rapide

Installer et activer

Kubernetes

Linux

Windows

Ce document vous a-t-il aidé lors de votre installation ?

Créez un utilisateur New Relic pour votre serveur Redis

Configurer l'intégration

Important

Paramètres de l'instance Redis

Libellés et attribut personnalisé

Exemple de configuration

Configuration de base

Authentification de base

Authentification ACL REDIS 6+

Métriques uniquement avec connexion TLS

Connexion Métriques uniquement sur prise

Utilisation de commandes renommées

multi-instance monitoring avec filtrage des clés

Rechercher et utiliser des données

données métriques

Métriques d'échantillons Redis

espace clés métriques

Données d'inventaire

Autres données du système

Vérifiez le code source

Compatibilité et exigences