Skip to content

[prometheus-metrics-instrumentation-caffeine] implement getPrometheus… #1206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zeitlinger merged 1 commit into from
Nov 21, 2024
Merged

[prometheus-metrics-instrumentation-caffeine] implement getPrometheus… #1206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 38 additions & 9 deletions ...e/src/main/java/io/prometheus/metrics/instrumentation/caffeine/CacheMetricsCollector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,30 @@
public class CacheMetricsCollector implements MultiCollector {
private static final double NANOSECONDS_PER_SECOND = 1_000_000_000.0;

private static final String METRIC_NAME_CACHE_HIT = "caffeine_cache_hit";
private static final String METRIC_NAME_CACHE_MISS = "caffeine_cache_miss";
private static final String METRIC_NAME_CACHE_REQUESTS = "caffeine_cache_requests";
private static final String METRIC_NAME_CACHE_EVICTION = "caffeine_cache_eviction";
private static final String METRIC_NAME_CACHE_EVICTION_WEIGHT = "caffeine_cache_eviction_weight";
private static final String METRIC_NAME_CACHE_LOAD_FAILURE = "caffeine_cache_load_failure";
private static final String METRIC_NAME_CACHE_LOADS = "caffeine_cache_loads";
private static final String METRIC_NAME_CACHE_ESTIMATED_SIZE = "caffeine_cache_estimated_size";
private static final String METRIC_NAME_CACHE_LOAD_DURATION_SECONDS =
"caffeine_cache_load_duration_seconds";

private static final List<String> ALL_METRIC_NAMES =
Collections.unmodifiableList(
Arrays.asList(
METRIC_NAME_CACHE_HIT,
METRIC_NAME_CACHE_MISS,
METRIC_NAME_CACHE_REQUESTS,
METRIC_NAME_CACHE_EVICTION,
METRIC_NAME_CACHE_EVICTION_WEIGHT,
METRIC_NAME_CACHE_LOAD_FAILURE,
METRIC_NAME_CACHE_LOADS,
METRIC_NAME_CACHE_ESTIMATED_SIZE,
METRIC_NAME_CACHE_LOAD_DURATION_SECONDS));

protected final ConcurrentMap<String, Cache<?, ?>> children = new ConcurrentHashMap<>();

/**
Expand Down Expand Up @@ -107,40 +131,40 @@ public MetricSnapshots collect() {
final List<String> labelNames = Arrays.asList("cache");

final CounterSnapshot.Builder cacheHitTotal =
CounterSnapshot.builder().name("caffeine_cache_hit").help("Cache hit totals");
CounterSnapshot.builder().name(METRIC_NAME_CACHE_HIT).help("Cache hit totals");

final CounterSnapshot.Builder cacheMissTotal =
CounterSnapshot.builder().name("caffeine_cache_miss").help("Cache miss totals");
CounterSnapshot.builder().name(METRIC_NAME_CACHE_MISS).help("Cache miss totals");

final CounterSnapshot.Builder cacheRequestsTotal =
CounterSnapshot.builder()
.name("caffeine_cache_requests")
.name(METRIC_NAME_CACHE_REQUESTS)
.help("Cache request totals, hits + misses");

final CounterSnapshot.Builder cacheEvictionTotal =
CounterSnapshot.builder()
.name("caffeine_cache_eviction")
.name(METRIC_NAME_CACHE_EVICTION)
.help("Cache eviction totals, doesn't include manually removed entries");

final GaugeSnapshot.Builder cacheEvictionWeight =
GaugeSnapshot.builder()
.name("caffeine_cache_eviction_weight")
.name(METRIC_NAME_CACHE_EVICTION_WEIGHT)
.help("Cache eviction weight");

final CounterSnapshot.Builder cacheLoadFailure =
CounterSnapshot.builder().name("caffeine_cache_load_failure").help("Cache load failures");
CounterSnapshot.builder().name(METRIC_NAME_CACHE_LOAD_FAILURE).help("Cache load failures");

final CounterSnapshot.Builder cacheLoadTotal =
CounterSnapshot.builder()
.name("caffeine_cache_loads")
.name(METRIC_NAME_CACHE_LOADS)
.help("Cache loads: both success and failures");

final GaugeSnapshot.Builder cacheSize =
GaugeSnapshot.builder().name("caffeine_cache_estimated_size").help("Estimated cache size");
GaugeSnapshot.builder().name(METRIC_NAME_CACHE_ESTIMATED_SIZE).help("Estimated cache size");

final SummarySnapshot.Builder cacheLoadSummary =
SummarySnapshot.builder()
.name("caffeine_cache_load_duration_seconds")
.name(METRIC_NAME_CACHE_LOAD_DURATION_SECONDS)
.help("Cache load duration: both success and failures");

for (final Map.Entry<String, Cache<?, ?>> c : children.entrySet()) {
Expand Down Expand Up @@ -223,4 +247,9 @@ public MetricSnapshots collect() {
.metricSnapshot(cacheLoadSummary.build())
.build();
}

@Override
public List<String> getPrometheusNames() {
return ALL_METRIC_NAMES;
}
}
30 changes: 30 additions & 0 deletions ...c/test/java/io/prometheus/metrics/instrumentation/caffeine/CacheMetricsCollectorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@
import io.prometheus.metrics.model.snapshots.CounterSnapshot;
import io.prometheus.metrics.model.snapshots.DataPointSnapshot;
import io.prometheus.metrics.model.snapshots.Labels;
import io.prometheus.metrics.model.snapshots.MetricSnapshots;
import io.prometheus.metrics.model.snapshots.SummarySnapshot;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.charset.StandardCharsets;
import java.util.List;
import org.junit.jupiter.api.Test;

@SuppressWarnings("CheckReturnValue")
Expand Down Expand Up @@ -115,6 +117,34 @@ public void loadingCacheExposesMetricsForLoadsAndExceptions() throws Exception {
assertThat(loadDuration.getSum()).isGreaterThan(0);
}

@Test
public void getPrometheusNamesHasSameSizeAsMetricSizeWhenScraping() {
final CacheMetricsCollector collector = new CacheMetricsCollector();

final PrometheusRegistry registry = new PrometheusRegistry();
registry.register(collector);

final MetricSnapshots metricSnapshots = registry.scrape();
final List<String> prometheusNames = collector.getPrometheusNames();

assertThat(prometheusNames).hasSize(metricSnapshots.size());
}

@Test
public void collectedMetricNamesAreKnownPrometheusNames() {
final CacheMetricsCollector collector = new CacheMetricsCollector();

final PrometheusRegistry registry = new PrometheusRegistry();
registry.register(collector);

final MetricSnapshots metricSnapshots = registry.scrape();
final List<String> prometheusNames = collector.getPrometheusNames();

metricSnapshots.forEach(
metricSnapshot ->
assertThat(prometheusNames).contains(metricSnapshot.getMetadata().getPrometheusName()));
}

private void assertCounterMetric(
PrometheusRegistry registry, String name, String cacheName, double value) {
final CounterSnapshot.CounterDataPointSnapshot dataPointSnapshot =
Expand Down