[MAGNOLIA-9184] Expose RepositoryStatistics for monitoring Created: 10/Nov/23  Updated: 16/Jan/24  Resolved: 16/Jan/24

Status: Closed
Project: Magnolia
Component/s: core
Affects Version/s: None
Fix Version/s: 6.3.0

Type: Story Priority: Neutral
Reporter: Michael Duerig Assignee: Michael Duerig
Resolution: Done Votes: 0
Labels: dx-core-6.3
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File repository stats.png    
Issue Links:
Cloners
clones MAGNOLIA-9183 Expose QueryStatManagerMBean for moni... Closed
dependency
depends upon MAGNOLIA-9198 Refactor ProviderImpl to gain access ... Closed
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Release notes required:
Yes
Documentation update required:
Yes
Epic Link: Collect Usage Metrics
Work Started:
Approved:
Yes

 Description   

Jackrabbit provides org.apache.jackrabbit.api.stats.RepositoryStatistics exposing a wealth of information about repository read, write and cache performance. We should register it either with the MBean server info.magnolia.cms.util.MBeanUtil#registerMBean or Dropwizard metrics (info.magnolia.monitoring.MicrometerRegistryProvider).

Discovery

  • The repository statistics are available from org.apache.jackrabbit.core.RepositoryContext#getRepositoryStatistics. See the discovery of MAGNOLIA-9183 for how to get access to the RepositoryContext.
  • To expose the repository statistics as MBean we can copy and slightly modify the implementations from Jackrabbit Oak (info.magnolia.repository.mxbean.RepositoryStats and info.magnolia.repository.mxbean.RepositoryStatsMBean).


 Comments   
Comment by Michael Duerig [ 15/Jan/24 ]

For documentation:

The `RepositoryStats` MBean exposes the following metrics about the JCR repository. See Javadoc of info.magnolia.repository.mxbean.RepositoryStatsMBean for details.

/cc amansell 

Generated at Mon Feb 12 04:39:21 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.