Skip to content

Commit be6c68e

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

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,13 +160,24 @@ The Keycloak backend plugin supports link:https://opentelemetry.io/[OpenTelemetr
160160

161161
=== Labels
162162

163-
All counters include the `taskInstanceId` label, which uniquely identifies each scheduled fetch task. You can use this label to trace failures back to individual task executions. For example:
163+
All counters include the `taskInstanceId` label, which uniquely identifies each scheduled fetch task. You can use this label to trace failures back to individual task executions.
164+
165+
Users can enter queries in the Prometheus UI or Grafana to explore and manipulate metric data.
166+
167+
In the following example, the Prometheus Query Language (PromQL) expression returns the number of backend failures associated with a `taskInstanceId`:
164168

165169
[source,subs="+attributes,+quotes"]
166170
----
167171
backend_keycloak_fetch_data_batch_failure_count_total{taskInstanceId="df040f82-2e80-44bd-83b0-06a984ca05ba"} 1
168172
----
169173

174+
[NOTE]
175+
====
176+
PromQL supports arithmetic operations, comparison operators, logical/set operations, aggregation, and various functions. Users can combine these features to analyze time-series data effectively.
177+
178+
Additionally, the results can be visualized using Grafana.
179+
====
180+
170181
// === Use Case Example
171182

172183
// Imagine your Keycloak instance is under-provisioned (e.g., low CPU/RAM limits), and the plugin is configured to send many parallel API requests.

0 commit comments

Comments
 (0)