Skip to main content
CacheMetricsService collects various metrics about Hazelcast cache, API Performance, JVM and System Health. These metrics are divided into the following categories:
  • Hazelcast cache statistics
  • API performance metrics
  • JVM
  • System Metrics

Prometheus Metric Types

Cache metrics are collected using four metric types of Prometheus. These types are designed to best represent different data types and behaviors. Each metric type serves different purposes depending on how you collect and analyze the data.

Counter

Counter is a value that only increases. It starts from zero when the application runs and increases, and is reset only when the application is restarted. Counter type metrics are ideal for tracking continuously increasing values such as total request count, error count, or number of completed operations.Available Operations:
  • sum: The total value itself
  • rate: Calculates the rate of increase over time (such as how much it increases per second)
  • increase: Calculates the total increase in a specific time range

Gauge

Gauge represents an instant value. This value can increase, decrease, or remain constant. Gauge type metrics are used to monitor an instant state or level such as current memory usage, instant CPU usage, or number of active threads.Available Operations:
  • sum: Sum of Gauge values grouped by labels
  • mean: Average of Gauge values grouped by labels
  • min/max: Minimum or maximum of values grouped by labels

Timer

Timer measures how long an operation takes (usually in milliseconds or seconds). Although technically not a special type in Prometheus, it is a metric created by libraries such as Micrometer with a combination of DistributionSummary and Counter. These metrics provide information such as average duration, maximum duration, and percentile slices.Available Operations:
  • sum: Gives the total duration
  • count: Gives how many times the operation was performed in total
  • mean: Calculates the average duration of the operation
  • max: Gives the longest duration observed
  • histogram_quantile: Calculates percentile slices

Summary

Summary is a metric that calculates both the total of observed values and predetermined percentile slices (quantiles). Its difference from Timer and DistributionSummary is that it collects percentile slices directly; since these are calculated when the metric is collected, not at query time, percentile slices are more accurate.Available Operations:
  • sum: Total of observed values
  • count: Number of observed values
  • Predetermined percentile slices (<metric_name>{quantile="0.99"})

Cache Metrics

These metrics monitor Cache’s cache performance. Cache searches, additions, and latencies are tracked to analyze efficiency. In addition, memory cost and distribution by partitions are measured.
MetricDescriptionType
cache_gets_totalTotal cache searches (hits and misses)Counter
cache_puts_totalTotal cache additionsCounter
cache_sizeCurrent number of entries in cacheGauge
cache_entriesNumber of entries per cache partitionGauge
cache_entry_memory_bytesMemory cost of cache entriesGauge
cache_gets_latency_secondsCache access latencySummary
cache_puts_latency_secondsCache addition latencySummary
cache_removals_latency_secondsCache removal latencySummary

API Metrics

These metrics monitor the performance of Cache’s APIs. API performance is evaluated with data such as request count, response time, and error rates.
MetricDescriptionType
apinizer_cache_api_requests_totalTotal API request countCounter
apinizer_cache_api_response_timeAPI response time (seconds)Timer
apinizer_cache_api_errors_totalTotal API error countCounter

JVM Metrics

These metrics monitor Cache’s memory and thread usage. JVM performance is analyzed with data such as memory usage, GC (Garbage Collection) pause durations, and active threads.
MetricDescriptionType
jvm_memory_used_bytesMemory usage by area (heap/non-heap)Gauge
jvm_memory_committed_bytesCommitted memory by areaGauge
jvm_memory_max_bytesMaximum memory by areaGauge
jvm_gc_pause_secondsGC pause durationSummary
jvm_threads_live_threadsCurrent number of live threadsGauge
jvm_threads_daemon_threadsCurrent number of daemon threadsGauge

System Metrics

These metrics monitor Cache’s general performance with data such as CPU usage, processor count, and load average. In addition, resource usage is evaluated with data such as process duration and number of open files.
MetricDescriptionType
system_cpu_usageCPU usage of main systemGauge
system_cpu_countNumber of available processorsGauge
system_load_average_1mSystem load average (1 minute)Gauge
process_cpu_usageCPU usage of JVM processGauge
process_uptime_secondsRuntime of JVM processGauge
process_files_open_filesNumber of open file descriptorsGauge