KEYCLOAK-10120: enable statistics with env variable.

Signed-off-by: Cédric Couralet <[email protected]>
fidgi · Sep 3, 2019 · 14e07f8 · 14e07f8
1 parent 2d9e6d6
commit 14e07f8
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 0 deletions.
diff --git a/server/README.md b/server/README.md
@@ -420,7 +420,19 @@ It is also possible to provide an additional CA bundle and setup Mutual TLS this
 
 NOTE: See `openshift-examples` directory for an out of the box setup for OpenShift.
 
+### Enable some metrics
 
+Keycloak image can collect some statistics for various subsystem which will then be available in the management console and the `/metrics` endpoint.
+You can enable it with the KEYCLOAK_STATISTICS environment variables which take a list of statistics to enable:
+* `db` for the `datasources` subsystem
+* `http` for the `undertow` subsystem
+* `jgroups` for the `jgroups` subsystem
+
+for instance, `KEYCLOAK_STATISTICS=db,http` will enable statistics for the datasources and undertow subsystem.
+
+The special value `all` enables all statistics.
+
+Once enabled, you should see the metrics values changing on the `/metrics` endpoint for the management endpoint.
 
 ## Other details
 

diff --git a/server/tools/cli/metrics/db.cli b/server/tools/cli/metrics/db.cli
@@ -0,0 +1,5 @@
+embed-server --server-config=standalone-ha.xml --std-out=echo
+batch
+/subsystem=datasources/data-source=KeycloakDS:write-attribute(name=statistics-enabled, value=true)
+run-batch
+stop-embedded-server
diff --git a/server/tools/cli/metrics/http.cli b/server/tools/cli/metrics/http.cli
@@ -0,0 +1,5 @@
+embed-server --server-config=standalone-ha.xml --std-out=echo
+batch
+/subsystem=undertow:write-attribute(name=statistics-enabled,value=true)
+run-batch
+stop-embedded-server
diff --git a/server/tools/cli/metrics/jgroups.cli b/server/tools/cli/metrics/jgroups.cli
@@ -0,0 +1,5 @@
+embed-server --server-config=standalone-ha.xml --std-out=echo
+batch
+/subsystem=jgroups/channel=ee:write-attribute(name=statistics-enabled, value=true)
+run-batch
+stop-embedded-server
diff --git a/server/tools/docker-entrypoint.sh b/server/tools/docker-entrypoint.sh
@@ -80,6 +80,14 @@ if [ -z "$BIND_OPTS" ]; then
 fi
 SYS_PROPS+=" $BIND_OPTS"
 
+#########################################
+# Expose management console for metrics #
+#########################################
+
+if [ -n "$KEYCLOAK_STATISTICS" ] ; then 
+    SYS_PROPS+=" -Djboss.bind.address.management=0.0.0.0"
+fi
+
 #################
 # Configuration #
 #################
@@ -203,6 +211,7 @@ fi
 
 /opt/jboss/tools/x509.sh
 /opt/jboss/tools/jgroups.sh
+/opt/jboss/tools/statistics.sh
 /opt/jboss/tools/autorun.sh
 
 ##################

diff --git a/server/tools/statistics.sh b/server/tools/statistics.sh
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+if [ -n "$KEYCLOAK_STATISTICS" ]; then
+   IFS=',' read -ra metrics <<< "$KEYCLOAK_STATISTICS"
+   for file in /opt/jboss/tools/cli/metrics/*.cli; do
+      name=${file##*/}
+      base=${name%.cli}
+      if [[  $KEYCLOAK_STATISTICS == *"$base"* ]] || [[  $KEYCLOAK_STATISTICS == *"all"* ]];  then
+         $JBOSS_HOME/bin/jboss-cli.sh --file="$file" >& /dev/null
+      fi
+   done
+fi