open-telemetry
/
opentelemetry-java-instrumentation
mirror of https://github.com/open-telemetry/opentelemetry-java-instrumentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update instrumenter api on contributing doc (#10308) 

Co-authored-by: Lauri Tulmin <tulmin@gmail.com>
This commit is contained in:
AndyChen 2024-01-23 23:54:47 +08:00 committed by GitHub
parent e04b448b6c
commit da49a4c517
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing/using-instrumenter-api.md
View File

@ -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`