Monitoring the adapter

Prerequisite: See Gateway Application metrics for a generic overview on support of metrics in a Gateway Application

The adapter can expose metrics for monitoring runtime performance. This is not enabled by default and can be enabled in the configuration file under the global section, e.g.

"global": {
    "framework": {
        "metrics": {
            "enabled": true
        }
    }
}

There are two means of accessing metrics:

  1. using JMX

  2. by accessing its Prometheus metrics endpoint

Aside from the metrics exposed by Gateway Framework the adapter exposes three additional metrics.

Metric

Type

Purpose

redis.keyspace.events

Histogram

The number of keyspace events processed in a batch

diffusion.topics

Gauge

The current number of topics actively published

redis.replication.timer

Timer

The time taken to replicate a bundle of values to topics

The way each value is external presented will differ for both JMX and Prometheus, for example, these Prometheus values relate to diffusion.topics

# HELP diffusion_topics
# TYPE diffusion_topics gauge
diffusion_topics{app_id="redis-adapter-0",app_type="RedisAdapter",service="exampleRedisService",} 36.0

The following relate to redis.replication.timer s

# HELP redis_replication_timer_seconds_max
# TYPE redis_replication_timer_seconds_max gauge
redis_replication_timer_seconds_max{app_id="redis-adapter-0",app_type="RedisAdapter",service="exampleRedisService",} 0.0
# HELP redis_replication_timer_seconds
# TYPE redis_replication_timer_seconds summary
redis_replication_timer_seconds_count{app_id="redis-adapter-0",app_type="RedisAdapter",service="exampleRedisService",} 1.0
redis_replication_timer_seconds_sum{app_id="redis-adapter-0",app_type="RedisAdapter",service="exampleRedisService",} 0.05