fix register part of documentation for caffeine & guava instrumentati…

…on + fix typo in method name (#1203) Signed-off-by: Petar Heyken <[email protected]>
prometheus · Nov 13, 2024 · cafbc14 · cafbc14
1 parent 8e434c1
commit cafbc14
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/...e/src/main/java/io/prometheus/metrics/instrumentation/caffeine/CacheMetricsCollector.java b/...e/src/main/java/io/prometheus/metrics/instrumentation/caffeine/CacheMetricsCollector.java
@@ -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>
@@ -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);
   }
 

diff --git a/...uava/src/main/java/io/prometheus/metrics/instrumentation/guava/CacheMetricsCollector.java b/...uava/src/main/java/io/prometheus/metrics/instrumentation/guava/CacheMetricsCollector.java
@@ -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>