From 5d949bc00a0defb5c523aa4eede0cd84154b8c22 Mon Sep 17 00:00:00 2001
From: JamieDanielson <jamieedanielson@gmail.com>
Date: Thu, 19 Sep 2024 17:41:26 -0400
Subject: [PATCH] wip: add semconv stability opt-in logic

---
 .../src/instrumentation.ts                    | 59 ++++++++++++++++---
 .../src/types.ts                              | 15 +++++
 .../test/helper.ts                            |  2 +
 3 files changed, 67 insertions(+), 9 deletions(-)

diff --git a/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts b/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts
index 139c83ee012..9a1aa048021 100644
--- a/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts
+++ b/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts
@@ -41,8 +41,10 @@ import type {
   metadataCaptureType,
 } from './internal-types';
 import type { GrpcInstrumentationConfig } from './types';
+import { SemconvStability } from './types';
 
 import {
+  Attributes,
   context,
   propagation,
   ROOT_CONTEXT,
@@ -51,6 +53,7 @@ import {
   trace,
   Span,
 } from '@opentelemetry/api';
+import { getEnv } from '@opentelemetry/core';
 import {
   InstrumentationNodeModuleDefinition,
   InstrumentationBase,
@@ -92,9 +95,21 @@ import { VERSION } from './version';
 export class GrpcInstrumentation extends InstrumentationBase<GrpcInstrumentationConfig> {
   private _metadataCapture: metadataCaptureType;
 
+  private _semconvStability = SemconvStability.OLD;
+
   constructor(config: GrpcInstrumentationConfig = {}) {
     super('@opentelemetry/instrumentation-grpc', VERSION, config);
     this._metadataCapture = this._createMetadataCapture();
+
+    for (const entry in getEnv().OTEL_SEMCONV_STABILITY_OPT_IN) {
+      if (entry.toLowerCase() === 'http/dup') {
+        // http/dup takes highest precedence. If it is found, there is no need to read the rest of the list
+        this._semconvStability = SemconvStability.DUPLICATE;
+        break;
+      } else if (entry.toLowerCase() === 'http') {
+        this._semconvStability = SemconvStability.STABLE;
+      }
+    }
   }
 
   init() {
@@ -328,7 +343,11 @@ export class GrpcInstrumentation extends InstrumentationBase<GrpcInstrumentation
           service,
           metadata
         );
-        instrumentation.extractNetMetadata(this, span);
+        instrumentation.extractNetMetadata(
+          this,
+          span,
+          instrumentation._semconvStability
+        );
 
         // Callback is only present when there is no responseStream
         if (!hasResponseStream) {
@@ -441,7 +460,11 @@ export class GrpcInstrumentation extends InstrumentationBase<GrpcInstrumentation
             [SEMATTRS_RPC_METHOD]: method,
             [SEMATTRS_RPC_SERVICE]: service,
           });
-        instrumentation.extractNetMetadata(this, span);
+        instrumentation.extractNetMetadata(
+          this,
+          span,
+          instrumentation._semconvStability
+        );
 
         instrumentation._metadataCapture.client.captureRequestMetadata(
           span,
@@ -493,15 +516,33 @@ export class GrpcInstrumentation extends InstrumentationBase<GrpcInstrumentation
     return span;
   }
 
-  private extractNetMetadata(client: grpcJs.Client, span: Span) {
+  private extractNetMetadata(
+    client: grpcJs.Client,
+    span: Span,
+    semconvStability: SemconvStability
+  ) {
     // set net.peer.* from target (e.g., "dns:otel-productcatalogservice:8080") as a hint to APMs
     const parsedUri = URI_REGEX.exec(client.getChannel().getTarget());
-    if (parsedUri != null && parsedUri.groups != null) {
-      span.setAttribute(SEMATTRS_NET_PEER_NAME, parsedUri.groups['name']);
-      span.setAttribute(
-        SEMATTRS_NET_PEER_PORT,
-        parseInt(parsedUri.groups['port'])
-      );
+    const hostname = parsedUri?.groups?.name;
+    const port = parseInt(parsedUri?.groups?.port ?? '');
+    const oldAttributes: Attributes = {
+      [SEMATTRS_NET_PEER_NAME]: hostname,
+      [SEMATTRS_NET_PEER_PORT]: port,
+    };
+    const newAttributes: Attributes = {
+      [ATTR_CLIENT_ADDRESS]: hostname,
+      [ATTR_CLIENT_PORT]: port,
+    };
+    switch (semconvStability) {
+      case SemconvStability.STABLE:
+        span.setAttributes(newAttributes);
+        break;
+      case SemconvStability.OLD:
+        span.setAttributes(oldAttributes);
+        break;
+      case SemconvStability.DUPLICATE:
+        span.setAttributes({ ...oldAttributes, ...newAttributes });
+        break;
     }
   }
 
diff --git a/experimental/packages/opentelemetry-instrumentation-grpc/src/types.ts b/experimental/packages/opentelemetry-instrumentation-grpc/src/types.ts
index 430476b7a47..37a7690889f 100644
--- a/experimental/packages/opentelemetry-instrumentation-grpc/src/types.ts
+++ b/experimental/packages/opentelemetry-instrumentation-grpc/src/types.ts
@@ -35,3 +35,18 @@ export interface GrpcInstrumentationConfig extends InstrumentationConfig {
     };
   };
 }
+
+/**
+ * Tracks whether this instrumentation emits old experimental,
+ * new stable, or both semantic conventions.
+ *
+ * Enum values chosen such that the enum may be used as a bitmask.
+ */
+export const enum SemconvStability {
+  /** Emit only stable semantic conventions */
+  STABLE = 0x1,
+  /** Emit only old semantic convetions */
+  OLD = 0x2,
+  /** Emit both stable and old semantic convetions */
+  DUPLICATE = 0x1 | 0x2,
+}
diff --git a/experimental/packages/opentelemetry-instrumentation-grpc/test/helper.ts b/experimental/packages/opentelemetry-instrumentation-grpc/test/helper.ts
index 131dde04b4b..3e7cce5983b 100644
--- a/experimental/packages/opentelemetry-instrumentation-grpc/test/helper.ts
+++ b/experimental/packages/opentelemetry-instrumentation-grpc/test/helper.ts
@@ -51,6 +51,7 @@ import { assertPropagation, assertSpan } from './utils/assertionUtils';
 import { promisify } from 'util';
 import type { GrpcInstrumentation } from '../src';
 import * as path from 'path';
+import { SemconvStability } from '../src/types';
 
 const PROTO_PATH = path.resolve(__dirname, './fixtures/grpc-test.proto');
 const memoryExporter = new InMemorySpanExporter();
@@ -969,6 +970,7 @@ export const runTests = (
             },
           },
         });
+        plugin['_semconvStability'] = SemconvStability.OLD;
 
         plugin.setTracerProvider(provider);
         plugin.enable();