-
Notifications
You must be signed in to change notification settings - Fork 814
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into release/1.13-0.39
- Loading branch information
Showing
16 changed files
with
451 additions
and
67 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
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
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,78 @@ | ||
/* | ||
* 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 * as oc from '@opencensus/core'; | ||
|
||
import { | ||
context, | ||
propagation, | ||
trace, | ||
TextMapGetter, | ||
TextMapSetter, | ||
} from '@opentelemetry/api'; | ||
import { mapSpanContext, reverseMapSpanContext } from './transform'; | ||
|
||
class Getter implements TextMapGetter<void> { | ||
constructor(private ocGetter: oc.HeaderGetter) {} | ||
keys(): string[] { | ||
return []; | ||
} | ||
get(carrier: void, key: string) { | ||
return this.ocGetter.getHeader(key); | ||
} | ||
} | ||
|
||
class Setter implements TextMapSetter<void> { | ||
constructor(private ocSetter: oc.HeaderSetter) {} | ||
set(carrier: void, key: string, value: string): void { | ||
this.ocSetter.setHeader(key, value); | ||
} | ||
} | ||
|
||
/** | ||
* Bridges OpenTelemetry propagation API into OpenCensus. The global OTel propagator is called | ||
* to implement the OpenCensus propagation API. | ||
*/ | ||
export const shimPropagation: oc.Propagation = { | ||
extract(getter: oc.HeaderGetter): oc.SpanContext | null { | ||
const extracted = propagation.extract( | ||
context.active(), | ||
null, | ||
new Getter(getter) | ||
); | ||
|
||
const otelSc = trace.getSpanContext(extracted); | ||
return otelSc ? reverseMapSpanContext(otelSc) : null; | ||
}, | ||
|
||
inject(setter: oc.HeaderSetter, spanContext: oc.SpanContext): void { | ||
const ctx = trace.setSpanContext( | ||
context.active(), | ||
mapSpanContext(spanContext) | ||
); | ||
propagation.inject(ctx, null, new Setter(setter)); | ||
}, | ||
|
||
generate(): oc.SpanContext { | ||
// Reading OpenCensus code, it looks like this should generate a new random span context. | ||
// However, it doesn't appear to be used based on my testing. Options for implementing: | ||
// | ||
// - Return the invalid span context | ||
// - Use the OTel ID generator, however this package should be an API-only bridge | ||
// - Copy implementation from OpenCensus noop-propagation.ts | ||
throw new Error('shimPropagation.generate() is not yet implemented'); | ||
}, | ||
}; |
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,105 @@ | ||
/* | ||
* 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 * as oc from '@opencensus/core'; | ||
import { | ||
Attributes, | ||
SpanContext, | ||
SpanKind, | ||
TimeInput, | ||
diag, | ||
} from '@opentelemetry/api'; | ||
import { TraceState } from '@opentelemetry/core'; | ||
|
||
function exhaust(value: never) { | ||
diag.warn('Could not handle enum value %s', value); | ||
} | ||
|
||
export function mapSpanKind( | ||
kind: oc.SpanKind | undefined | ||
): SpanKind | undefined { | ||
switch (kind) { | ||
case undefined: | ||
return undefined; | ||
case oc.SpanKind.UNSPECIFIED: | ||
return SpanKind.INTERNAL; | ||
case oc.SpanKind.CLIENT: | ||
return SpanKind.CLIENT; | ||
case oc.SpanKind.SERVER: | ||
return SpanKind.SERVER; | ||
default: | ||
exhaust(kind); | ||
return undefined; | ||
} | ||
} | ||
|
||
export function mapSpanContext({ | ||
spanId, | ||
traceId, | ||
options, | ||
traceState, | ||
}: oc.SpanContext): SpanContext { | ||
return { | ||
spanId, | ||
traceId, | ||
traceFlags: options ?? 0, | ||
traceState: | ||
traceState === undefined ? undefined : new TraceState(traceState), | ||
}; | ||
} | ||
|
||
export function reverseMapSpanContext({ | ||
spanId, | ||
traceId, | ||
traceFlags, | ||
traceState, | ||
}: SpanContext): oc.SpanContext { | ||
return { | ||
spanId: spanId, | ||
traceId: traceId, | ||
options: traceFlags, | ||
traceState: traceState?.serialize(), | ||
}; | ||
} | ||
|
||
// Copied from Java | ||
// https://github.com/open-telemetry/opentelemetry-java/blob/0d3a04669e51b33ea47b29399a7af00012d25ccb/opencensus-shim/src/main/java/io/opentelemetry/opencensusshim/SpanConverter.java#L24-L27 | ||
const MESSAGE_EVENT_ATTRIBUTE_KEY_TYPE = 'message.event.type'; | ||
const MESSAGE_EVENT_ATTRIBUTE_KEY_SIZE_UNCOMPRESSED = | ||
'message.event.size.uncompressed'; | ||
const MESSAGE_EVENT_ATTRIBUTE_KEY_SIZE_COMPRESSED = | ||
'message.event.size.compressed'; | ||
|
||
export function mapMessageEvent( | ||
type: oc.MessageEventType, | ||
id: number, | ||
timestamp?: number, | ||
uncompressedSize?: number, | ||
compressedSize?: number | ||
): [string, Attributes, TimeInput | undefined] { | ||
const attributes: Attributes = { | ||
[MESSAGE_EVENT_ATTRIBUTE_KEY_TYPE]: oc.MessageEventType[type], | ||
}; | ||
if (uncompressedSize !== undefined) { | ||
attributes[MESSAGE_EVENT_ATTRIBUTE_KEY_SIZE_UNCOMPRESSED] = | ||
uncompressedSize; | ||
} | ||
if (compressedSize !== undefined) { | ||
attributes[MESSAGE_EVENT_ATTRIBUTE_KEY_SIZE_COMPRESSED] = compressedSize; | ||
} | ||
|
||
return [id.toString(), attributes, timestamp]; | ||
} |
File renamed without changes.
Oops, something went wrong.