forked from open-telemetry/opentelemetry-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: b3 single header support (open-telemetry#1560)
- Loading branch information
Showing
12 changed files
with
1,128 additions
and
678 deletions.
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
144 changes: 144 additions & 0 deletions
144
packages/opentelemetry-core/src/context/propagation/B3MultiPropagator.ts
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,144 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { | ||
| Context, | ||
| GetterFunction, | ||
| TextMapPropagator, | ||
| SetterFunction, | ||
| TraceFlags, | ||
| isValidSpanId, | ||
| isValidTraceId, | ||
| isSpanContextValid, | ||
| getParentSpanContext, | ||
| setExtractedSpanContext, | ||
| } from '@opentelemetry/api'; | ||
| import { B3_DEBUG_FLAG_KEY } from './b3-common'; | ||
|
|
||
| /* b3 multi-header keys */ | ||
| export const X_B3_TRACE_ID = 'x-b3-traceid'; | ||
| export const X_B3_SPAN_ID = 'x-b3-spanid'; | ||
| export const X_B3_SAMPLED = 'x-b3-sampled'; | ||
| export const X_B3_PARENT_SPAN_ID = 'x-b3-parentspanid'; | ||
| export const X_B3_FLAGS = 'x-b3-flags'; | ||
|
|
||
| const VALID_SAMPLED_VALUES = new Set([true, 'true', 'True', '1', 1]); | ||
| const VALID_UNSAMPLED_VALUES = new Set([false, 'false', 'False', '0', 0]); | ||
|
|
||
| function isValidSampledValue(sampled: TraceFlags | undefined): boolean { | ||
| return sampled === TraceFlags.SAMPLED || sampled === TraceFlags.NONE; | ||
| } | ||
|
|
||
| export function parseHeader(header: unknown) { | ||
| return Array.isArray(header) ? header[0] : header; | ||
| } | ||
|
|
||
| function getHeaderValue(carrier: unknown, getter: GetterFunction, key: string) { | ||
| const header = getter(carrier, key); | ||
| return parseHeader(header); | ||
| } | ||
|
|
||
| function getTraceId(carrier: unknown, getter: GetterFunction): string { | ||
| const traceId = getHeaderValue(carrier, getter, X_B3_TRACE_ID); | ||
| if (typeof traceId === 'string') { | ||
| return traceId.padStart(32, '0'); | ||
| } | ||
| return ''; | ||
| } | ||
|
|
||
| function getSpanId(carrier: unknown, getter: GetterFunction): string { | ||
| const spanId = getHeaderValue(carrier, getter, X_B3_SPAN_ID); | ||
| if (typeof spanId === 'string') { | ||
| return spanId; | ||
| } | ||
| return ''; | ||
| } | ||
|
|
||
| function getDebug( | ||
| carrier: unknown, | ||
| getter: GetterFunction | ||
| ): string | undefined { | ||
| const debug = getHeaderValue(carrier, getter, X_B3_FLAGS); | ||
| return debug === '1' ? '1' : undefined; | ||
| } | ||
|
|
||
| function getTraceFlags( | ||
| carrier: unknown, | ||
| getter: GetterFunction | ||
| ): TraceFlags | undefined { | ||
| const traceFlags = getHeaderValue(carrier, getter, X_B3_SAMPLED); | ||
| const debug = getDebug(carrier, getter); | ||
| if (debug === '1' || VALID_SAMPLED_VALUES.has(traceFlags)) { | ||
| return TraceFlags.SAMPLED; | ||
| } | ||
| if (traceFlags === undefined || VALID_UNSAMPLED_VALUES.has(traceFlags)) { | ||
| return TraceFlags.NONE; | ||
| } | ||
| // This indicates to isValidSampledValue that this is not valid | ||
| return; | ||
| } | ||
|
|
||
| /** | ||
| * Propagator for the B3 multiple-header HTTP format. | ||
| * Based on: https://github.com/openzipkin/b3-propagation | ||
| */ | ||
| export class B3MultiPropagator implements TextMapPropagator { | ||
| inject(context: Context, carrier: unknown, setter: SetterFunction) { | ||
| const spanContext = getParentSpanContext(context); | ||
| if (!spanContext || !isSpanContextValid(spanContext)) return; | ||
|
|
||
| const debug = context.getValue(B3_DEBUG_FLAG_KEY); | ||
| setter(carrier, X_B3_TRACE_ID, spanContext.traceId); | ||
| setter(carrier, X_B3_SPAN_ID, spanContext.spanId); | ||
| // According to the B3 spec, if the debug flag is set, | ||
| // the sampled flag shouldn't be propagated as well. | ||
| if (debug === '1') { | ||
| setter(carrier, X_B3_FLAGS, debug); | ||
| } else if (spanContext.traceFlags !== undefined) { | ||
| // We set the header only if there is an existing sampling decision. | ||
| // Otherwise we will omit it => Absent. | ||
| setter( | ||
| carrier, | ||
| X_B3_SAMPLED, | ||
| (TraceFlags.SAMPLED & spanContext.traceFlags) === TraceFlags.SAMPLED | ||
| ? '1' | ||
| : '0' | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| extract(context: Context, carrier: unknown, getter: GetterFunction): Context { | ||
| const traceId = getTraceId(carrier, getter); | ||
| const spanId = getSpanId(carrier, getter); | ||
| const traceFlags = getTraceFlags(carrier, getter) as TraceFlags; | ||
| const debug = getDebug(carrier, getter); | ||
|
|
||
| if ( | ||
| isValidTraceId(traceId) && | ||
| isValidSpanId(spanId) && | ||
| isValidSampledValue(traceFlags) | ||
| ) { | ||
| context = context.setValue(B3_DEBUG_FLAG_KEY, debug); | ||
| return setExtractedSpanContext(context, { | ||
| traceId, | ||
| spanId, | ||
| isRemote: true, | ||
| traceFlags, | ||
| }); | ||
| } | ||
| return context; | ||
| } | ||
| } |
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
Oops, something went wrong.