Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Fabrizio Ferri-Benedetti <fferribenedetti@splunk.com>
  • Loading branch information
Mateusz Rzeszutek and theletterf committed Apr 5, 2022
1 parent d0ca736 commit 63beceb
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/contributing/using-instrumenter-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,14 +118,14 @@ all interfaces that can be used to customize an `Instrumenter`.

### Set the instrumentation version and OpenTelemetry schema URL

It is recommended to always set the instrumentation library version on the `Instrumenter`. This can
be done by calling the `setInstrumentationVersion()` method on the `InstrumenterBuilder`. With the
version present, users of your instrumentation library will be able to recognize which version
produced the telemetry.

If the `Instrumenter` adheres to a certain OpenTelemetry schema, you can set the schema URL using
the `setSchemaUrl()` method on the `InstrumenterBuilder`. You can learn more about the OpenTelemetry
schemas [here](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/schemas/overview.md).
Always set the instrumentation library version on the `Instrumenter`. You can do this by
calling the `setInstrumentationVersion()` method on the `InstrumenterBuilder`. By setting
the version, you let users to identify which version of your instrumentation produced the
telemetry.

If the `Instrumenter` adheres to a specific OpenTelemetry schema, you can set the schema URL using
the `setSchemaUrl()` method on the `InstrumenterBuilder`. To learn more about the OpenTelemetry
schemas [see the Overview](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/schemas/overview.md).

### Name the spans using the `SpanNameExtractor`

Expand Down

0 comments on commit 63beceb

Please sign in to comment.