chore: fixing status code aligning it with proto (#1860)

open-telemetry · Jan 24, 2021 · b85acf0 · b85acf0
1 parent 960b868
commit b85acf0
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 47 deletions.
diff --git a/packages/opentelemetry-api/src/trace/status.ts b/packages/opentelemetry-api/src/trace/status.ts
@@ -25,14 +25,14 @@ export interface Status {
  */
 export enum StatusCode {
   /**
-   * The operation has been validated by an Application developer or
-   * Operator to have completed successfully.
+   * The default status.
    */
-  OK = 0,
+  UNSET = 0,
   /**
-   * The default status.
+   * The operation has been validated by an Application developer or
+   * Operator to have completed successfully.
    */
-  UNSET = 1,
+  OK = 1,
   /**
    * The operation contains an error.
    */

diff --git a/packages/opentelemetry-exporter-collector/src/transform.ts b/packages/opentelemetry-exporter-collector/src/transform.ts
@@ -19,7 +19,6 @@ import {
   Link,
   SpanKind,
   Status,
-  StatusCode,
   TimedEvent,
   TraceState,
 } from '@opentelemetry/api';
@@ -192,23 +191,6 @@ export function toCollectorSpan(
   };
 }
 
-/**
- * Converts StatusCode
- * @param code
- */
-export function toCollectorCode(
-  code: StatusCode
-): opentelemetryProto.trace.v1.StatusCode {
-  switch (code) {
-    case StatusCode.OK:
-      return opentelemetryProto.trace.v1.StatusCode.OK;
-    case StatusCode.UNSET:
-      return opentelemetryProto.trace.v1.StatusCode.UNSET;
-    default:
-      return opentelemetryProto.trace.v1.StatusCode.ERROR;
-  }
-}
-
 /**
  * Converts status
  * @param status
@@ -217,7 +199,7 @@ export function toCollectorStatus(
   status: Status
 ): opentelemetryProto.trace.v1.Status {
   const spanStatus: opentelemetryProto.trace.v1.Status = {
-    code: toCollectorCode(status.code),
+    code: status.code,
   };
   if (typeof status.message !== 'undefined') {
     spanStatus.message = status.message;

diff --git a/packages/opentelemetry-exporter-collector/src/types.ts b/packages/opentelemetry-exporter-collector/src/types.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { SpanKind, Logger, Attributes } from '@opentelemetry/api';
+import { Attributes, Logger, SpanKind, StatusCode } from '@opentelemetry/api';
 
 /* eslint-disable @typescript-eslint/no-namespace */
 export namespace opentelemetryProto {
@@ -260,26 +260,6 @@ export namespace opentelemetryProto {
       message?: string;
     }
 
-    /**
-     * An enumeration of status codes.
-     * https://github.com/open-telemetry/opentelemetry-proto/blob/master/opentelemetry/proto/trace/v1/trace.proto#L304
-     */
-    export enum StatusCode {
-      /**
-       * The default status.
-       */
-      UNSET = 0,
-      /**
-       * The operation has been validated by an Application developer or
-       * Operator to have completed successfully.
-       */
-      OK = 1,
-      /**
-       * The operation contains an error.
-       */
-      ERROR = 2,
-    }
-
     export interface TraceConfig {
       constantSampler?: ConstantSampler | null;
       probabilitySampler?: ProbabilitySampler | null;

diff --git a/packages/opentelemetry-exporter-collector/test/helper.ts b/packages/opentelemetry-exporter-collector/test/helper.ts
@@ -515,7 +515,7 @@ export function ensureSpanIsCorrect(
   assert.strictEqual(span.droppedLinksCount, 0, 'droppedLinksCount is wrong');
   assert.deepStrictEqual(
     span.status,
-    { code: opentelemetryProto.trace.v1.StatusCode.OK },
+    { code: StatusCode.OK },
     'status is wrong'
   );
 }

diff --git a/packages/opentelemetry-exporter-jaeger/test/transform.test.ts b/packages/opentelemetry-exporter-jaeger/test/transform.test.ts
@@ -126,7 +126,7 @@ describe('transform', () => {
       assert.strictEqual(tag3.vDouble, 3.142);
       assert.strictEqual(tag4.key, 'status.code');
       assert.strictEqual(tag4.vType, 'DOUBLE');
-      assert.strictEqual(tag4.vDouble, 0);
+      assert.strictEqual(tag4.vDouble, api.StatusCode.OK);
       assert.strictEqual(tag5.key, 'status.name');
       assert.strictEqual(tag5.vType, 'STRING');
       assert.strictEqual(tag5.vStr, 'OK');