chore: update ioredis for tracer registry

packages/opentelemetry-plugin-ioredis/package.json

@@ -13,7 +13,8 @@
     "clean": "rimraf build/*",
     "check": "gts check",
     "precompile": "tsc --version",
-    "compile": "tsc -p .",
+    "version:update": "node scripts/version-update.js",
+    "compile": "npm run version:update && tsc -p .",
     "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
     "fix": "gts fix",
     "prepare": "npm run compile"

packages/opentelemetry-plugin-ioredis/scripts/version-update.js

@@ -0,0 +1,47 @@
+/*!
+ * Copyright 2019, OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const license =
+`/*!
+ * Copyright 2019, OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+`;
+
+const fs = require('fs');
+const path = require('path');
+
+const appRoot = path.resolve(__dirname);
+const fileUrl = path.resolve(`${appRoot}/../src/version.ts`);
+const packageJsonUrl = path.resolve(`${appRoot}/../package.json`);
+const pjson = require(packageJsonUrl);
+const content = `
+// this is autogenerated file, see scripts/version-update.js
+export const VERSION = '${pjson.version}';
+`;
+
+fs.writeFileSync(fileUrl, `${license}${content}`);

packages/opentelemetry-plugin-ioredis/src/ioredis.ts

@@ -18,14 +18,15 @@ import { BasePlugin } from '@opentelemetry/core';
 import * as ioredisTypes from 'ioredis';
 import * as shimmer from 'shimmer';
 import { traceConnection, traceSendCommand } from './utils';
+import { VERSION } from './version';
 
 export class IORedisPlugin extends BasePlugin<typeof ioredisTypes> {
   static readonly COMPONENT = 'ioredis';
   static readonly DB_TYPE = 'redis';
   readonly supportedVersions = ['^2.0.0'];
 
   constructor(readonly moduleName: string) {
-    super();
+    super('@opentelemetry/plugin-ioredis', VERSION);
   }
 
   protected patch(): typeof ioredisTypes {

packages/opentelemetry-plugin-ioredis/src/version.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright 2019, OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// this is autogenerated file, see scripts/version-update.js
+export const VERSION = '0.3.1';

packages/opentelemetry-plugin-ioredis/test/ioredis.test.ts

@@ -19,7 +19,7 @@ import {
   InMemorySpanExporter,
   SimpleSpanProcessor,
 } from '@opentelemetry/tracing';
-import { NodeTracer } from '@opentelemetry/node';
+import { NodeTracerRegistry } from '@opentelemetry/node';
 import { plugin, IORedisPlugin } from '../src';
 import * as ioredisTypes from 'ioredis';
 import { NoopLogger } from '@opentelemetry/core';
@@ -49,7 +49,7 @@ const okStatus: Status = {
 };
 
 describe('ioredis', () => {
-  const tracer = new NodeTracer();
+  const registry = new NodeTracerRegistry();
   let ioredis: typeof ioredisTypes;
   const shouldTestLocal = process.env.RUN_REDIS_TESTS_LOCAL;
   const shouldTest = process.env.RUN_REDIS_TESTS || shouldTestLocal;
@@ -68,8 +68,8 @@ describe('ioredis', () => {
     }
 
     ioredis = require('ioredis');
-    tracer.addSpanProcessor(new SimpleSpanProcessor(memoryExporter));
-    plugin.enable(ioredis, tracer, new NoopLogger());
+    registry.addSpanProcessor(new SimpleSpanProcessor(memoryExporter));
+    plugin.enable(ioredis, registry, new NoopLogger());
   });
 
   after(() => {
@@ -84,7 +84,7 @@ describe('ioredis', () => {
 
   describe('#createClient()', () => {
     it('should propagate the current span to event handlers', done => {
-      const span = tracer.startSpan('test span');
+      const span = registry.getTracer("ioredis-test").startSpan('test span');
       let client: ioredisTypes.Redis;
       const attributes = {
         ...DEFAULT_ATTRIBUTES,
@@ -93,7 +93,7 @@ describe('ioredis', () => {
       const readyHandler = () => {
         const endedSpans = memoryExporter.getFinishedSpans();
 
-        assert.strictEqual(tracer.getCurrentSpan(), span);
+        assert.strictEqual(registry.getTracer("ioredis-test").getCurrentSpan(), span);
         assert.strictEqual(endedSpans.length, 2);
         assert.strictEqual(endedSpans[0].name, `connect`);
         assert.strictEqual(endedSpans[1].name, `info`);
@@ -119,7 +119,7 @@ describe('ioredis', () => {
         client.quit(done);
       };
 
-      tracer.withSpan(span, () => {
+      registry.getTracer("ioredis-test").withSpan(span, () => {
         client = new ioredis(URL);
         client.on('ready', readyHandler);
         client.on('error', errorHandler);
@@ -183,8 +183,8 @@ describe('ioredis', () => {
               ' '
             )}`,
           };
-          const span = tracer.startSpan('test span');
-          tracer.withSpan(span, () => {
+          const span = registry.getTracer("ioredis-test").startSpan('test span');
+          registry.getTracer("ioredis-test").withSpan(span, () => {
             command.method((err, _result) => {
               assert.ifError(err);
               assert.strictEqual(memoryExporter.getFinishedSpans().length, 1);
@@ -211,8 +211,8 @@ describe('ioredis', () => {
           ...DEFAULT_ATTRIBUTES,
           [AttributeNames.DB_STATEMENT]: 'hset hash random random',
         };
-        const span = tracer.startSpan('test span');
-        await tracer.withSpan(span, async () => {
+        const span = registry.getTracer("ioredis-test").startSpan('test span');
+        await registry.getTracer("ioredis-test").withSpan(span, async () => {
           try {
             await client.hset('hash', 'random', 'random');
             assert.strictEqual(memoryExporter.getFinishedSpans().length, 1);
@@ -239,8 +239,8 @@ describe('ioredis', () => {
           ...DEFAULT_ATTRIBUTES,
           [AttributeNames.DB_STATEMENT]: 'scan 0',
         };
-        const span = tracer.startSpan('test span');
-        tracer.withSpan(span, () => {
+        const span = registry.getTracer("ioredis-test").startSpan('test span');
+        registry.getTracer("ioredis-test").withSpan(span, () => {
           const stream = client.scanStream();
           stream
             .on('data', resultKeys => {
@@ -275,8 +275,8 @@ describe('ioredis', () => {
       });
 
       it('should create a child span for pubsub', async () => {
-        const span = tracer.startSpan('test span');
-        await tracer.withSpan(span, async () => {
+        const span = registry.getTracer("ioredis-test").startSpan('test span');
+        await registry.getTracer("ioredis-test").withSpan(span, async () => {
           try {
             const pub = new ioredis(URL);
             const sub = new ioredis(URL);
@@ -334,8 +334,8 @@ describe('ioredis', () => {
           [AttributeNames.DB_STATEMENT]: 'eval return {KEYS[1],ARGV[1]} 1 test',
         };
 
-        const span = tracer.startSpan('test span');
-        tracer.withSpan(span, () => {
+        const span = registry.getTracer("ioredis-test").startSpan('test span');
+        registry.getTracer("ioredis-test").withSpan(span, () => {
           // This will define a command echo:
           client.defineCommand('echo', {
             numberOfKeys: 1,
@@ -372,8 +372,8 @@ describe('ioredis', () => {
           [AttributeNames.DB_STATEMENT]: 'multi',
         };
 
-        const span = tracer.startSpan('test span');
-        tracer.withSpan(span, () => {
+        const span = registry.getTracer("ioredis-test").startSpan('test span');
+        registry.getTracer("ioredis-test").withSpan(span, () => {
           client
             .multi()
             .set('foo', 'bar')
@@ -408,8 +408,8 @@ describe('ioredis', () => {
           [AttributeNames.DB_STATEMENT]: 'set foo bar',
         };
 
-        const span = tracer.startSpan('test span');
-        tracer.withSpan(span, () => {
+        const span = registry.getTracer("ioredis-test").startSpan('test span');
+        registry.getTracer("ioredis-test").withSpan(span, () => {
           const pipeline = client.pipeline();
           pipeline.set('foo', 'bar');
           pipeline.del('cc');
@@ -441,8 +441,8 @@ describe('ioredis', () => {
           ...DEFAULT_ATTRIBUTES,
           [AttributeNames.DB_STATEMENT]: 'get test',
         };
-        const span = tracer.startSpan('test span');
-        await tracer.withSpan(span, async () => {
+        const span = registry.getTracer("ioredis-test").startSpan('test span');
+        await registry.getTracer("ioredis-test").withSpan(span, async () => {
           try {
             const value = await client.get('test');
             assert.strictEqual(value, 'data');
@@ -470,8 +470,8 @@ describe('ioredis', () => {
           ...DEFAULT_ATTRIBUTES,
           [AttributeNames.DB_STATEMENT]: 'del test',
         };
-        const span = tracer.startSpan('test span');
-        await tracer.withSpan(span, async () => {
+        const span = registry.getTracer("ioredis-test").startSpan('test span');
+        await registry.getTracer("ioredis-test").withSpan(span, async () => {
           try {
             const result = await client.del('test');
             assert.strictEqual(result, 1);
@@ -502,8 +502,8 @@ describe('ioredis', () => {
 
       IOREDIS_CALLBACK_OPERATIONS.forEach(operation => {
         it(`should not create a child span for cb style ${operation.description}`, done => {
-          const span = tracer.startSpan('test span');
-          tracer.withSpan(span, () => {
+          const span = registry.getTracer("ioredis-test").startSpan('test span');
+          registry.getTracer("ioredis-test").withSpan(span, () => {
             operation.method((err, _) => {
               assert.ifError(err);
               assert.strictEqual(memoryExporter.getFinishedSpans().length, 0);
@@ -518,8 +518,8 @@ describe('ioredis', () => {
       });
 
       it('should not create a child span for hset promise upon error', async () => {
-        const span = tracer.startSpan('test span');
-        await tracer.withSpan(span, async () => {
+        const span = registry.getTracer("ioredis-test").startSpan('test span');
+        await registry.getTracer("ioredis-test").withSpan(span, async () => {
           try {
             await client.hset('hash', 'random', 'random');
             assert.strictEqual(memoryExporter.getFinishedSpans().length, 0);