Skip to content

Commit

Permalink
update instrumenter api on contributing doc (#10308)
Browse files Browse the repository at this point in the history
Co-authored-by: Lauri Tulmin <[email protected]>
  • Loading branch information
Roiocam and laurit authored Jan 23, 2024
1 parent e04b448 commit da49a4c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/contributing/using-instrumenter-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -418,16 +418,16 @@ method for that: passing `false` will turn the newly created `Instrumenter` into
The `Instrumenter` creation process ends with calling one of the following `InstrumenterBuilder`
methods:

- `newInstrumenter()`: the returned `Instrumenter` will always start spans with kind `INTERNAL`.
- `newInstrumenter(SpanKindExtractor)`: the returned `Instrumenter` will always start spans with
- `buildInstrumenter()`: the returned `Instrumenter` will always start spans with kind `INTERNAL`.
- `buildInstrumenter(SpanKindExtractor)`: the returned `Instrumenter` will always start spans with
kind determined by the passed `SpanKindExtractor`.
- `newClientInstrumenter(TextMapSetter)`: the returned `Instrumenter` will always start `CLIENT`
- `buildClientInstrumenter(TextMapSetter)`: the returned `Instrumenter` will always start `CLIENT`
spans and will propagate operation context into the outgoing request.
- `newServerInstrumenter(TextMapGetter)`: the returned `Instrumenter` will always start `SERVER`
- `buildServerInstrumenter(TextMapGetter)`: the returned `Instrumenter` will always start `SERVER`
spans and will extract the parent span context from the incoming request.
- `newProducerInstrumenter(TextMapSetter)`: the returned `Instrumenter` will always start `PRODUCER`
- `buildProducerInstrumenter(TextMapSetter)`: the returned `Instrumenter` will always start `PRODUCER`
spans and will propagate operation context into the outgoing request.
- `newConsumerInstrumenter(TextMapGetter)`: the returned `Instrumenter` will always start `SERVER`
- `buildConsumerInstrumenter(TextMapGetter)`: the returned `Instrumenter` will always start `CONSUMER`
spans and will extract the parent span context from the incoming request.

The last four variants that create non-`INTERNAL` spans accept either `TextMapSetter`
Expand Down

0 comments on commit da49a4c

Please sign in to comment.