fix: net instrumentation - change span kind of connect to internal (#394

) Co-authored-by: Valentin Marchaud <thisismac47@gmail.com>
open-telemetry · Mar 24, 2021 · 92656a3 · 92656a3
1 parent 21af6e7
commit 92656a3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 10 deletions.
diff --git a/plugins/node/opentelemetry-instrumentation-net/src/net.ts b/plugins/node/opentelemetry-instrumentation-net/src/net.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { diag, Span, SpanKind, SpanStatusCode } from '@opentelemetry/api';
+import { diag, Span, SpanStatusCode } from '@opentelemetry/api';
 import {
   InstrumentationBase,
   InstrumentationConfig,
@@ -91,9 +91,7 @@ export class NetInstrumentation extends InstrumentationBase<Net> {
 
   /* It might still be useful to pick up errors due to invalid connect arguments. */
   private _startGenericSpan(socket: Socket) {
-    const span = this.tracer.startSpan('connect', {
-      kind: SpanKind.CLIENT,
-    });
+    const span = this.tracer.startSpan('connect');
 
     registerListeners(socket, span);
 
@@ -102,7 +100,6 @@ export class NetInstrumentation extends InstrumentationBase<Net> {
 
   private _startIpcSpan(options: NormalizedOptions, socket: Socket) {
     const span = this.tracer.startSpan('ipc.connect', {
-      kind: SpanKind.CLIENT,
       attributes: {
         [GeneralAttribute.NET_TRANSPORT]: IPC_TRANSPORT,
         [GeneralAttribute.NET_PEER_NAME]: options.path,
@@ -116,7 +113,6 @@ export class NetInstrumentation extends InstrumentationBase<Net> {
 
   private _startTcpSpan(options: NormalizedOptions, socket: Socket) {
     const span = this.tracer.startSpan('tcp.connect', {
-      kind: SpanKind.CLIENT,
       attributes: {
         [GeneralAttribute.NET_TRANSPORT]: GeneralAttribute.IP_TCP,
         [GeneralAttribute.NET_PEER_NAME]: options.host,

diff --git a/plugins/node/opentelemetry-instrumentation-net/test/utils.ts b/plugins/node/opentelemetry-instrumentation-net/test/utils.ts
@@ -28,7 +28,7 @@ export const HOST = 'localhost';
 export const IPC_PATH = path.join(os.tmpdir(), 'otel-js-net-test-ipc');
 
 export function assertTcpSpan(span: ReadableSpan, socket: Socket) {
-  assertClientSpan(span);
+  assertSpanKind(span);
   assertAttrib(span, GeneralAttribute.NET_TRANSPORT, GeneralAttribute.IP_TCP);
   assertAttrib(span, GeneralAttribute.NET_PEER_NAME, HOST);
   assertAttrib(span, GeneralAttribute.NET_PEER_PORT, PORT);
@@ -37,13 +37,13 @@ export function assertTcpSpan(span: ReadableSpan, socket: Socket) {
 }
 
 export function assertIpcSpan(span: ReadableSpan) {
-  assertClientSpan(span);
+  assertSpanKind(span);
   assertAttrib(span, GeneralAttribute.NET_TRANSPORT, IPC_TRANSPORT);
   assertAttrib(span, GeneralAttribute.NET_PEER_NAME, IPC_PATH);
 }
 
-export function assertClientSpan(span: ReadableSpan) {
-  assert.strictEqual(span.kind, SpanKind.CLIENT);
+export function assertSpanKind(span: ReadableSpan) {
+  assert.strictEqual(span.kind, SpanKind.INTERNAL);
 }
 
 export function assertAttrib(span: ReadableSpan, attrib: string, value: any) {