-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial Caffeine CacheStats recorder (#1897)
Initial Caffeine CacheStats recorder Example usage: ``` TaggedMetricRegistry taggedMetricRegistry = ... Cache<Integer, String> cache = Caffeine.newBuilder() .recordStats(CacheStats.of(taggedMetricRegistry, "unique-cache-name")) .build(); LoadingCache<String, Integer> loadingCache = Caffeine.newBuilder() .recordStats(CacheStats.of(taggedMetricRegistry, "unique-loading-cache-name")) .build(key::length); ```
- Loading branch information
Showing
9 changed files
with
379 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
type: improvement | ||
improvement: | ||
description: | | ||
Initial Caffeine CacheStats recorder | ||
Example usage: | ||
``` | ||
TaggedMetricRegistry taggedMetricRegistry = ... | ||
Cache<Integer, String> cache = Caffeine.newBuilder() | ||
.recordStats(CacheStats.of(taggedMetricRegistry, "unique-cache-name")) | ||
.build(); | ||
LoadingCache<String, Integer> loadingCache = Caffeine.newBuilder() | ||
.recordStats(CacheStats.of(taggedMetricRegistry, "unique-loading-cache-name")) | ||
.build(key::length); | ||
``` | ||
links: | ||
- https://github.com/palantir/tritium/pull/1897 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CacheStats.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
/* | ||
* (c) Copyright 2024 Palantir Technologies Inc. All rights reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package com.palantir.tritium.metrics.caffeine; | ||
|
||
import com.codahale.metrics.Counting; | ||
import com.codahale.metrics.Meter; | ||
import com.codahale.metrics.Timer; | ||
import com.github.benmanes.caffeine.cache.RemovalCause; | ||
import com.github.benmanes.caffeine.cache.stats.StatsCounter; | ||
import com.google.common.collect.ImmutableMap; | ||
import com.google.common.collect.Maps; | ||
import com.palantir.logsafe.Safe; | ||
import com.palantir.tritium.metrics.caffeine.CacheMetrics.Load_Result; | ||
import com.palantir.tritium.metrics.registry.TaggedMetricRegistry; | ||
import java.util.Arrays; | ||
import java.util.concurrent.TimeUnit; | ||
import java.util.concurrent.atomic.LongAdder; | ||
import java.util.function.Supplier; | ||
import org.checkerframework.checker.index.qual.NonNegative; | ||
|
||
public final class CacheStats implements StatsCounter, Supplier<StatsCounter> { | ||
private final String name; | ||
private final Meter hitMeter; | ||
private final Meter missMeter; | ||
private final Timer loadSuccessTimer; | ||
private final Timer loadFailureTimer; | ||
private final Meter evictionsTotalMeter; | ||
private final ImmutableMap<RemovalCause, Meter> evictionMeters; | ||
private final LongAdder totalLoadNanos = new LongAdder(); | ||
|
||
/** | ||
* Creates a {@link CacheStats} instance that registers metrics for Caffeine cache statistics. | ||
* <p> | ||
* Example usage for a {@link com.github.benmanes.caffeine.cache.Cache} or | ||
* {@link com.github.benmanes.caffeine.cache.LoadingCache}: | ||
* <pre> | ||
* LoadingCache<Integer, String> cache = Caffeine.newBuilder() | ||
* .recordStats(CacheStats.of(taggedMetricRegistry, "your-cache-name")) | ||
* .build(key -> computeSomethingExpensive(key)); | ||
* </pre> | ||
* @param taggedMetricRegistry tagged metric registry to add cache metrics | ||
* @param name cache name | ||
* @return Caffeine stats instance to register via | ||
* {@link com.github.benmanes.caffeine.cache.Caffeine#recordStats(Supplier)}. | ||
*/ | ||
public static CacheStats of(TaggedMetricRegistry taggedMetricRegistry, @Safe String name) { | ||
return new CacheStats(CacheMetrics.of(taggedMetricRegistry), name); | ||
} | ||
|
||
private CacheStats(CacheMetrics metrics, @Safe String name) { | ||
this.name = name; | ||
this.hitMeter = metrics.hit(name); | ||
this.missMeter = metrics.miss(name); | ||
this.loadSuccessTimer = | ||
metrics.load().cache(name).result(Load_Result.SUCCESS).build(); | ||
this.loadFailureTimer = | ||
metrics.load().cache(name).result(Load_Result.FAILURE).build(); | ||
this.evictionsTotalMeter = metrics.eviction(name); | ||
this.evictionMeters = Arrays.stream(RemovalCause.values()) | ||
.collect(Maps.toImmutableEnumMap(cause -> cause, cause -> metrics.evictions() | ||
.cache(name) | ||
.cause(cause.toString()) | ||
.build())); | ||
} | ||
|
||
@Override | ||
public StatsCounter get() { | ||
return this; | ||
} | ||
|
||
@Override | ||
public void recordHits(@NonNegative int count) { | ||
hitMeter.mark(count); | ||
} | ||
|
||
@Override | ||
public void recordMisses(@NonNegative int count) { | ||
missMeter.mark(count); | ||
} | ||
|
||
@Override | ||
public void recordLoadSuccess(@NonNegative long loadTime) { | ||
loadSuccessTimer.update(loadTime, TimeUnit.NANOSECONDS); | ||
totalLoadNanos.add(loadTime); | ||
} | ||
|
||
@Override | ||
public void recordLoadFailure(@NonNegative long loadTime) { | ||
loadFailureTimer.update(loadTime, TimeUnit.NANOSECONDS); | ||
totalLoadNanos.add(loadTime); | ||
} | ||
|
||
@Override | ||
public void recordEviction(@NonNegative int weight, RemovalCause cause) { | ||
Meter counter = evictionMeters.get(cause); | ||
if (counter != null) { | ||
counter.mark(weight); | ||
} | ||
evictionsTotalMeter.mark(weight); | ||
} | ||
|
||
@Override | ||
public com.github.benmanes.caffeine.cache.stats.CacheStats snapshot() { | ||
return com.github.benmanes.caffeine.cache.stats.CacheStats.of( | ||
hitMeter.getCount(), | ||
missMeter.getCount(), | ||
loadSuccessTimer.getCount(), | ||
loadFailureTimer.getCount(), | ||
totalLoadNanos.sum(), | ||
evictionsTotalMeter.getCount(), | ||
evictionMeters.values().stream().mapToLong(Counting::getCount).sum()); | ||
} | ||
|
||
@Override | ||
public String toString() { | ||
return name + ": " + snapshot(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
options: | ||
javaPackage: com.palantir.tritium.metrics.caffeine | ||
javaVisibility: packagePrivate | ||
namespaces: | ||
cache: | ||
docs: Cache statistic metrics | ||
metrics: | ||
hit: | ||
type: meter | ||
tags: [cache] | ||
docs: Count of cache hits | ||
miss: | ||
type: meter | ||
tags: [cache] | ||
docs: Count of cache misses | ||
load: | ||
type: timer | ||
tags: | ||
- name: cache | ||
- name: result | ||
values: [success, failure] | ||
docs: Count of successful cache loads | ||
evictions: | ||
type: meter | ||
tags: [cache, cause] | ||
docs: Count of evicted entries by cause | ||
eviction: | ||
type: meter | ||
tags: [cache] | ||
docs: Total count of evicted entries | ||
stats.disabled: | ||
type: meter | ||
tags: [cache] | ||
docs: | | ||
Registered cache does not have stats recording enabled, stats will always be zero. | ||
To enable cache metrics, stats recording must be enabled when constructing the cache: | ||
Caffeine.newBuilder().recordStats() |
Oops, something went wrong.