Skip to content

fix register part of documentation for caffeine & guava instrumentati… #1203

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 13, 2024
Merged

fix register part of documentation for caffeine & guava instrumentati… #1203

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
5 changes: 3 additions & 2 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 @@ -25,7 +25,8 @@
* <pre>{@code
* // Note that `recordStats()` is required to gather non-zero statistics
* Cache<String, String> cache = Caffeine.newBuilder().recordStats().build();
* CacheMetricsCollector cacheMetrics = new CacheMetricsCollector().register();
* CacheMetricsCollector cacheMetrics = new CacheMetricsCollector();
* PrometheusRegistry.defaultRegistry.register(cacheMetrics);
* cacheMetrics.addCache("mycache", cache);
*
* }</pre>
Expand Down Expand Up @@ -87,7 +88,7 @@ public void addCache(String cacheName, AsyncCache<?, ?> cache) {
*
* @param cacheName cache to be removed
*/
public Cache<?, ?> nremoveCache(String cacheName) {
public Cache<?, ?> removeCache(String cacheName) {
return children.remove(cacheName);
}

Expand Down
3 changes: 2 additions & 1 deletion ...uava/src/main/java/io/prometheus/metrics/instrumentation/guava/CacheMetricsCollector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
* <pre>{@code
* // Note that `recordStats()` is required to gather non-zero statistics
* Cache<String, String> cache = CacheBuilder.newBuilder().recordStats().build();
* CacheMetricsCollector cacheMetrics = new CacheMetricsCollector().register();
* CacheMetricsCollector cacheMetrics = new CacheMetricsCollector();
* PrometheusRegistry.defaultRegistry.register(cacheMetrics);
* cacheMetrics.addCache("mycache", cache);
*
* }</pre>
Expand Down