Making metrics with labels for embedded Infinispan the default

Closes #25935

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
This commit is contained in:
Alexander Schwartz 2024-01-05 12:20:48 +01:00 committed by Alexander Schwartz
parent d1d1d69840
commit badf3f461d
4 changed files with 31 additions and 2 deletions

View file

@ -116,4 +116,11 @@ In this release, if a user tries to follow the link to verify the email and the
will be shown. will be shown.
In addition to that, a new error (`EMAIL_ALREADY_VERIFIED`) event will be fired to indicate an attempt to verify an already verified email. You can In addition to that, a new error (`EMAIL_ALREADY_VERIFIED`) event will be fired to indicate an attempt to verify an already verified email. You can
use this event to track possible attempts to hijack user accounts in case the link has leaked or to alert users if they do not recognize the action. use this event to track possible attempts to hijack user accounts in case the link has leaked or to alert users if they do not recognize the action.
= Infinispan metrics use labels for cache manager and cache names
When enabling metrics for {project_name}'s embedded caches, the metrics now use labels for the cache manager and the cache names.
For more details, check the
link:{upgradingguide_link}[{upgradingguide_name}].

View file

@ -142,4 +142,24 @@ By using separate templates for each flow, a more clear distinction exist as to
and potentially introduce unexpected changes and behavior that should only affect pages for a specific flow. and potentially introduce unexpected changes and behavior that should only affect pages for a specific flow.
If you have customizations to the `login-update-profile.ftl` template to customize how users update their profiles when authenticating through a broker, make sure to move your changes If you have customizations to the `login-update-profile.ftl` template to customize how users update their profiles when authenticating through a broker, make sure to move your changes
to the new template. to the new template.
= Infinispan metrics use labels for cache manager and cache names
When enabling metrics for {project_name}'s embedded caches, the metrics now use labels for the cache manager and the cache names.
.Old metric example without labels
----
vendor_cache_manager_keycloak_cache_sessions_statistics_approximate_entries_in_memory{cache="sessions",node="..."}
----
.New metric example with labels
----
vendor_statistics_approximate_entries_in_memory{cache="sessions",cache_manager="keycloak",node="..."}
----
To revert the change for an installation, use a custom Infinispan XML configuration and change the configuration as follows:
----
<metrics names-as-tags="false" />
----

View file

@ -23,6 +23,7 @@
<cache-container name="keycloak"> <cache-container name="keycloak">
<transport lock-timeout="60000"/> <transport lock-timeout="60000"/>
<metrics names-as-tags="true" />
<local-cache name="realms" simple-cache="true"> <local-cache name="realms" simple-cache="true">
<encoding> <encoding>
<key media-type="application/x-java-object"/> <key media-type="application/x-java-object"/>

View file

@ -22,6 +22,7 @@
xmlns="urn:infinispan:config:14.0"> xmlns="urn:infinispan:config:14.0">
<cache-container name="keycloak"> <cache-container name="keycloak">
<metrics names-as-tags="true" />
<local-cache name="default"> <local-cache name="default">
<transaction transaction-manager-lookup="org.infinispan.transaction.lookup.JBossStandaloneJTAManagerLookup"/> <transaction transaction-manager-lookup="org.infinispan.transaction.lookup.JBossStandaloneJTAManagerLookup"/>
</local-cache> </local-cache>