Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added performance benchmarking doc #4169

Merged
merged 6 commits into from
Oct 4, 2023

Conversation

martinkuba
Copy link
Contributor

@martinkuba martinkuba commented Sep 28, 2023

Which problem is this PR solving?

Part of #4171

Short description of the changes

This PR adds a doc with instructions on how to add new benchmark tests.

@martinkuba martinkuba force-pushed the benchmark-doc branch 2 times, most recently from 878af26 to 7ed1fc6 Compare September 28, 2023 00:28
@codecov
Copy link

codecov bot commented Sep 28, 2023

Codecov Report

Merging #4169 (225e009) into main (5af8653) will not change coverage.
The diff coverage is n/a.

❗ Current head 225e009 differs from pull request most recent head f44530e. Consider uploading reports for the commit f44530e to get more accurate results

@@           Coverage Diff           @@
##             main    #4169   +/-   ##
=======================================
  Coverage   92.25%   92.25%           
=======================================
  Files         331      331           
  Lines        9465     9465           
  Branches     1997     1997           
=======================================
  Hits         8732     8732           
  Misses        733      733           

@martinkuba martinkuba marked this pull request as ready for review October 2, 2023 18:14
@martinkuba martinkuba requested a review from a team October 2, 2023 18:14
@martinkuba martinkuba mentioned this pull request Oct 3, 2023
7 tasks
Copy link
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

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

Added comment about the test:bench script, otherwise looks good 🙂

doc/contributing/benchmark-tests.md Outdated Show resolved Hide resolved
doc/contributing/benchmark-tests.md Outdated Show resolved Hide resolved
Co-authored-by: Tyler Benson <tylerbenson@gmail.com>
@martinkuba
Copy link
Contributor Author

martinkuba commented Oct 3, 2023

The current Lint/build failure does not seem to be related to this change (broken links in doc/tracing.md and doc/metrics.md).

The semantic conventions docs have been removed from the specification repo. I have updated the links here, but let me know if you prefer that to be in a separate PR. @pichlermarc

@pichlermarc
Copy link
Member

The current Lint/build failure does not seem to be related to this change (broken links in doc/tracing.md and doc/metrics.md).

The semantic conventions docs have been removed from the specification repo. I have updated the links here, but let me know if you prefer that to be in a separate PR. @pichlermarc

Ah, I think having it in this PR is fine. Thanks for fixing it 🙂

@pichlermarc pichlermarc merged commit 5ce32c0 into open-telemetry:main Oct 4, 2023
16 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.

3 participants