Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(shim-opentracing): replace deprecated spanAttributes #4430

Merged
merged 4 commits into from
Jan 19, 2024
Merged

chore(shim-opentracing): replace deprecated spanAttributes #4430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a66727f
chore(shim-opentracing): replace deprecated spanAttributes
JamieDanielson Jan 18, 2024
c4a4411
update minimum api version to 1.1
JamieDanielson Jan 18, 2024
0c9bb9d
keep newline in package.json
JamieDanielson Jan 18, 2024
ff457cf
update changelog
JamieDanielson Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG_NEXT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

### :boom: Breaking Change

* chore(shim-opentracing): replace deprecated SpanAttributes [#4430](https://github.com/open-telemetry/opentelemetry-js/pull/4430) @JamieDanielson
* chore(otel-core): replace deprecated SpanAttributes [#4408](https://github.com/open-telemetry/opentelemetry-js/pull/4408) @JamieDanielson

### :rocket: (Enhancement)
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/opentelemetry-shim-opentracing/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"access": "public"
},
"devDependencies": {
"@opentelemetry/api": ">=1.0.0 <1.8.0",
"@opentelemetry/api": ">=1.1.0 <1.8.0",
"@opentelemetry/propagator-b3": "1.18.1",
"@opentelemetry/propagator-jaeger": "1.18.1",
"@opentelemetry/sdk-trace-base": "1.18.1",
Expand Down
20 changes: 10 additions & 10 deletions packages/opentelemetry-shim-opentracing/src/shim.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@

import * as api from '@opentelemetry/api';
import {
SpanAttributes,
SpanAttributeValue,
Attributes,
AttributeValue,
SpanStatusCode,
TextMapPropagator,
} from '@opentelemetry/api';
Expand Down Expand Up @@ -287,7 +287,7 @@ export class SpanShim extends opentracing.Span {
* @param eventName name of the event.
* @param payload an arbitrary object to be attached to the event.
*/
override logEvent(eventName: string, payload?: SpanAttributes): void {
override logEvent(eventName: string, payload?: Attributes): void {
this._logInternal(eventName, payload);
}

Expand All @@ -297,7 +297,7 @@ export class SpanShim extends opentracing.Span {
* @param keyValuePairs a set of key-value pairs to be used as event attributes
* @param timestamp optional timestamp for the event
*/
override log(keyValuePairs: SpanAttributes, timestamp?: number): this {
override log(keyValuePairs: Attributes, timestamp?: number): this {
const entries = Object.entries(keyValuePairs);
const eventEntry = entries.find(([key, _]) => key === 'event');
const eventName = eventEntry?.[1] || 'log';
Expand All @@ -309,7 +309,7 @@ export class SpanShim extends opentracing.Span {

private _logInternal(
eventName: string,
attributes: SpanAttributes | undefined,
attributes: Attributes | undefined,
timestamp?: number
): void {
if (attributes && eventName === 'error') {
Expand All @@ -321,7 +321,7 @@ export class SpanShim extends opentracing.Span {
return;
}

const mappedAttributes: api.SpanAttributes = {};
const mappedAttributes: api.Attributes = {};
for (const [k, v] of entries) {
switch (k) {
case 'error.kind': {
Expand Down Expand Up @@ -352,7 +352,7 @@ export class SpanShim extends opentracing.Span {
* Adds a set of tags to the span.
* @param keyValueMap set of KV pairs representing tags
*/
override addTags(keyValueMap: SpanAttributes): this {
override addTags(keyValueMap: Attributes): this {
for (const [key, value] of Object.entries(keyValueMap)) {
if (this._setErrorAsSpanStatusCode(key, value)) {
continue;
Expand All @@ -370,7 +370,7 @@ export class SpanShim extends opentracing.Span {
* @param key key for the tag
* @param value value for the tag
*/
override setTag(key: string, value: SpanAttributeValue): this {
override setTag(key: string, value: AttributeValue): this {
if (this._setErrorAsSpanStatusCode(key, value)) {
return this;
}
Expand Down Expand Up @@ -398,7 +398,7 @@ export class SpanShim extends opentracing.Span {

private _setErrorAsSpanStatusCode(
key: string,
value: SpanAttributeValue | undefined
value: AttributeValue | undefined
): boolean {
if (key === opentracing.Tags.ERROR) {
const statusCode = SpanShim._mapErrorTag(value);
Expand All @@ -409,7 +409,7 @@ export class SpanShim extends opentracing.Span {
}

private static _mapErrorTag(
value: SpanAttributeValue | undefined
value: AttributeValue | undefined
): SpanStatusCode {
switch (value) {
case true:
Expand Down
Loading