[Development Guide] Including Profiling Guidelines #15251
Description
Is your feature request related to a problem? Please describe
A lot of performance optimizations require developers/contributors to profile OpenSearch process and capture impact of their changes on heap/memory to demonstrate the impact of their changes, also to establish that their changes are not introducing any regression. OSB helps capture indexing/search latency/throughput improvements that alone is not sufficient for certain optimizations.
Example PRs where OSB might not be right tool to capture regression introduced/improved:
#14662
#14723
Describe the solution you'd like
One solution is to include a set of steps in development guide on how new contributors can use profilers (a lot of developers in OpenSearch community use async-profiler, but can brainstorm if there are better alternatives). These steps can be suggestive in nature but can provide a feasible way to kickstart their profiling activity to capture heap changes.
Want to check with community if there is a better way to do this exercise other than following a bunch of manual steps?
Related component
Other
Describe alternatives you've considered
No response
Additional context
No response