opensearch-project / performance-analyzer

📈 Get detailed performance metrics from your cluster independently of the Java Virtual Machine (JVM)
https://opensearch.org/docs/latest/monitoring-plugins/pa/index/
Apache License 2.0
32 stars 66 forks source link

Add a high-level overview of classes in the repository #588

Closed kartva closed 7 months ago

kartva commented 8 months ago

Adds a high-level explanation of the current repository structure. Also adds a newer photo for explaining the Performance Analyzer architecture from a recent presentation by @ansjcy.

This may take some iteration to get right, but it should be a very good jumping off point for new contributors so that they can more easily start contributing to Performance Analyzer.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.