Skip to content

docs: document how to run JMH benchmarks#8271

Merged
jack-berg merged 3 commits intoopen-telemetry:mainfrom
zeitlinger:docs/jmh-benchmarks
Apr 22, 2026
Merged

docs: document how to run JMH benchmarks#8271
jack-berg merged 3 commits intoopen-telemetry:mainfrom
zeitlinger:docs/jmh-benchmarks

Conversation

@zeitlinger
Copy link
Copy Markdown
Member

Adds a ### Benchmarks section to CONTRIBUTING.md documenting how to run JMH benchmarks and what output to include in performance PRs.

Motivated by #8240, where the author ran local benchmarks but the repo had no guidance on the established JMH setup.

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@zeitlinger zeitlinger marked this pull request as ready for review April 9, 2026 11:10
@zeitlinger zeitlinger requested a review from a team as a code owner April 9, 2026 11:10
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.27%. Comparing base (5f5b054) to head (a5871e8).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #8271      +/-   ##
============================================
+ Coverage     90.25%   90.27%   +0.01%     
- Complexity     7691     7692       +1     
============================================
  Files           850      850              
  Lines         23203    23207       +4     
  Branches       2356     2356              
============================================
+ Hits          20943    20950       +7     
+ Misses         1532     1530       -2     
+ Partials        728      727       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@jack-berg jack-berg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar content is available here: https://github.com/open-telemetry/opentelemetry-java/blob/main/docs/jmh.md

I like this location better. At least for now until we have a strategy to extend / break apart CONTRIBUTING.md. But can you delete the duplicate content so we have just one copy?

@jack-berg
Copy link
Copy Markdown
Member

This will be superseded by #8303

@jack-berg
Copy link
Copy Markdown
Member

Now lives in https://github.com/open-telemetry/opentelemetry-java/blob/main/docs/knowledge/other-tasks.md#benchmarks-jmh

This PR has added text about running benchmarks when proposing performance sensitive PRs, which would still be useful to add.

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@jack-berg jack-berg merged commit 5fa1d2b into open-telemetry:main Apr 22, 2026
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants