-
Notifications
You must be signed in to change notification settings - Fork 230
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
Proposal for SIG Benchmarking #1698
Closed
cartersocha
wants to merge
5
commits into
open-telemetry:main
from
cartersocha:benchmarking-proposal
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
### Description | ||
|
||
As the adoption of OpenTelemetry grows and larger enterprises continue to deepen | ||
their usage of project components there are persistent and ongoing end user | ||
questions about the OpenTelemetry performance impact. End user performance | ||
varies due to the quirks of their environment but without a project performance | ||
standard and historical data record no one really knows if the numbers they're | ||
seeing are abnormal or expected. Additionally, there is no comprehensive | ||
documentation available on tuning project components or the performance | ||
trade-offs available to users which results in a reliance on vendor support. | ||
|
||
The project needs to be able to track the current state of our | ||
components while preventing any performance regressions when making new | ||
releases. Customers need to be able to get a general sense of potential | ||
OpenTelemetry performance impact and the certainty that OpenTelemetry takes | ||
performance and customer resources seriously. Performance tracking and | ||
quantification is a general need that should be addressed by a project wide | ||
effort and automated tooling that minimizes repo owner effort while providing | ||
valuable new data points for all project stakeholders. | ||
|
||
### Project Board | ||
|
||
### SIG Charter | ||
|
||
[charter](https://docs.google.com/document/d/1W0hLqHrUNtS2yclORTNtFZ-lXDblMzUYrp1PCSyzJr8/edit?usp=sharing) | ||
|
||
### Deliverables | ||
|
||
This is intended to be an iterative process. | ||
|
||
* Develop automated tooling that can be used across project repos to report | ||
current performance numbers and track changes as new features / PRs are | ||
merged. | ||
* Basic implementation of the existing specification and repo specific desired | ||
tests in the Collector and 3 language repos. | ||
* Provide ongoing maintenance as needed on automated tooling and own the | ||
underlying assets | ||
|
||
Initial implementation scope would be the core Collector components (main repo), | ||
JavaScript / Java / Python SDKs and their core components. No contrib or | ||
instrumentation repositories. | ||
|
||
### Staffing / Help Wanted | ||
|
||
Anyone with an opinion on performance standards and testing. | ||
|
||
Language contributors as the SIG will be tasked with implementing the changes | ||
and following through on the process. Maintainers or approvers can optionally | ||
participate or consult the SIG on how to use the provided tooling. | ||
|
||
#### Required staffing | ||
|
||
lead - tbd | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @cartersocha, any luck finding a lead for this? |
||
@jpkrohling domain expert | ||
@cartersocha contributor | ||
@mwear collector sig | ||
@codeboten collector sig | ||
@ocelotl python sig | ||
@martinkuba javascript sig | ||
@tylerbenson java sig | ||
@brettmc php sig | ||
|
||
@jpkrohling - GC sponsor | ||
@alolita - GC sponsor | ||
|
||
Need: more performance domain experts, language implementers | ||
|
||
### Meeting Times | ||
|
||
TBD | ||
|
||
### Timeline | ||
|
||
Initial scope is for the Collector and 3 SDKs. Initial output should be available by KubeCon NA | ||
November 6, 2023. | ||
|
||
### Labels | ||
|
||
tbd | ||
|
||
### Linked Issues and PRs | ||
|
||
<https://opentelemetry.io/docs/collector/benchmarks/> | ||
<https://github.com/cncf/cluster/issues/245> | ||
<https://github.com/cncf/cluster/issues/182> | ||
<https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/performance-benchmark.md> | ||
<https://opentelemetry.io/docs/specs/otel/performance-benchmark/> |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once finalized, adding it to the markdown here would be good so it's preserved in the repository.