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

* chore(shim-opentracing): replace deprecated spanAttributes * update minimum api version to 1.1 * keep newline in package.json * update changelog
open-telemetry · Jan 19, 2024 · 9727686 · 9727686
1 parent 7f613e0
commit 9727686
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 13 deletions.
diff --git a/CHANGELOG_NEXT.md b/CHANGELOG_NEXT.md
@@ -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)

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/opentelemetry-shim-opentracing/package.json b/packages/opentelemetry-shim-opentracing/package.json
@@ -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",

diff --git a/packages/opentelemetry-shim-opentracing/src/shim.ts b/packages/opentelemetry-shim-opentracing/src/shim.ts
@@ -16,8 +16,8 @@
 
 import * as api from '@opentelemetry/api';
 import {
-  SpanAttributes,
-  SpanAttributeValue,
+  Attributes,
+  AttributeValue,
   SpanStatusCode,
   TextMapPropagator,
 } from '@opentelemetry/api';
@@ -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);
   }
 
@@ -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';
@@ -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') {
@@ -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': {
@@ -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;
@@ -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;
     }
@@ -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);
@@ -409,7 +409,7 @@ export class SpanShim extends opentracing.Span {
   }
 
   private static _mapErrorTag(
-    value: SpanAttributeValue | undefined
+    value: AttributeValue | undefined
   ): SpanStatusCode {
     switch (value) {
       case true: