Merge branch 'main' into ts4

open-telemetry · May 8, 2021 · 3294280 · 3294280
2 parents 7fabb5c + 2cbf8e7
commit 3294280
Show file tree

Hide file tree

Showing 31 changed files with 526 additions and 66 deletions.
diff --git a/examples/network/client.js b/examples/network/client.js
@@ -0,0 +1,51 @@
+'use strict';
+
+const { diag, DiagConsoleLogger, DiagLogLevel } = require('@opentelemetry/api');
+const { NodeTracerProvider } = require('@opentelemetry/node');
+const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
+const { NetInstrumentation } = require('@opentelemetry/instrumentation-net');
+const { DnsInstrumentation } = require('@opentelemetry/instrumentation-dns');
+const { registerInstrumentations } = require('@opentelemetry/instrumentation');
+const { SimpleSpanProcessor, ConsoleSpanExporter } = require('@opentelemetry/tracing');
+const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
+
+const provider = new NodeTracerProvider();
+
+provider.addSpanProcessor(new SimpleSpanProcessor(new JaegerExporter({
+  serviceName: 'http-client',
+})));
+
+provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
+
+provider.register();
+
+diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ALL);
+
+registerInstrumentations({
+  instrumentations: [
+    new NetInstrumentation(),
+    new HttpInstrumentation(),
+    new DnsInstrumentation({
+      // Avoid dns lookup loop with http zipkin calls
+      ignoreHostnames: ['localhost'],
+    }),
+  ],
+  tracerProvider: provider,
+});
+
+require('net');
+require('dns');
+const https = require('https');
+const http = require('http');
+
+http.get('http://opentelemetry.io/', () => {}).on('error', (e) => {
+  console.error(e);
+});
+
+https.get('https://opentelemetry.io/', () => {}).on('error', (e) => {
+  console.error(e);
+});
+
+https.get('https://opentelemetry.io/', { ca: [] }, () => {}).on('error', (e) => {
+  console.error(e);
+});
diff --git a/examples/network/package.json b/examples/network/package.json
@@ -0,0 +1,44 @@
+{
+  "name": "tls-example",
+  "private": true,
+  "version": "0.15.0",
+  "description": "Example of NET & TLS integration with OpenTelemetry",
+  "main": "index.js",
+  "scripts": {
+    "zipkin:client": "cross-env EXPORTER=zipkin node ./client.js",
+    "jaeger:client": "cross-env EXPORTER=jaeger node ./client.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://[email protected]/open-telemetry/opentelemetry-js-contrib.git"
+  },
+  "keywords": [
+    "opentelemetry",
+    "net",
+    "tls",
+    "tracing"
+  ],
+  "engines": {
+    "node": ">=8.5.0"
+  },
+  "author": "OpenTelemetry Authors",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/open-telemetry/opentelemetry-js-contrib/issues"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^0.18.1",
+    "@opentelemetry/exporter-jaeger": "^0.18.2",
+    "@opentelemetry/exporter-zipkin": "^0.18.2",
+    "@opentelemetry/instrumentation": "^0.18.2",
+    "@opentelemetry/instrumentation-net": "file:../../plugins/node/opentelemetry-instrumentation-net",
+    "@opentelemetry/instrumentation-http": "^0.19.0",
+    "@opentelemetry/instrumentation-dns": "^0.15.0",
+    "@opentelemetry/node": "^0.18.2",
+    "@opentelemetry/tracing": "^0.18.2"
+  },
+  "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib#readme",
+  "devDependencies": {
+    "cross-env": "^6.0.3"
+  }
+}
diff --git a/examples/restify/package.json b/examples/restify/package.json
@@ -33,6 +33,7 @@
     "@opentelemetry/exporter-zipkin": "^0.19.0",
     "@opentelemetry/instrumentation": "^0.19.0",
     "@opentelemetry/instrumentation-http": "^0.19.0",
+    "@opentelemetry/instrumentation-restify": "^0.16.0",
     "@opentelemetry/node": "^0.19.0",
     "@opentelemetry/tracing": "^0.19.0",
     "restify": "^4.3.4"

diff --git a/metapackages/auto-instrumentations-node/package.json b/metapackages/auto-instrumentations-node/package.json
@@ -37,8 +37,6 @@
     "rimraf": "3.0.2",
     "sinon": "10.0.0",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/packages/opentelemetry-test-utils/package.json b/packages/opentelemetry-test-utils/package.json
@@ -26,8 +26,6 @@
   "devDependencies": {
     "@types/node": "14.14.43",
     "gts": "3.1.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json b/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json
@@ -50,8 +50,6 @@
     "nyc": "15.1.0",
     "rimraf": "3.0.2",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/package.json b/plugins/node/opentelemetry-instrumentation-bunyan/package.json
@@ -56,8 +56,6 @@
     "rimraf": "3.0.2",
     "sinon": "9.2.4",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-dns/package.json b/plugins/node/opentelemetry-instrumentation-dns/package.json
@@ -56,8 +56,6 @@
     "rimraf": "3.0.2",
     "sinon": "10.0.0",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-express/README.md b/plugins/node/opentelemetry-instrumentation-express/README.md
@@ -12,7 +12,7 @@ For automatic instrumentation see the
 
 ## Installation
 
-This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both.
+This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will not see any spans being exported from the instrumentation.
 
 ```bash
 npm install --save @opentelemetry/instrumentation-http @opentelemetry/instrumentation-express

diff --git a/plugins/node/opentelemetry-instrumentation-express/package.json b/plugins/node/opentelemetry-instrumentation-express/package.json
@@ -54,8 +54,6 @@
     "nyc": "15.1.0",
     "rimraf": "3.0.2",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-hapi/package.json b/plugins/node/opentelemetry-instrumentation-hapi/package.json
@@ -54,8 +54,6 @@
     "rimraf": "3.0.2",
     "semver": "7.3.5",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/package.json b/plugins/node/opentelemetry-instrumentation-ioredis/package.json
@@ -58,8 +58,6 @@
     "nyc": "15.1.0",
     "rimraf": "3.0.2",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-koa/package.json b/plugins/node/opentelemetry-instrumentation-koa/package.json
@@ -56,8 +56,6 @@
     "nyc": "15.1.0",
     "rimraf": "3.0.2",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/package.json b/plugins/node/opentelemetry-instrumentation-mongodb/package.json
@@ -55,8 +55,6 @@
     "nyc": "15.1.0",
     "rimraf": "3.0.2",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-mysql/package.json b/plugins/node/opentelemetry-instrumentation-mysql/package.json
@@ -53,8 +53,6 @@
     "nyc": "15.1.0",
     "rimraf": "3.0.2",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-net/package.json b/plugins/node/opentelemetry-instrumentation-net/package.json
@@ -54,8 +54,6 @@
     "rimraf": "3.0.2",
     "sinon": "10.0.0",
     "ts-mocha": "8.0.0",
-    "tslint-consistent-codestyle": "1.16.0",
-    "tslint-microsoft-contrib": "6.2.0",
     "typescript": "4.2.4"
   },
   "dependencies": {

diff --git a/plugins/node/opentelemetry-instrumentation-net/src/net.ts b/plugins/node/opentelemetry-instrumentation-net/src/net.ts
@@ -26,10 +26,11 @@ import {
   SemanticAttributes,
   NetTransportValues,
 } from '@opentelemetry/semantic-conventions';
-import { Net, NormalizedOptions, SocketEvent } from './types';
+import { Net, NormalizedOptions, SocketEvent, TLSAttributes } from './types';
 import { getNormalizedArgs, IPC_TRANSPORT } from './utils';
 import { VERSION } from './version';
 import { Socket } from 'net';
+import { TLSSocket } from 'tls';
 
 export class NetInstrumentation extends InstrumentationBase<Net> {
   constructor(protected _config: InstrumentationConfig = {}) {
@@ -69,11 +70,10 @@ export class NetInstrumentation extends InstrumentationBase<Net> {
       return function patchedConnect(this: Socket, ...args: unknown[]) {
         const options = getNormalizedArgs(args);
 
-        const span = options
-          ? options.path
-            ? plugin._startIpcSpan(options, this)
-            : plugin._startTcpSpan(options, this)
-          : plugin._startGenericSpan(this);
+        const span =
+          this instanceof TLSSocket
+            ? plugin._startTLSSpan(options, this)
+            : plugin._startSpan(options, this);
 
         return safeExecuteInTheMiddle(
           () => original.apply(this, args),
@@ -92,6 +92,77 @@ export class NetInstrumentation extends InstrumentationBase<Net> {
     };
   }
 
+  private _startSpan(
+    options: NormalizedOptions | undefined | null,
+    socket: Socket
+  ) {
+    if (!options) {
+      return this._startGenericSpan(socket);
+    }
+    if (options.path) {
+      return this._startIpcSpan(options, socket);
+    }
+    return this._startTcpSpan(options, socket);
+  }
+
+  private _startTLSSpan(
+    options: NormalizedOptions | undefined | null,
+    socket: TLSSocket
+  ) {
+    const tlsSpan = this.tracer.startSpan('tls.connect');
+
+    const netSpan = this._startSpan(options, socket);
+
+    const otelTlsSpanListener = () => {
+      const peerCertificate = socket.getPeerCertificate(true);
+      const cipher = socket.getCipher();
+      const protocol = socket.getProtocol();
+      const attributes = {
+        [TLSAttributes.PROTOCOL]: String(protocol),
+        [TLSAttributes.AUTHORIZED]: String(socket.authorized),
+        [TLSAttributes.CIPHER_NAME]: cipher.name,
+        [TLSAttributes.CIPHER_VERSION]: cipher.version,
+        [TLSAttributes.CERTIFICATE_FINGERPRINT]: peerCertificate.fingerprint,
+        [TLSAttributes.CERTIFICATE_SERIAL_NUMBER]: peerCertificate.serialNumber,
+        [TLSAttributes.CERTIFICATE_VALID_FROM]: peerCertificate.valid_from,
+        [TLSAttributes.CERTIFICATE_VALID_TO]: peerCertificate.valid_to,
+        [TLSAttributes.ALPN_PROTOCOL]: '',
+      };
+      if (socket.alpnProtocol) {
+        attributes[TLSAttributes.ALPN_PROTOCOL] = socket.alpnProtocol;
+      }
+
+      tlsSpan.setAttributes(attributes);
+      tlsSpan.end();
+    };
+
+    const otelTlsErrorListener = (e: Error) => {
+      tlsSpan.setStatus({
+        code: SpanStatusCode.ERROR,
+        message: e.message,
+      });
+      tlsSpan.end();
+    };
+
+    /* if we use once and tls.connect() uses a callback this is never executed */
+    socket.prependOnceListener(SocketEvent.SECURE_CONNECT, otelTlsSpanListener);
+    socket.once(SocketEvent.ERROR, otelTlsErrorListener);
+
+    const otelTlsRemoveListeners = () => {
+      socket.removeListener(SocketEvent.SECURE_CONNECT, otelTlsSpanListener);
+      socket.removeListener(SocketEvent.ERROR, otelTlsErrorListener);
+      for (const event of SOCKET_EVENTS) {
+        socket.removeListener(event, otelTlsRemoveListeners);
+      }
+    };
+
+    for (const event of [SocketEvent.CLOSE, SocketEvent.ERROR]) {
+      socket.once(event, otelTlsRemoveListeners);
+    }
+
+    return netSpan;
+  }
+
   /* It might still be useful to pick up errors due to invalid connect arguments. */
   private _startGenericSpan(socket: Socket) {
     const span = this.tracer.startSpan('connect');

diff --git a/plugins/node/opentelemetry-instrumentation-net/src/types.ts b/plugins/node/opentelemetry-instrumentation-net/src/types.ts
@@ -28,4 +28,18 @@ export enum SocketEvent {
   CLOSE = 'close',
   CONNECT = 'connect',
   ERROR = 'error',
+  SECURE_CONNECT = 'secureConnect',
+}
+
+/* The following attributes are not offical, see open-telemetry/opentelemetry-specification#1652 */
+export enum TLSAttributes {
+  PROTOCOL = 'tls.protocol',
+  AUTHORIZED = 'tls.authorized',
+  CIPHER_NAME = 'tls.cipher.name',
+  CIPHER_VERSION = 'tls.cipher.version',
+  CERTIFICATE_FINGERPRINT = 'tls.certificate.fingerprint',
+  CERTIFICATE_SERIAL_NUMBER = 'tls.certificate.serialNumber',
+  CERTIFICATE_VALID_FROM = 'tls.certificate.validFrom',
+  CERTIFICATE_VALID_TO = 'tls.certificate.validTo',
+  ALPN_PROTOCOL = 'tls.alpnProtocol',
 }