Redis Micrometer Registry

Redis Micrometer Registry is a Micrometer registry for sending metrics to Redis.

This registry can be used in any application that uses Micrometer for recording metrics.

Getting Started

Add micrometer-registry-redis to your application dependencies:

Maven

<dependency>
    <groupId>com.redis</groupId>
    <artifactId>micrometer-registry-redis</artifactId>
    <version>0.5.1</version>
</dependency>

Gradle

dependencies {
    implementation 'com.redis:micrometer-registry-redis:0.5.1'
}

Usage

RedisConfig config = new RedisConfig() { // (1)
  @Override
  public String get(String key) {
    return null;
  }

  @Override
  public String uri() {
    return "redis://example.redis.cloud:12000";
  }
};
MeterRegistry registry = new RedisMeterRegistry(config, Clock.SYSTEM); // (2)
Timer timer = registry.timer("mytimer"); // (3)
timer.record(() -> doSomeWork()); // (4)

1. Create a config object

2. Instantiate a MeterRegistry with the previously created config

3. Register a meter

4. Instrument a part of your application using the meter

Configuration

The following properties can be used to specify how the registry connects to Redis.

uri

• Type: string

• Required

Connect to a Redis Cluster.

Redis URI for your Redis instance, for example:

redis://example.redis.cloud:6379

See Lettuce’s URI syntax for all of the possible URI parameters you can use here.

cluster

• Type: boolean

• Default value: false

Connect to a Redis Cluster.

keyspace

• Type: string

• Default value: null (no keyspace prefix)

Prefix for all Redis keys used by Redis Micrometer Registry.