Added note about metric categories (#521)

Co-authored-by: Alexandra Tran Carrillo <[email protected]>
Consensys · Dec 7, 2023 · 11fc963 · 11fc963 · vercel · Dec 7, 2023
1 parent d4150f5
commit 11fc963
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/docs/reference/cli/index.md b/docs/reference/cli/index.md
@@ -1420,7 +1420,9 @@ metrics-categories: ["BEACON", "JVM", "PROCESS"]
   </TabItem>
 </Tabs>
 
-Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `DISCOVERY`, `EVENTBUS`, `EXECUTOR`, `LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`, `REMOTE_VALIDATOR`, `VALIDATOR`, `VALIDATOR_PERFORMANCE`. All categories are enabled by default.
+Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `DISCOVERY`, `EVENTBUS`, `EXECUTOR`, `LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`, `REMOTE_VALIDATOR`, `VALIDATOR`, `VALIDATOR_PERFORMANCE`, `VALIDATOR_DUTY`.  All but `VALIDATOR_DUTY` categories are enabled by default.
+
+When `metrics-categories` is used, only the categories specified in this option are enabled (all other categories are disabled).
 
 ### metrics-interface
 
@@ -2840,14 +2842,14 @@ The [validator REST API](../rest.md#enable-the-validator-client-api) listening p
 ```
 
   </TabItem>
-  <TabItem value="Example for directory" label="Example for directory" > 
+  <TabItem value="Example for directory" label="Example for directory" >
 
 ```bash
 --validator-keys=/home/validator/keys:home/validator/passwords
 ```
 
   </TabItem>
-  <TabItem value="Example for file" label="Example for file" > 
+  <TabItem value="Example for file" label="Example for file" >
 
 ```bash
 --validator-keys=/home/validator/keys/validator_217179e.json:/home/validator/passwords/validator_217179e.txt

diff --git a/docs/reference/cli/subcommands/validator-client.md b/docs/reference/cli/subcommands/validator-client.md
@@ -542,7 +542,9 @@ metrics-categories: ["BEACON", "JVM", "PROCESS"]
   </TabItem>
 </Tabs>
 
-Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `DISCOVERY`, `EVENTBUS`, `EXECUTOR`, `LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`, `REMOTE_VALIDATOR`, `VALIDATOR`, `VALIDATOR_PERFORMANCE`. All categories are enabled by default.
+Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `DISCOVERY`, `EVENTBUS`, `EXECUTOR`, `LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`, `REMOTE_VALIDATOR`, `VALIDATOR`, `VALIDATOR_PERFORMANCE`, `VALIDATOR_DUTY`.  All but `VALIDATOR_DUTY` categories are enabled by default.
+
+When `metrics-categories` is used, only the categories specified in this option are enabled (all other categories are disabled).
 
 ## `metrics-interface`