Skip to content

Commit 47ffd19

Browse files
committed
fix register part of documentation for caffeine & guava instrumentation + fix typo in method name
Signed-off-by: Petar Heyken <mail@petar-heyken.de>
1 parent 8e434c1 commit 47ffd19

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

prometheus-metrics-instrumentation-caffeine/src/main/java/io/prometheus/metrics/instrumentation/caffeine/CacheMetricsCollector.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
* <pre>{@code
2626
* // Note that `recordStats()` is required to gather non-zero statistics
2727
* Cache<String, String> cache = Caffeine.newBuilder().recordStats().build();
28-
* CacheMetricsCollector cacheMetrics = new CacheMetricsCollector().register();
28+
* CacheMetricsCollector cacheMetrics = new CacheMetricsCollector();
29+
* PrometheusRegistry.defaultRegistry.register(cacheMetrics);
2930
* cacheMetrics.addCache("mycache", cache);
3031
*
3132
* }</pre>
@@ -87,7 +88,7 @@ public void addCache(String cacheName, AsyncCache<?, ?> cache) {
8788
*
8889
* @param cacheName cache to be removed
8990
*/
90-
public Cache<?, ?> nremoveCache(String cacheName) {
91+
public Cache<?, ?> removeCache(String cacheName) {
9192
return children.remove(cacheName);
9293
}
9394

prometheus-metrics-instrumentation-guava/src/main/java/io/prometheus/metrics/instrumentation/guava/CacheMetricsCollector.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
* <pre>{@code
2424
* // Note that `recordStats()` is required to gather non-zero statistics
2525
* Cache<String, String> cache = CacheBuilder.newBuilder().recordStats().build();
26-
* CacheMetricsCollector cacheMetrics = new CacheMetricsCollector().register();
26+
* CacheMetricsCollector cacheMetrics = new CacheMetricsCollector();
27+
* PrometheusRegistry.defaultRegistry.register(cacheMetrics);
2728
* cacheMetrics.addCache("mycache", cache);
2829
*
2930
* }</pre>

0 commit comments

Comments
 (0)