[docs] Add performance benchmarking guide and contributor guidelines #14234
+264
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit addresses issue open-telemetry#14111 by documenting the investigation into performance change detection tooling for the OpenTelemetry Collector. Changes: - Created comprehensive performance-benchmarking.md guide covering: * Running benchmarks locally (make gobenchmark, timebenchmark) * Writing benchmark tests following Go conventions * CodSpeed continuous performance monitoring integration * Best practices for performance-sensitive code changes * Troubleshooting common benchmark issues - Updated CONTRIBUTING.md with Performance Testing section - Added changelog entry documenting the enhancement The investigation found that CodSpeed (integrated in PR open-telemetry#14160) provides continuous performance regression detection on all PRs and commits to main, with <1% variance and commit-level differential flamegraphs. This documentation enables contributors to understand the performance testing infrastructure and follow best practices when making changes that could affect collector performance.
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This commit addresses issue #14111 by documenting the investigation into performance change detection tooling for the OpenTelemetry Collector.
Changes:
The investigation found that CodSpeed (integrated in PR #14160) provides continuous performance regression detection on all PRs and commits to main, with <1% variance and commit-level differential flamegraphs.
This documentation enables contributors to understand the performance testing infrastructure and follow best practices when making changes that could affect collector performance.
Link to tracking issue
Fixes #14111
Testing
NA
Documentation
Created Performance Benchmarking Guide
File: docs/performance-benchmarking.md
Updated CONTRIBUTING.md
File: CONTRIBUTING.md