Describe metrics for Infinispan

[pruivo]

Closes #984

[ryanemerson]

Thanks @pruivo this is a great addition, just a few comments.

[mhajas]

Nice work @pruivo !! This is great, I added a few comments but this is a great improvement for metrics docs.

Do you plan to update our Infinispan Grafana dashboard based on this?

[pruivo]

@mhajas after agreeing on the metrics, I can start work on the dashboards.

[ahus1]

Great work! See below for some questions. The overall question to me is if we can have everything (embedded and external) in one document. Maybe we can as a start before we split it up. I'll leave it up to you.

If any of the metrics I ask for below isn't available, we'll continue without the for a first iteration.

[pruivo]

@ahus1 @mhajas @ryanemerson It looks like I had the wrong idea and only made it with the external Infinispan in mind.

At the moment, Keycloak does not have any cache metrics in multi-site deployments (user, realm and so on are "simple-cache" and do not collect metrics).

If we are doing for every scenario, I would prefer to splits the pages (ignore naming for now 🤣 ):

• Keycloak Single Site: jgroups + caches
• Keycloak Multi Site: hot rod client
• External Infinispan: jgroups + caches + cross-site

wdyt?

[ahus1]

With the docs we need to start somewhere, and eventually all three scenarios should have documentation about their metrics. IMHO "Keycloak Single Site: jgroups + caches" would be the scenario most people would use, so with such a guide a lot of people can benefit.

We can decide in our meeting later today which way we want to go. Whatever we decide, the guide should probably have a paragraph at the beginning describing what to find on this page :-)

At the moment, Keycloak does not have any cache metrics in multi-site deployments (user, realm and so on are "simple-cache" and do not collect metrics).

Hm, I suppose users would still want to monitor the cache hit ratio for the user and realm cache to be able to tune it.
Please create a new issue so we can discuss this.

[pruivo]

I've created https://issues.redhat.com/browse/ISPN-16636

I agree to be more exhaustive and have more deployment and I just misunderstood the issue description. I'll reshuffle things around to have a "nicer" page with all deployments.

[ahus1]

@pruivo - thank you for creating the enhancement issue. An alternative could be not to use simple caches (just local caches) in Keycloak - either in the meantime, or in general?

[ahus1]

@pruivo - I rendered the pages locally, and I found that they are all part of the "running" category. As we are about to ask for feedback on metrics, please consider moving the items into their own category "metrics". We can then ask the community about feedback on that category, and not being confused by "Infinispan Deployment: Single Cluster" and similar topics.

The "metrics" category might be a sub-category of "running", or its own top-level category.

[pruivo]

@pruivo - thank you for creating the enhancement issue. An alternative could be not to use simple caches (just local caches) in Keycloak - either in the meantime, or in general?

@ahus1 yes, that would work. Simple caches are usually more memory-friendly, but if the metrics are important, we can revert them to "normal" caches.

[pruivo]

@pruivo - I rendered the pages locally, and I found that they are all part of the "running" category. As we are about to ask for feedback on metrics, please consider moving the items into their own category "metrics". We can then ask the community about feedback on that category, and not being confused by "Infinispan Deployment: Single Cluster" and similar topics.

The "metrics" category might be a sub-category of "running", or its own top-level category.

I don't understand your suggestion, @ahus1.

They are already a sub-category of running

[pruivo]

I've collected all the metrics that I think are relevant. I still need to review and fix grammar errors, but it should be complete now. Let me know what you think @ahus1 @mhajas @ryanemerson 👍
Thank you for the feedback.

[ahus1]

They are already a sub-category of running

OK, I was talking about the left navigation. I pushed d59d3fc and it now looks like the following:

[ahus1]

Hi @pruivo - thank you for this PR! I went through my previous review comments and resolved all except 3 of them. Please have a look at those last three open items. If they are simple to fix, please resolve them, otherwise go ahead with merging so we can start collecting feedback.

About grammar checks: You can enable a grammar checsk in IntelliJ when you add the "Grazie Pro" plugin. It will then highlight the grammar checks in the editor and in the "Problems" tab in the IDE.

[ryanemerson]

27?

[pruivo]

Probably a bit pessimistic here, but I don't know where the metrics will be available. Optimistically, in 26.1.

[ahus1]

We usually don't do promises on features in a future release. Let's be less specific.

[ahus1]

My comments have all been resolved. Thanks!

[ryanemerson]

Thanks @pruivo