From 56c0d74ea9a26b380d75f2ef3f7e5e8490b6d276 Mon Sep 17 00:00:00 2001
From: eyalkoren <41850454+eyalkoren@users.noreply.github.com>
Date: Wed, 21 Jul 2021 16:48:16 +0300
Subject: [PATCH] Add description about memory pool metrics to docs

---
 docs/metrics.asciidoc | 48 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/docs/metrics.asciidoc b/docs/metrics.asciidoc
index 8c6bd5f5c4..c20f27e382 100644
--- a/docs/metrics.asciidoc
+++ b/docs/metrics.asciidoc
@@ -161,6 +161,54 @@ The maximum amount of heap memory in bytes that can be used for memory managemen
 If the maximum memory size is undefined, the value is `-1`.
 --
 
+*`jvm.memory.heap.pool.used`*::
++
+--
+type: long
+
+format: bytes
+
+The amount of used memory in bytes of the memory pool specified by the `name` label
+
+labels
+
+* name: The name representing this memory pool
+
+--
+
+
+*`jvm.memory.heap.pool.committed`*::
++
+--
+type: long
+
+format: bytes
+
+The amount of memory in bytes that is committed for the memory pool specified by the `name` label.
+This amount of memory is guaranteed for this specific pool.
+
+labels
+
+* name: The name representing this memory pool
+
+--
+
+
+*`jvm.memory.heap.pool.max`*::
++
+--
+type: long
+
+format: bytes
+
+The maximum amount of memory in bytes that can be used for the memory pool specified by the `name` label.
+
+labels
+
+* name: The name representing this memory pool
+
+--
+
 
 *`jvm.memory.non_heap.used`*::
 +