From 66cf4ddd946da798c74826a9e52d54518fef93a5 Mon Sep 17 00:00:00 2001
From: Alexander Schwartz <aschwart@redhat.com>
Date: Mon, 5 Dec 2022 11:50:56 +0100
Subject: [PATCH] Metrics changed from SmallRye to Micrometer

keycloak/keycloak#15234
---
 release_notes/index.adoc                      |  4 +++
 release_notes/topics/21_0_0.adoc              |  7 +++++
 upgrading/topics/keycloak/changes-21_0_0.adoc | 27 +++++++++++++++++++
 upgrading/topics/keycloak/changes.adoc        |  4 +++
 4 files changed, 42 insertions(+)
 create mode 100644 release_notes/topics/21_0_0.adoc
 create mode 100644 upgrading/topics/keycloak/changes-21_0_0.adoc

diff --git a/release_notes/index.adoc b/release_notes/index.adoc
index e6ba12dbe4..f5acc86a6b 100644
--- a/release_notes/index.adoc
+++ b/release_notes/index.adoc
@@ -13,6 +13,10 @@ include::topics/templates/document-attributes-community.adoc[]
 :release_header_latest_link: {releasenotes_link_latest}
 include::topics/templates/release-header.adoc[]
 
+== {project_name_full} 21.0.0
+include::topics/21_0_0.adoc[leveloffset=2]
+
+
 == {project_name_full} 20.0.0
 include::topics/20_0_0.adoc[leveloffset=2]
 
diff --git a/release_notes/topics/21_0_0.adoc b/release_notes/topics/21_0_0.adoc
new file mode 100644
index 0000000000..a22f666135
--- /dev/null
+++ b/release_notes/topics/21_0_0.adoc
@@ -0,0 +1,7 @@
+= Keycloak uses Micrometer for metrics
+
+Keycloak provides an optional a metrics endpoint which exports metrics in the Prometheus format.
+In this release the implementation to provide this data switched from SmallRye to Micrometer.
+Due to this change, metrics have been renamed.
+
+See the migration guide for details.
diff --git a/upgrading/topics/keycloak/changes-21_0_0.adoc b/upgrading/topics/keycloak/changes-21_0_0.adoc
new file mode 100644
index 0000000000..1e922537c5
--- /dev/null
+++ b/upgrading/topics/keycloak/changes-21_0_0.adoc
@@ -0,0 +1,27 @@
+= Keycloak uses Micrometer for metrics
+
+Keycloak provides an optional a metrics endpoint which exports metrics in the Prometheus format.
+In this release the implementation to provide this data switched from SmallRye to Micrometer, which is the https://quarkus.io/guides/micrometer[recommended metrics library for Quarkus].
+
+Due to this change, metrics have been renamed.
+The following table shows some examples.
+
+Before upgrading it is recommended to review all metrics returned from the endpoint before and after the change, and update their usage in dashboards and alerts.
+
+.Examples of changed metrics names
+|===
+|Old metric name |New metric name
+
+|`base_gc_total`
+|`jvm_gc_pause_seconds_count`
+
+|`base_gc_time_total_seconds`
+|`jvm_gc_pause_seconds_sum`
+
+|`base_thread_count`
+|`jvm_threads_live_threads`
+
+|`vendor_agroal_*`
+|`agroal_*`
+
+|===
diff --git a/upgrading/topics/keycloak/changes.adoc b/upgrading/topics/keycloak/changes.adoc
index d9a4ff0e00..83e2d06dd1 100644
--- a/upgrading/topics/keycloak/changes.adoc
+++ b/upgrading/topics/keycloak/changes.adoc
@@ -1,5 +1,9 @@
 == Migration Changes
 
+=== Migrating to 21.0.0
+
+include::changes-21_0_0.adoc[leveloffset=3]
+
 === Migrating to 20.0.0
 
 include::changes-20_0_0.adoc[leveloffset=3]