Skip to content

Commit c30b113

Browse files
committed
RHIDP-5421 - Document which plugins in RHDH have metrics
1 parent be6c68e commit c30b113

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ The Keycloak backend plugin supports link:https://opentelemetry.io/[OpenTelemetr
150150
=== Available Counters
151151

152152
.Keycloak metrics
153-
[cols="50%,50%", frame="all", options="header"]
153+
[cols="60%,40%", frame="all", options="header"]
154154
|===
155155
|Metric Name
156156
|Description
@@ -164,13 +164,22 @@ All counters include the `taskInstanceId` label, which uniquely identifies each
164164

165165
Users can enter queries in the Prometheus UI or Grafana to explore and manipulate metric data.
166166

167-
In the following example, the Prometheus Query Language (PromQL) expression returns the number of backend failures associated with a `taskInstanceId`:
167+
.Examples
168+
In the following examples, a Prometheus Query Language (PromQL) expression returns the number of backend failures.
168169

170+
.Example to get the number of backend failures associated with a `taskInstanceId`
169171
[source,subs="+attributes,+quotes"]
170172
----
171173
backend_keycloak_fetch_data_batch_failure_count_total{taskInstanceId="df040f82-2e80-44bd-83b0-06a984ca05ba"} 1
172174
----
173175

176+
.Example to get the number of backend failures during the last hour
177+
178+
[source,subs="+attributes,+quotes"]
179+
----
180+
increase(backend_keycloak_fetch_data_batch_failure_count_total[1h])
181+
----
182+
174183
[NOTE]
175184
====
176185
PromQL supports arithmetic operations, comparison operators, logical/set operations, aggregation, and various functions. Users can combine these features to analyze time-series data effectively.

0 commit comments

Comments
 (0)