docs: Instrumentation Authors Guide #946
Merged
Conversation
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
arielvalentin
requested review from
fbogsany,
mwear,
robertlaurin,
dazuma,
ericmustin,
ahayworth,
plantfansam,
robbkidd,
simi,
kaylareopelle and
xuan-cao-swi
as code owners
Provides explicit guidance for instrumentation authors to reduce friction when submitting contributions
arielvalentin
force-pushed
the
add-impl-guide
branch
from
c18beed to
f5f3e68
Compare
marcotc
reviewed
Apr 29, 2024
marcotc
reviewed
Apr 29, 2024
marcotc
reviewed
Apr 29, 2024
marcotc
reviewed
Apr 29, 2024
marcotc
reviewed
Apr 29, 2024
marcotc
reviewed
Apr 29, 2024
marcotc
reviewed
Apr 29, 2024
marcotc
approved these changes
Apr 29, 2024
There was a problem hiding this comment.
I'm not an official approver, but this is awesome work @arielvalentin! 🙇
Co-authored-by: Marco Costa <mmarcottulio@gmail.com>
Co-authored-by: Marco Costa <mmarcottulio@gmail.com>
Co-authored-by: Marco Costa <mmarcottulio@gmail.com>
Co-authored-by: Marco Costa <mmarcottulio@gmail.com>
Co-authored-by: Marco Costa <mmarcottulio@gmail.com>
marcotc
reviewed
Apr 30, 2024
marcotc
reviewed
Apr 30, 2024
marcotc
reviewed
Apr 30, 2024
Co-authored-by: Marco Costa <mmarcottulio@gmail.com>
arielvalentin
commented
Apr 30, 2024
kaylareopelle
requested changes
May 10, 2024
instrumentation/CONTRIBUTING.md
Outdated
|
|
||
| The `instrumentation_generator` will create a `README.md` file for your instrumentation. Please ensure that the `README` is up-to-date and contains the following: | ||
|
|
||
| 1. The span names, events, and semantic attributes that are emitted by the instrumentation |
There was a problem hiding this comment.
Suggested change
| 1. The span names, events, and semantic attributes that are emitted by the instrumentation | |
| 1. The span names, events, and semantic attributes emitted by the instrumentation |
instrumentation/CONTRIBUTING.md
Outdated
| The `instrumentation_generator` will create a `README.md` file for your instrumentation. Please ensure that the `README` is up-to-date and contains the following: | ||
|
|
||
| 1. The span names, events, and semantic attributes that are emitted by the instrumentation | ||
| 2. The configuration options that are available |
There was a problem hiding this comment.
Suggested change
| 2. The configuration options that are available | |
| 2. The configuration options available |
instrumentation/CONTRIBUTING.md
Outdated
Comment on lines
401
to
403
| In addition to that, there should also be redundant `yardoc` comments in the entrypoint of your gem, i.e. the subclass `OpenTelemetry::Instrumentation::Base`. | ||
|
|
||
| > :information_source: See the `ActiveJob` instrumentation [`README`](./active_job/README.md) for a comprehensive example. |
There was a problem hiding this comment.
Suggested change
| In addition to that, there should also be redundant `yardoc` comments in the entrypoint of your gem, i.e. the subclass `OpenTelemetry::Instrumentation::Base`. | |
| > :information_source: See the `ActiveJob` instrumentation [`README`](./active_job/README.md) for a comprehensive example. | |
| > :information_source: See the `ActiveJob` instrumentation [`README`](./active_job/README.md) for a comprehensive example. | |
| In addition to that, there should also be redundant `yardoc` comments in the entrypoint of your gem, i.e. the subclass `OpenTelemetry::Instrumentation::Base`. | |
| > :information_source: See the `Sidekiq::Instrumentation` [class description](./sidekiq/lib/opentelemetry/instrumentation/sidekiq/instrumentation.rb) for a comprehensive example. |
instrumentation/CONTRIBUTING.md
Outdated
|
|
||
| You are encouraged to submit a `draft` pull request early in the development process to get feedback from the maintainers, run your tests via CI, and ensure that your changes are in line with the project's goals. | ||
|
|
||
| The `CODEOWNERS` is used to notify the instrumentation authors a pull request is opened. Please add yourself to the `instrumentation` section of the `CODEOWNERS` file, e.g. |
There was a problem hiding this comment.
Suggested change
| The `CODEOWNERS` is used to notify the instrumentation authors a pull request is opened. Please add yourself to the `instrumentation` section of the `CODEOWNERS` file, e.g. | |
| The `CODEOWNERS` is used to notify instrumentation authors when a pull request is opened. Please add yourself to the `instrumentation` section of the `CODEOWNERS` file, e.g. |
Co-authored-by: Kayla Reopelle (she/her) <87386821+kaylareopelle@users.noreply.github.com>
ericmustin
approved these changes
May 12, 2024
xuan-cao-swi
approved these changes
May 13, 2024
Co-authored-by: Kayla Reopelle (she/her) <87386821+kaylareopelle@users.noreply.github.com>
kaylareopelle
approved these changes
May 13, 2024
|
|
||
| The original design and implementation of this project was heavily influenced by Datadog's `dd-trace-rb` project. You may refer to the [Datadog Porting Guide](datadog-porting-guide.md) as a reference for implementing instrumentations, however the following guidelines are specific to OpenTelemetry Ruby: | ||
|
|
||
| * Use `OpenTelemetry::Instrumentation::Base` |
There was a problem hiding this comment.
That's right, I forgot the links were automatically generated! So it would be linking whatever the auto-generated value is for the heading to the bullet with the same heading:
* [Use `OpenTelemetry::Instrumentation::Base`](#anchor-link-to-Use-OpenTelemetry-Instrumentation-Base-heading)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Provides explicit guidance for instrumentation authors to reduce friction when submitting contributions