RedisEnterprise

Supported OS Linux Mac OS Windows

Intégrationv1.1.1

img

Présentation

Cette intégration permet de surveiller Redis Enterprise et d’exploiter les métriques associées dans Datadog.

En quoi consiste Redis Enterprise ?

Redis Enterprise est une version pour entreprise de Redis entièrement prise en charge. Outre toutes les fonctionnalités open source de base de Redis, Redit Enterprise propose une distribution géographique active/active, des fonctionnalités de base de données multimodèle, des capacités d’observabilité accrues et une gestion simplifiée pour les déploiements avec plusieurs locataires. Cette solution vous aide ainsi à gagner en disponibilité.

Dashboard Datadog pour Redis Enterprise

L’intégration Datadog/Redis Enterprise vous permet de bénéficier d’un modèle de vue représentant tous vos clusters et bases de données. Cette vue vous permet de consulter des informations opérationnelles uniquement disponibles avec cette intégration. Vous maîtrisez ainsi mieux vos tendances d’utilisation et pouvez plus facilement planifier votre croissance, en prenant des décisions informées à partir de ces données essentielles.

Vue d’ensemble de Datadog

overview

Vue d’ensemble des clusters

overview

Redis on Flash

rofdash

Redis actif/actif

rofdash

Événements Redis Enterprise

événements

Fournisseur

fournisseur

Cette intégration est fournie par Redis Labs.

Configuration

Installation

Si vous utilisez la version 7.21/6.21 ou une version ultérieure de l’Agent, suivez les instructions ci-dessous pour installer le check Redis Enterprise sur votre host. Consultez le guide relatif à l’installation d’intégrations développées par la communauté pour installer des checks avec une version < 7.21/6.21 de l’Agent ou avec l’Agent Docker :

  1. Téléchargez et lancez l’Agent Datadog.

  2. Exécutez la commande suivante pour installer le wheel de l’intégration à l’aide de l’Agent :

    datadog-agent integration install -t datadog-redisenterprise==<INTEGRATION_VERSION>
    

Vous trouverez la dernière version sur la page des versions des intégrations Datadog.

Remarque : si besoin, ajoutez sudo -u dd-agent en tant que préfixe dans la commande d’installation.

  1. Configurez votre intégration comme n’importe quelle autre intégration du package.

Configuration

Copiez l’exemple de configuration et modifiez les sections requises afin de recueillir des données à partir de votre cluster Redis Enterprise.

    ## @param host - chaîne, obligatoire
    ## Le host Redis Enterprise
    #
    host: myrediscluster.example.com

    ## @param port - nombre entier, facultatif, valeur par défaut : 9443
    #
    port: 9443

    ## @param user - chaîne, obligatoire
    ## L'utilisateur de l'API Redis Enterprise
    #
    username: redisadmin@example.com

    ## @param password - chaîne, obligatoire
    ## L'identifiant de l'API Redis Enterprise
    #
    password: mySecretPassword

Consultez le fichier d’exemple complet pour découvrir d’autres paramètres facultatifs vous permettant de vous aligner sur la configuration de votre cluster.

Pour configurer les utilisateurs, référez-vous à la documentation Redis (en anglais).

Données collectées

Métriques

redisenterprise.avg_latency
(gauge)
Number of seconds from when request hits proxy until results are returned
Shown as microsecond
redisenterprise.avg_latency_max
(gauge)
Maximum number of seconds from when request hits proxy until results are returned
Shown as microsecond
redisenterprise.avg_read_latency
(gauge)
Number of seconds from when a read request hits proxy until results are returned
Shown as microsecond
redisenterprise.avg_other_latency
(gauge)
Number of seconds from when other request hits proxy until results are returned
Shown as microsecond
redisenterprise.avg_write_latency
(gauge)
Number of seconds from when a write request hits proxy until results are returned
Shown as microsecond
redisenterprise.cache_hit_rate
(gauge)
Percentage of hits in the cache
Shown as percent
redisenterprise.conns
(gauge)
Number of clients currently connected to the database
Shown as item
redisenterprise.egress_bytes
(gauge)
Amount of network traffic sent by the database
Shown as byte
redisenterprise.endpoints
(gauge)
Number of proxy endpoints
Shown as item
redisenterprise.evicted_objects
(gauge)
Number of items evicted from the cache
Shown as item
redisenterprise.expired_objects
(gauge)
Number of items expired from the cache
Shown as item
redisenterprise.fork_cpu_system
(gauge)
% cores utilization in system mode for all redis shard fork child processes of this database
Shown as percent
redisenterprise.ingress_bytes
(gauge)
Amount of network traffic received by the database
Shown as byte
redisenterprise.listener_acc_latency
(gauge)
Accumulative latency of all types of commands on DB
Shown as second
redisenterprise.main_thread_cpu_system
(gauge)
% cores utilization in system mode for all redis shard main threas of this database
Shown as percent
redisenterprise.main_thread_cpu_system_max
(gauge)
Highest value of % cores utilization in system mode for all redis shard main threas of this database
Shown as percent
redisenterprise.memory_limit
(gauge)
Number of bytes allocated to this database
Shown as byte
redisenterprise.no_of_keys
(gauge)
Number of keys in the database
Shown as item
redisenterprise.other_req
(gauge)
Rate of other (non read/write) requests on DB (ops/sec) ie: PING, ECHO etc
Shown as operation
redisenterprise.read_req
(gauge)
Rate of read requests on DB (ops/sec)
Shown as operation
redisenterprise.read_hits
(gauge)
Rate of read hit requests on DB (ops/sec)
Shown as operation
redisenterprise.read_misses
(gauge)
Rate of read misses requests on DB (ops/sec)
Shown as operation
redisenterprise.shard_cpu_system
(gauge)
% cores utilization in system mode for all redis shard processes of this database
Shown as percent
redisenterprise.shard_cpu_system_max
(gauge)
Highest Value of % cores utilization in system mode for all redis shard processes of this database
Shown as percent
redisenterprise.total_req
(gauge)
Rate of all requests on DB (ops/sec)
Shown as operation
redisenterprise.total_req_max
(gauge)
Highest value of rate of all requests on DB (ops/sec)
Shown as operation
redisenterprise.used_memory
(gauge)
Amount of memory in use for the database
Shown as byte
redisenterprise.used_memory_percent
(gauge)
Percentage of memory used by the database
Shown as percent
redisenterprise.write_req
(gauge)
Rate of write requests on DB (ops/sec)
Shown as operation
redisenterprise.write_hits
(gauge)
Rate of write hit requests on DB (ops/sec)
Shown as operation
redisenterprise.write_misses
(gauge)
Rate of write misses requests on DB (ops/sec)
Shown as operation
redisenterprise.bigstore_objs_ram
(gauge)
Number of items stored in RAM only when Redis on Flash Enabled
Shown as item
redisenterprise.bigstore_objs_flash
(gauge)
Number of items stored on Flash only when Redis on Flash Enabled
Shown as item
redisenterprise.bigstore_objs_percent
(gauge)
Percentage items stored on Flash only when Redis on Flash Enabled
Shown as percent
redisenterprise.bigstore_io_reads
(gauge)
Rate of read requests on Redis on Flash Device (ops/sec)
Shown as operation
redisenterprise.bigstore_io_writes
(gauge)
Rate of write requests on Redis on Flash Device (ops/sec)
Shown as operation
redisenterprise.bigstore_throughput
(gauge)
Throughput for Redis on Flash for items stored on Flash Device
Shown as byte
redisenterprise.big_write_ram
(gauge)
Rate for Redis on Flash where items are written to RAM (ops/sec)
Shown as operation
redisenterprise.big_write_flash
(gauge)
Rate for Redis on Flash where items are written to Flash (ops/sec)
Shown as operation
redisenterprise.big_del_ram
(gauge)
Rate for Redis on Flash where items are deleted from RAM (ops/sec)
Shown as operation
redisenterprise.big_del_flash
(gauge)
Rate for Redis on Flash where items are deleted from Flash (ops/sec)
Shown as operation
redisenterprise.total_shards_used
(gauge)
Number of shards in use by the Redis Enterprise Cluster
Shown as item
redisenterprise.license_shards
(gauge)
Number of shards licensed to the Redis Enterprise Cluster
Shown as item
redisenterprise.license_days
(gauge)
Number of days remaining on the license of the Redis Enterprise Cluster
Shown as item
redisenterprise.total_node_cores
(gauge)
Number of CPU cores in the Redis Enterprise Cluster
Shown as item
redisenterprise.total_node_memory
(gauge)
Byte of memory in the Redis Enterprise Cluster
Shown as byte
redisenterprise.total_node_count
(gauge)
Number of nodes in the Redis Enterprise Cluster
Shown as item
redisenterprise.total_active_nodes
(gauge)
Number of active nodes in the Redis Enterprise Cluster
Shown as item
redisenterprise.crdt_egress_bytes
(gauge)
The bytes being sent to the CRDT peer
Shown as byte
redisenterprise.crdt_egress_bytes_decompressed
(gauge)
The decompressed bytes being sent to the CRDT peer
Shown as byte
redisenterprise.crdt_ingress_bytes
(gauge)
The bytes being received from the CRDT peer
Shown as byte
redisenterprise.crdt_ingress_bytes_decompressed
(gauge)
The decompressed bytes being received from the CRDT peer
Shown as byte
redisenterprise.crdt_local_lag
(gauge)
The local lag in the CRDT applies
Shown as second
redisenterprise.crdt_pending_max
(gauge)
The local pending writes in the CRDT max
Shown as item
redisenterprise.crdt_pending_min
(gauge)
The local pending writes in the CRDT min
Shown as item

Checks de service

redisenterprise.running

Le check renvoie :

  • OK si l’API du cluster Redis Enterprise répond correctement aux commandes
  • CRITICAL si l’API ne répond pas comme elle devrait

redisenterprise.license_check

Le check renvoie :

  • OK si la licence du cluster est valide pendant plus d’une semaine
  • WARNING si la licence du cluster expire dans moins de sept jours
  • CRITICAL si la licence du cluster a expiré

Remarque : si la licence expire, le cluster continue à fonctionner normalement. Toutefois, vous ne pourrez plus modifier sa configuration. Contactez votre représentant commercial pour renouveler votre licence.

Événements

Tous les événements Redis Enterprise sont recueillis.

Dépannage

Contactez l’équipe d’ingénierie sur site Redis.