Feedback on Metrics

* Hide Hot Rod metrics (reason: not released yet) * Fix missplaced endif * Add largest JGroups thread pool size metric * Add hit and success ratios example to Hot Rod metrics Signed-off-by: Pedro Ruivo <[email protected]>
keycloak · Oct 3, 2024 · a7d5fa3 · a7d5fa3
1 parent 6a9b5be
commit a7d5fa3
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 10 deletions.
diff --git a/...netes/modules/ROOT/pages/running/metrics/keycloak_with_external_infinispan.adoc b/...netes/modules/ROOT/pages/running/metrics/keycloak_with_external_infinispan.adoc
@@ -13,16 +13,12 @@ include::partial$/running/metrics/kc_http_metrics.adoc[leveloffset=+1]
 
 == {ispn} Caches
 
-IMPORTANT: Metrics available since {project_name} 27 or newer.
-
 {project_name} caches data in embedded {ispn} caches. The metrics in this section help monitor the caching health.
 
 include::partial$/running/metrics/ispn_metrics.adoc[leveloffset=+1]
 
-== Hot Rod client metrics
-
-IMPORTANT: Metrics available since {project_name} 27 or newer.
-
-{project_name} uses the {ispn} Hot Rod client to connection to an external {jdgserver_name} deployment.
-
-include::partial$/running/metrics/kc_hot_rod_client_metrics.adoc[leveloffset=+1]
+// == Hot Rod client metrics
+//
+// {project_name} uses the {ispn} Hot Rod client to connection to an external {jdgserver_name} deployment.
+//
+// include::partial$/running/metrics/kc_hot_rod_client_metrics.adoc[leveloffset=+1]
diff --git a/doc/kubernetes/modules/ROOT/partials/running/metrics/ispn_metrics.adoc b/doc/kubernetes/modules/ROOT/partials/running/metrics/ispn_metrics.adoc
@@ -200,7 +200,6 @@ The number of failures should not increase.
 | The average time spent, in milliseconds, replicating data in the cluster.
 
 |===
-endif::[]
 
 ====
 *Success ratio*
@@ -210,6 +209,8 @@ An expression can be used to compute the replication success ratio:
 `(vendor_rpc_manager_replication_count)/(vendor_rpc_manager_replication_count+vendor_rpc_manager_replication_failures)`
 ====
 
+endif::[]
+
 ifdef::cross_site[]
 == Cross Site Data Replication
 

diff --git a/doc/kubernetes/modules/ROOT/partials/running/metrics/jgrp_metrics.adoc b/doc/kubernetes/modules/ROOT/partials/running/metrics/jgrp_metrics.adoc
@@ -94,6 +94,16 @@ m| UDP
 m| vendor_jgroups_tunnel_get_thread_pool_size
 m| TUNNEL
 
+m| vendor_jgroups_tcp_get_largest_size
+m| TCP
+.3+| The largest number of threads that have ever simultaneously been in the pool.
+
+m| vendor_jgroups_udp_get_largest_size
+m| UDP
+
+m| vendor_jgroups_tunnel_get_largest_size
+m| TUNNEL
+
 |===
 
 == Flow Control

diff --git a/...kubernetes/modules/ROOT/partials/running/metrics/kc_hot_rod_client_metrics.adoc b/...kubernetes/modules/ROOT/partials/running/metrics/kc_hot_rod_client_metrics.adoc
@@ -69,3 +69,20 @@ A read is a hit if the value is found in the {jdgserver_name} cluster.
 
 include::partial$/running/metrics/histogram_note.adoc[]
 
+====
+*Hit Ratio for read and remove operations*
+
+An expression can be used to compute the hit ratio for a cache in systems such as Prometheus.
+As an example, the hit ratio for read operations can be expressed as:
+
+`vendor_client_hotrod_cache_reads_hit_seconds_count/(vendor_client_hotrod_cache_reads_hit_seconds_count+vendor_client_hotrod_cache_reads_miss_seconds_count)`
+
+====
+
+====
+*Read/Write ratio*
+
+An expression can be used to compute the read-write ratio for a cache, using the metrics above:
+
+`(vendor_client_hotrod_cache_reads_hit_seconds_count+vendor_client_hotrod_cache_reads_miss_seconds_count)/(vendor_client_hotrod_cache_reads_hit_seconds_count+vendor_client_hotrod_cache_reads_miss_seconds_count+vendor_client_hotrod_cache_removes_seconds_count+vendor_client_hotrod_cache_writes_seconds_count)`
+====