Add javadoc

line · Nov 16, 2024 · 5b3a182 · 5b3a182
1 parent ecf6fda
commit 5b3a182
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/core/src/main/java/com/linecorp/armeria/common/metric/MoreMeterBinders.java b/core/src/main/java/com/linecorp/armeria/common/metric/MoreMeterBinders.java
@@ -69,6 +69,24 @@ public static CloseableMeterBinder eventLoopMetrics(EventLoopGroup eventLoopGrou
         return new EventLoopMetrics(eventLoopGroup, meterIdPrefix);
     }
 
+    /**
+     * Returns a new {@link MeterBinder} to observe Netty's default {@link PooledByteBufAllocator}.
+     * The following stats are currently exported per registered {@link MeterIdPrefix}.
+     *
+     *
+     * <ul>
+     *   <li>"pooled.byte.buf.allocator.numHeapArenas" (gauge) - the number of heap arenas</li>
+     *   <li>"pooled.byte.buf.allocator.numDirectArenas" (gauge) - the number of direct arenas</li>
+     *   <li>"pooled.byte.buf.allocator.numThreadLocalCaches" (gauge) - the number of thread local caches</li>
+     *   <li>"pooled.byte.buf.allocator.tinyCacheSize" (gauge) - the size of tiny cache</li>
+     *   <li>"pooled.byte.buf.allocator.smallCacheSize" (gauge) - the size of small cache</li>
+     *   <li>"pooled.byte.buf.allocator.normalCacheSize" (gauge) - the size of normal cache</li>
+     *   <li>"pooled.byte.buf.allocator.chunkSize" (gauge) - the chunk size used by the allocator</li>
+     * </ul>
+     *
+     * @param meterIdPrefix the prefix to use for all metrics
+     * @return a new {@link PooledByteBufAllocatorMetrics} instance for the default allocator
+     */
     public static PooledByteBufAllocatorMetrics pooledByteBufAllocatorMetrics(
             MeterIdPrefix meterIdPrefix) {
         return new PooledByteBufAllocatorMetrics(PooledByteBufAllocator.DEFAULT, meterIdPrefix);