[OAK-6179] Simplify collecting Oak setup details via Felix Inventory

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.7.0, 1.8.0
• Component/s: core
• Epic Link: indexer resilience
• Assignee: Chetan Mehrotra
• Reporter: Chetan Mehrotra
• Created: 08/May/17 05:50
• Updated: 11/Dec/17 08:31
• Resolved: 22/May/17 04:51

Description

Felix Inventory Support [1] provides a way for various components to provide a dump of setup state in text or json format. Oak should provide inventory printers which collect state across various sub systems so that we can understand an Oak based setup in a better way.

For now we expose quite bit of information via JMX which helps if we have access to the setup. With inventory support we can request the system admin to provide a zip file which would contain dump from various inventory printers.

Some possible printers

1. Index Stats - Printer to dump stats related to various indexes. Build on top of OAK-6080
2. Index Definitions - Dump of index definition in json format
3. Checkpoints - Dump state of all checkpoints live in the setup
4. DocumentNodeStore
   1. Mongo - Dump indexes in Mongo, version, replica set info
   2. ClusterNodeInfo - Dump state of all cluster nodes in the setup

Implementation Note
To use this we would need to add an optional dependency on Felix Inventory Bundle. However we can inline the package and reimport that such that Oak can be used in setups where this bundle is not present and if its present it gets integrated in Felix WebConsole

Discussion thread on oak-dev

[1] http://felix.apache.org/documentation/subprojects/apache-felix-inventory.html

Issue Links

• is related to: OAK-7043 Collect SegmentStore stats as part of status zip
• is related to: OAK-7021 Collect DocumentStore stats as part of status zip
• relates to: OAK-6080 Index report service