refactor(attributes): move enums to @opentelemetry/semantic-conventio…

…ns (#1160)
open-telemetry · Jun 15, 2020 · 0596054 · 0596054
1 parent 9d58227
commit 0596054
Show file tree

Hide file tree

Showing 33 changed files with 668 additions and 223 deletions.
diff --git a/packages/opentelemetry-plugin-grpc/package.json b/packages/opentelemetry-plugin-grpc/package.json
@@ -66,6 +66,7 @@
   "dependencies": {
     "@opentelemetry/api": "^0.8.3",
     "@opentelemetry/core": "^0.8.3",
+    "@opentelemetry/semantic-conventions": "^0.8.3",
     "shimmer": "^1.2.1"
   }
 }
diff --git a/packages/opentelemetry-plugin-grpc/src/grpc.ts b/packages/opentelemetry-plugin-grpc/src/grpc.ts
@@ -23,12 +23,15 @@ import {
   SpanOptions,
   Status,
 } from '@opentelemetry/api';
+import {
+  GeneralAttribute,
+  RpcAttribute,
+} from '@opentelemetry/semantic-conventions';
 import { BasePlugin } from '@opentelemetry/core';
 import * as events from 'events';
 import * as grpcTypes from 'grpc';
 import * as path from 'path';
 import * as shimmer from 'shimmer';
-import { AttributeNames } from './enums/AttributeNames';
 import {
   grpc,
   GrpcClientFunc,
@@ -173,8 +176,8 @@ export class GrpcPlugin extends BasePlugin<grpc> {
                   const span = plugin._tracer
                     .startSpan(spanName, spanOptions)
                     .setAttributes({
-                      [AttributeNames.GRPC_KIND]: spanOptions.kind,
-                      [AttributeNames.COMPONENT]: GrpcPlugin.component,
+                      [RpcAttribute.GRPC_KIND]: spanOptions.kind,
+                      [GeneralAttribute.COMPONENT]: GrpcPlugin.component,
                     });
 
                   plugin._tracer.withSpan(span, () => {
@@ -235,19 +238,16 @@ export class GrpcPlugin extends BasePlugin<grpc> {
             code: _grpcStatusCodeToCanonicalCode(err.code),
             message: err.message,
           });
-          span.setAttribute(
-            AttributeNames.GRPC_STATUS_CODE,
-            err.code.toString()
-          );
+          span.setAttribute(RpcAttribute.GRPC_STATUS_CODE, err.code.toString());
         }
         span.setAttributes({
-          [AttributeNames.GRPC_ERROR_NAME]: err.name,
-          [AttributeNames.GRPC_ERROR_MESSAGE]: err.message,
+          [RpcAttribute.GRPC_ERROR_NAME]: err.name,
+          [RpcAttribute.GRPC_ERROR_MESSAGE]: err.message,
         });
       } else {
         span.setStatus({ code: CanonicalCode.OK });
         span.setAttribute(
-          AttributeNames.GRPC_STATUS_CODE,
+          RpcAttribute.GRPC_STATUS_CODE,
           plugin._moduleExports.status.OK.toString()
         );
       }
@@ -281,7 +281,7 @@ export class GrpcPlugin extends BasePlugin<grpc> {
     call.on('finish', () => {
       span.setStatus(_grpcStatusCodeToSpanStatus(call.status.code));
       span.setAttribute(
-        AttributeNames.GRPC_STATUS_CODE,
+        RpcAttribute.GRPC_STATUS_CODE,
         call.status.code.toString()
       );
 
@@ -299,8 +299,8 @@ export class GrpcPlugin extends BasePlugin<grpc> {
       });
       span.addEvent('finished with error');
       span.setAttributes({
-        [AttributeNames.GRPC_ERROR_NAME]: err.name,
-        [AttributeNames.GRPC_ERROR_MESSAGE]: err.message,
+        [RpcAttribute.GRPC_ERROR_NAME]: err.name,
+        [RpcAttribute.GRPC_ERROR_MESSAGE]: err.message,
       });
       endSpan();
     });
@@ -357,7 +357,7 @@ export class GrpcPlugin extends BasePlugin<grpc> {
           .startSpan(name, {
             kind: SpanKind.CLIENT,
           })
-          .setAttribute(AttributeNames.COMPONENT, GrpcPlugin.component);
+          .setAttribute(GeneralAttribute.COMPONENT, GrpcPlugin.component);
         return plugin._tracer.withSpan(span, () =>
           plugin._makeGrpcClientRemoteCall(original, args, this, plugin)(span)
         );
@@ -388,18 +388,18 @@ export class GrpcPlugin extends BasePlugin<grpc> {
           if (err.code) {
             span.setStatus(_grpcStatusCodeToSpanStatus(err.code));
             span.setAttribute(
-              AttributeNames.GRPC_STATUS_CODE,
+              RpcAttribute.GRPC_STATUS_CODE,
               err.code.toString()
             );
           }
           span.setAttributes({
-            [AttributeNames.GRPC_ERROR_NAME]: err.name,
-            [AttributeNames.GRPC_ERROR_MESSAGE]: err.message,
+            [RpcAttribute.GRPC_ERROR_NAME]: err.name,
+            [RpcAttribute.GRPC_ERROR_MESSAGE]: err.message,
           });
         } else {
           span.setStatus({ code: CanonicalCode.OK });
           span.setAttribute(
-            AttributeNames.GRPC_STATUS_CODE,
+            RpcAttribute.GRPC_STATUS_CODE,
             plugin._moduleExports.status.OK.toString()
           );
         }
@@ -432,8 +432,8 @@ export class GrpcPlugin extends BasePlugin<grpc> {
 
       span.addEvent('sent');
       span.setAttributes({
-        [AttributeNames.GRPC_METHOD]: original.path,
-        [AttributeNames.GRPC_KIND]: SpanKind.CLIENT,
+        [RpcAttribute.GRPC_METHOD]: original.path,
+        [RpcAttribute.GRPC_KIND]: SpanKind.CLIENT,
       });
 
       this._setSpanContext(metadata);
@@ -459,8 +459,8 @@ export class GrpcPlugin extends BasePlugin<grpc> {
               message: err.message,
             });
             span.setAttributes({
-              [AttributeNames.GRPC_ERROR_NAME]: err.name,
-              [AttributeNames.GRPC_ERROR_MESSAGE]: err.message,
+              [RpcAttribute.GRPC_ERROR_NAME]: err.name,
+              [RpcAttribute.GRPC_ERROR_MESSAGE]: err.message,
             });
             endSpan();
           }
@@ -471,7 +471,7 @@ export class GrpcPlugin extends BasePlugin<grpc> {
           (status: Status) => {
             span.setStatus({ code: CanonicalCode.OK });
             span.setAttribute(
-              AttributeNames.GRPC_STATUS_CODE,
+              RpcAttribute.GRPC_STATUS_CODE,
               status.code.toString()
             );
             endSpan();

diff --git a/packages/opentelemetry-plugin-grpc/test/utils/assertionUtils.ts b/packages/opentelemetry-plugin-grpc/test/utils/assertionUtils.ts
@@ -16,14 +16,14 @@
 
 import { SpanKind } from '@opentelemetry/api';
 import * as assert from 'assert';
-import { AttributeNames } from '../../src/enums/AttributeNames';
 import { GrpcPlugin } from '../../src/grpc';
 import * as grpc from 'grpc';
 import { ReadableSpan } from '@opentelemetry/tracing';
 import {
   hrTimeToMilliseconds,
   hrTimeToMicroseconds,
 } from '@opentelemetry/core';
+import { GeneralAttribute } from '@opentelemetry/semantic-conventions';
 
 export const assertSpan = (
   span: ReadableSpan,
@@ -35,7 +35,7 @@ export const assertSpan = (
   assert.strictEqual(span.kind, kind);
 
   assert.strictEqual(
-    span.attributes[AttributeNames.COMPONENT],
+    span.attributes[GeneralAttribute.COMPONENT],
     GrpcPlugin.component
   );
   assert.ok(span.endTime);

diff --git a/packages/opentelemetry-plugin-http/package.json b/packages/opentelemetry-plugin-http/package.json
@@ -72,6 +72,7 @@
   "dependencies": {
     "@opentelemetry/api": "^0.8.3",
     "@opentelemetry/core": "^0.8.3",
+    "@opentelemetry/semantic-conventions": "^0.8.3",
     "semver": "^7.1.3",
     "shimmer": "^1.2.1"
   }

diff --git a/packages/opentelemetry-plugin-http/src/enums/AttributeNames.ts b/packages/opentelemetry-plugin-http/src/enums/AttributeNames.ts
diff --git a/packages/opentelemetry-plugin-http/src/http.ts b/packages/opentelemetry-plugin-http/src/http.ts
@@ -29,6 +29,7 @@ import {
   NoRecordingSpan,
   getExtractedSpanContext,
 } from '@opentelemetry/core';
+import { GeneralAttribute } from '@opentelemetry/semantic-conventions';
 import {
   ClientRequest,
   IncomingMessage,
@@ -40,7 +41,6 @@ import { Socket } from 'net';
 import * as semver from 'semver';
 import * as shimmer from 'shimmer';
 import * as url from 'url';
-import { AttributeNames } from './enums/AttributeNames';
 import {
   Err,
   Func,
@@ -463,7 +463,7 @@ export class HttpPlugin extends BasePlugin<Http> {
     } else {
       span = this._tracer
         .startSpan(name, options)
-        .setAttribute(AttributeNames.COMPONENT, this.component);
+        .setAttribute(GeneralAttribute.COMPONENT, this.component);
     }
     this._spanNotEnded.add(span);
     return span;

diff --git a/packages/opentelemetry-plugin-http/src/index.ts b/packages/opentelemetry-plugin-http/src/index.ts
@@ -17,4 +17,3 @@
 export * from './http';
 export * from './types';
 export * from './utils';
-export * from './enums/AttributeNames';