fix!: change status codes from grpc status codes (#1644)

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

packages/opentelemetry-api/README.md

@@ -168,7 +168,7 @@ async function doSomething() {
   } catch (err) {
     span.setStatus({
       // use an appropriate status code here
-      code: api.CanonicalCode.INTERNAL,
+      code: api.StatusCode.ERROR,
       message: err.message,
     });
     span.end();

packages/opentelemetry-api/src/trace/span.ts

@@ -75,7 +75,7 @@ export interface Span {
 
   /**
    * Sets a status to the span. If used, this will override the default Span
-   * status. Default is {@link CanonicalCode.OK}. SetStatus overrides the value
+   * status. Default is {@link StatusCode.UNSET}. SetStatus overrides the value
    * of previous calls to SetStatus on the Span.
    *
    * @param status the Status to set.

packages/opentelemetry-api/src/trace/status.ts

@@ -14,145 +14,27 @@
  * limitations under the License.
  */
 export interface Status {
-  /** The canonical code of this message. */
-  code: CanonicalCode;
+  /** The status code of this message. */
+  code: StatusCode;
   /** A developer-facing error message. */
   message?: string;
 }
 
 /**
- * An enumeration of canonical status codes.
+ * An enumeration of status codes.
  */
-export enum CanonicalCode {
+export enum StatusCode {
   /**
-   * Not an error; returned on success
+   * The operation has been validated by an Application developer or
+   * Operator to have completed successfully.
    */
   OK = 0,
   /**
-   * The operation was cancelled (typically by the caller).
+   * The default status.
    */
-  CANCELLED = 1,
+  UNSET = 1,
   /**
-   * Unknown error.  An example of where this error may be returned is
-   * if a status value received from another address space belongs to
-   * an error-space that is not known in this address space.  Also
-   * errors raised by APIs that do not return enough error information
-   * may be converted to this error.
+   * The operation contains an error.
    */
-  UNKNOWN = 2,
-  /**
-   * Client specified an invalid argument.  Note that this differs
-   * from FAILED_PRECONDITION.  INVALID_ARGUMENT indicates arguments
-   * that are problematic regardless of the state of the system
-   * (e.g., a malformed file name).
-   */
-  INVALID_ARGUMENT = 3,
-  /**
-   * Deadline expired before operation could complete.  For operations
-   * that change the state of the system, this error may be returned
-   * even if the operation has completed successfully.  For example, a
-   * successful response from a server could have been delayed long
-   * enough for the deadline to expire.
-   */
-  DEADLINE_EXCEEDED = 4,
-  /**
-   * Some requested entity (e.g., file or directory) was not found.
-   */
-  NOT_FOUND = 5,
-  /**
-   * Some entity that we attempted to create (e.g., file or directory)
-   * already exists.
-   */
-  ALREADY_EXISTS = 6,
-  /**
-   * The caller does not have permission to execute the specified
-   * operation.  PERMISSION_DENIED must not be used for rejections
-   * caused by exhausting some resource (use RESOURCE_EXHAUSTED
-   * instead for those errors).  PERMISSION_DENIED must not be
-   * used if the caller can not be identified (use UNAUTHENTICATED
-   * instead for those errors).
-   */
-  PERMISSION_DENIED = 7,
-  /**
-   * Some resource has been exhausted, perhaps a per-user quota, or
-   * perhaps the entire file system is out of space.
-   */
-  RESOURCE_EXHAUSTED = 8,
-  /**
-   * Operation was rejected because the system is not in a state
-   * required for the operation's execution.  For example, directory
-   * to be deleted may be non-empty, an rmdir operation is applied to
-   * a non-directory, etc.
-   *
-   * A litmus test that may help a service implementor in deciding
-   * between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE:
-   *
-   *  - Use UNAVAILABLE if the client can retry just the failing call.
-   *  - Use ABORTED if the client should retry at a higher-level
-   *    (e.g., restarting a read-modify-write sequence).
-   *  - Use FAILED_PRECONDITION if the client should not retry until
-   *    the system state has been explicitly fixed.  E.g., if an "rmdir"
-   *    fails because the directory is non-empty, FAILED_PRECONDITION
-   *    should be returned since the client should not retry unless
-   *    they have first fixed up the directory by deleting files from it.
-   *  - Use FAILED_PRECONDITION if the client performs conditional
-   *    REST Get/Update/Delete on a resource and the resource on the
-   *    server does not match the condition. E.g., conflicting
-   *    read-modify-write on the same resource.
-   */
-  FAILED_PRECONDITION = 9,
-  /**
-   * The operation was aborted, typically due to a concurrency issue
-   * like sequencer check failures, transaction aborts, etc.
-   *
-   * See litmus test above for deciding between FAILED_PRECONDITION,
-   * ABORTED, and UNAVAILABLE.
-   */
-  ABORTED = 10,
-  /**
-   * Operation was attempted past the valid range.  E.g., seeking or
-   * reading past end of file.
-   *
-   * Unlike INVALID_ARGUMENT, this error indicates a problem that may
-   * be fixed if the system state changes. For example, a 32-bit file
-   * system will generate INVALID_ARGUMENT if asked to read at an
-   * offset that is not in the range [0,2^32-1], but it will generate
-   * OUT_OF_RANGE if asked to read from an offset past the current
-   * file size.
-   *
-   * There is a fair bit of overlap between FAILED_PRECONDITION and
-   * OUT_OF_RANGE.  We recommend using OUT_OF_RANGE (the more specific
-   * error) when it applies so that callers who are iterating through
-   * a space can easily look for an OUT_OF_RANGE error to detect when
-   * they are done.
-   */
-  OUT_OF_RANGE = 11,
-  /**
-   * Operation is not implemented or not supported/enabled in this service.
-   */
-  UNIMPLEMENTED = 12,
-  /**
-   * Internal errors.  Means some invariants expected by underlying
-   * system has been broken.  If you see one of these errors,
-   * something is very broken.
-   */
-  INTERNAL = 13,
-  /**
-   * The service is currently unavailable.  This is a most likely a
-   * transient condition and may be corrected by retrying with
-   * a backoff.
-   *
-   * See litmus test above for deciding between FAILED_PRECONDITION,
-   * ABORTED, and UNAVAILABLE.
-   */
-  UNAVAILABLE = 14,
-  /**
-   * Unrecoverable data loss or corruption.
-   */
-  DATA_LOSS = 15,
-  /**
-   * The request does not have valid authentication credentials for the
-   * operation.
-   */
-  UNAUTHENTICATED = 16,
+  ERROR = 2,
 }

packages/opentelemetry-api/test/noop-implementations/noop-span.test.ts

@@ -16,7 +16,7 @@
 
 import * as assert from 'assert';
 import {
-  CanonicalCode,
+  StatusCode,
   INVALID_SPANID,
   INVALID_TRACEID,
   NoopSpan,
@@ -39,7 +39,7 @@ describe('NoopSpan', () => {
     span.addEvent('sent');
     span.addEvent('sent', { id: '42', key: 'value' });
 
-    span.setStatus({ code: CanonicalCode.CANCELLED });
+    span.setStatus({ code: StatusCode.ERROR });
 
     span.updateName('my-span');
 

packages/opentelemetry-exporter-collector-grpc/test/helper.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { TraceFlags, ValueType } from '@opentelemetry/api';
+import { TraceFlags, ValueType, StatusCode } from '@opentelemetry/api';
 import { ReadableSpan } from '@opentelemetry/tracing';
 import { Resource } from '@opentelemetry/resources';
 import { collectorTypes } from '@opentelemetry/exporter-collector';
@@ -123,7 +123,7 @@ export const mockedReadableSpan: ReadableSpan = {
   startTime: [1574120165, 429803070],
   endTime: [1574120165, 438688070],
   ended: true,
-  status: { code: 0 },
+  status: { code: StatusCode.OK },
   attributes: { component: 'document-load' },
   links: [
     {

packages/opentelemetry-exporter-collector-proto/test/helper.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { TraceFlags, ValueType } from '@opentelemetry/api';
+import { TraceFlags, ValueType, StatusCode } from '@opentelemetry/api';
 import { hexToBase64 } from '@opentelemetry/core';
 import { ReadableSpan } from '@opentelemetry/tracing';
 import { Resource } from '@opentelemetry/resources';
@@ -106,7 +106,7 @@ export const mockedReadableSpan: ReadableSpan = {
   startTime: [1574120165, 429803070],
   endTime: [1574120165, 438688070],
   ended: true,
-  status: { code: 0 },
+  status: { code: StatusCode.OK },
   attributes: { component: 'document-load' },
   links: [
     {

packages/opentelemetry-exporter-collector/test/helper.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { TraceFlags, ValueType } from '@opentelemetry/api';
+import { TraceFlags, ValueType, StatusCode } from '@opentelemetry/api';
 import { ReadableSpan } from '@opentelemetry/tracing';
 import { Resource } from '@opentelemetry/resources';
 import { MetricRecord, MeterProvider } from '@opentelemetry/metrics';
@@ -115,7 +115,7 @@ export const mockedReadableSpan: ReadableSpan = {
   startTime: [1574120165, 429803070],
   endTime: [1574120165, 438688070],
   ended: true,
-  status: { code: 0 },
+  status: { code: StatusCode.OK },
   attributes: { component: 'document-load' },
   links: [
     {
@@ -186,7 +186,7 @@ export const basicTrace: ReadableSpan[] = [
     startTime: [1574120165, 429803070],
     endTime: [1574120165, 438688070],
     ended: true,
-    status: { code: 0 },
+    status: { code: StatusCode.OK },
     attributes: {},
     links: [],
     events: [],
@@ -206,7 +206,7 @@ export const basicTrace: ReadableSpan[] = [
     startTime: [1575120165, 439803070],
     endTime: [1575120165, 448688070],
     ended: true,
-    status: { code: 0 },
+    status: { code: StatusCode.OK },
     attributes: {},
     links: [],
     events: [],
@@ -226,7 +226,7 @@ export const basicTrace: ReadableSpan[] = [
     startTime: [1575120165, 439803070],
     endTime: [1575120165, 448688070],
     ended: true,
-    status: { code: 0 },
+    status: { code: StatusCode.OK },
     attributes: {},
     links: [],
     events: [],
@@ -462,7 +462,11 @@ export function ensureSpanIsCorrect(
   );
   assert.strictEqual(span.droppedEventsCount, 0, 'droppedEventsCount is wrong');
   assert.strictEqual(span.droppedLinksCount, 0, 'droppedLinksCount is wrong');
-  assert.deepStrictEqual(span.status, { code: 0 }, 'status is wrong');
+  assert.deepStrictEqual(
+    span.status,
+    { code: StatusCode.OK },
+    'status is wrong'
+  );
 }
 
 export function ensureWebResourceIsCorrect(

packages/opentelemetry-exporter-jaeger/src/transform.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Link, CanonicalCode, SpanKind } from '@opentelemetry/api';
+import { Link, StatusCode, SpanKind } from '@opentelemetry/api';
 import { ReadableSpan } from '@opentelemetry/tracing';
 import {
   hrTimeToMilliseconds,
@@ -51,13 +51,13 @@ export function spanToThrift(span: ReadableSpan): ThriftSpan {
     (name): Tag => ({ key: name, value: toTagValue(span.attributes[name]) })
   );
   tags.push({ key: 'status.code', value: span.status.code });
-  tags.push({ key: 'status.name', value: CanonicalCode[span.status.code] });
+  tags.push({ key: 'status.name', value: StatusCode[span.status.code] });
   if (span.status.message) {
     tags.push({ key: 'status.message', value: span.status.message });
   }
   // Ensure that if Status.Code is not OK, that we set the "error" tag on the
   // Jaeger span.
-  if (span.status.code !== CanonicalCode.OK) {
+  if (span.status.code !== StatusCode.OK) {
     tags.push({ key: 'error', value: true });
   }
 

packages/opentelemetry-exporter-jaeger/test/jaeger.test.ts

@@ -122,7 +122,7 @@ describe('JaegerExporter', () => {
       endTime: [1566156731, 709],
       ended: true,
       status: {
-        code: api.CanonicalCode.DATA_LOSS,
+        code: api.StatusCode.ERROR,
       },
       attributes: {},
       links: [],

packages/opentelemetry-exporter-jaeger/test/transform.test.ts

@@ -40,7 +40,7 @@ describe('transform', () => {
         endTime: [1566156731, 709],
         ended: true,
         status: {
-          code: api.CanonicalCode.OK,
+          code: api.StatusCode.OK,
         },
         attributes: {
           testBool: true,
@@ -165,7 +165,7 @@ describe('transform', () => {
         endTime: [1566156731, 709],
         ended: true,
         status: {
-          code: api.CanonicalCode.DATA_LOSS,
+          code: api.StatusCode.ERROR,
           message: 'data loss',
         },
         attributes: {},
@@ -202,10 +202,10 @@ describe('transform', () => {
       const [tag1, tag2, tag3, tag4, tag5] = thriftSpan.tags;
       assert.strictEqual(tag1.key, 'status.code');
       assert.strictEqual(tag1.vType, 'DOUBLE');
-      assert.strictEqual(tag1.vDouble, 15);
+      assert.strictEqual(tag1.vDouble, 2);
       assert.strictEqual(tag2.key, 'status.name');
       assert.strictEqual(tag2.vType, 'STRING');
-      assert.strictEqual(tag2.vStr, 'DATA_LOSS');
+      assert.strictEqual(tag2.vStr, 'ERROR');
       assert.strictEqual(tag3.key, 'status.message');
       assert.strictEqual(tag3.vType, 'STRING');
       assert.strictEqual(tag3.vStr, 'data loss');
@@ -227,7 +227,7 @@ describe('transform', () => {
         endTime: [1566156731, 709],
         ended: true,
         status: {
-          code: api.CanonicalCode.OK,
+          code: api.StatusCode.OK,
         },
         attributes: {},
         parentSpanId: '3e0c63257de34c92',
@@ -277,7 +277,7 @@ describe('transform', () => {
         endTime: [1566156731, 709],
         ended: true,
         status: {
-          code: api.CanonicalCode.DATA_LOSS,
+          code: api.StatusCode.ERROR,
           message: 'data loss',
         },
         attributes: {},

packages/opentelemetry-exporter-zipkin/src/transform.ts

@@ -78,7 +78,7 @@ export function _toZipkinTags(
   for (const key of Object.keys(attributes)) {
     tags[key] = String(attributes[key]);
   }
-  tags[statusCodeTagName] = String(api.CanonicalCode[status.code]);
+  tags[statusCodeTagName] = String(api.StatusCode[status.code]);
   if (status.message) {
     tags[statusDescriptionTagName] = status.message;
   }