From fe66b6fb50860a5e44cee3c56afc6f389644020e Mon Sep 17 00:00:00 2001 From: vmarchaud Date: Thu, 13 Feb 2020 18:16:29 +0100 Subject: [PATCH] chore: address more PR reviews --- README.md | 2 +- packages/opentelemetry-plugin-express/README.md | 8 ++++---- packages/opentelemetry-plugin-express/package.json | 8 ++++---- .../opentelemetry-plugin-express/src/express.ts | 10 +++++----- packages/opentelemetry-plugin-express/src/index.ts | 2 +- packages/opentelemetry-plugin-express/src/types.ts | 4 ++-- packages/opentelemetry-plugin-express/src/utils.ts | 4 ++-- .../test/express.test.ts | 14 +++++++------- 8 files changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index e5893577b4d..5c7e9b787a0 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,7 @@ OpenTelemetry can collect tracing data automatically using plugins. Vendors/User - [@opentelemetry/plugin-redis][otel-plugin-redis] - [@opentelemetry/plugin-ioredis][otel-plugin-ioredis] - [@opentelemetry/plugin-dns][otel-plugin-dns] - By default, this plugin is not loaded [#612](https://github.com/open-telemetry/opentelemetry-js/issues/612) -- [@opentelemetry/plugin-express][otel-plugin-express] +- [@opentelemetry/plugin-express][otel-plugin-express] - By default, this plugin is not loaded #### Web Plugins - [@opentelemetry/plugin-document-load][otel-plugin-document-load] diff --git a/packages/opentelemetry-plugin-express/README.md b/packages/opentelemetry-plugin-express/README.md index c230463c66c..fd693a45c32 100644 --- a/packages/opentelemetry-plugin-express/README.md +++ b/packages/opentelemetry-plugin-express/README.md @@ -23,9 +23,9 @@ OpenTelemetry Express Instrumentation allows the user to automatically collect t To load a specific plugin (express in this case), specify it in the Node Tracer's configuration. ```js -const { NodeTracerRegistry } = require('@opentelemetry/node'); +const { NodeTracerProvider } = require('@opentelemetry/node'); -const registry = new NodeTracerRegistry({ +const provider = new NodeTracerProvider({ plugins: { express: { enabled: true, @@ -38,9 +38,9 @@ const registry = new NodeTracerRegistry({ To load all the [supported plugins](https://github.com/open-telemetry/opentelemetry-js#plugins), use below approach. Each plugin is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing plugins for unused modules. ```js -const { NodeTracerRegistry } = require('@opentelemetry/node'); +const { NodeTracerProvider } = require('@opentelemetry/node'); -const registry = new NodeTracerRegistry(); +const provider = new NodeTracerProvider(); ``` See [examples/express](https://github.com/open-telemetry/opentelemetry-js/tree/master/examples/express) for a short example. diff --git a/packages/opentelemetry-plugin-express/package.json b/packages/opentelemetry-plugin-express/package.json index 6c85d7ca202..cc06bfb4021 100644 --- a/packages/opentelemetry-plugin-express/package.json +++ b/packages/opentelemetry-plugin-express/package.json @@ -41,8 +41,8 @@ "access": "public" }, "devDependencies": { - "@opentelemetry/node": "^0.3.2", - "@opentelemetry/tracing": "^0.3.2", + "@opentelemetry/node": "^0.4.0", + "@opentelemetry/tracing": "^0.4.0", "@types/express": "^4.17.2", "@types/mocha": "^5.2.7", "@types/node": "^12.7.2", @@ -60,8 +60,8 @@ "typescript": "3.7.2" }, "dependencies": { - "@opentelemetry/core": "^0.3.2", - "@opentelemetry/types": "^0.3.2", + "@opentelemetry/core": "^0.4.0", + "@opentelemetry/api": "^0.4.0", "shimmer": "^1.2.1" } } diff --git a/packages/opentelemetry-plugin-express/src/express.ts b/packages/opentelemetry-plugin-express/src/express.ts index 1a0f48d4f56..6186b036963 100644 --- a/packages/opentelemetry-plugin-express/src/express.ts +++ b/packages/opentelemetry-plugin-express/src/express.ts @@ -1,5 +1,5 @@ /*! - * Copyright 2019, OpenTelemetry Authors + * Copyright 2020, OpenTelemetry Authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -15,7 +15,7 @@ */ import { BasePlugin } from '@opentelemetry/core'; -import { Attributes } from '@opentelemetry/types'; +import { Attributes } from '@opentelemetry/api'; import * as express from 'express'; import * as core from 'express-serve-static-core'; import * as shimmer from 'shimmer'; @@ -46,7 +46,7 @@ export const kLayerPatched: unique symbol = Symbol('express-layer-patched'); /** Express instrumentation plugin for OpenTelemetry */ export class ExpressPlugin extends BasePlugin { - readonly _COMPONENT = 'express'; + static readonly component = 'express'; readonly supportedVersions = ['^4.0.0']; protected _config!: ExpressPluginConfig; @@ -176,7 +176,7 @@ export class ExpressPlugin extends BasePlugin { storeLayerPath(req, layerPath); const route = (req[_LAYERS_STORE_PROPERTY] as string[]).join(''); const attributes: Attributes = { - [AttributeNames.COMPONENT]: plugin._COMPONENT, + [AttributeNames.COMPONENT]: ExpressPlugin.component, [AttributeNames.HTTP_ROUTE]: route.length > 0 ? route : undefined, }; const metadata = getLayerMetadata(layer, layerPath); @@ -217,4 +217,4 @@ export class ExpressPlugin extends BasePlugin { } } -export const plugin = new ExpressPlugin('express'); +export const plugin = new ExpressPlugin(ExpressPlugin.component); diff --git a/packages/opentelemetry-plugin-express/src/index.ts b/packages/opentelemetry-plugin-express/src/index.ts index ef10dabca88..4ef7578680f 100644 --- a/packages/opentelemetry-plugin-express/src/index.ts +++ b/packages/opentelemetry-plugin-express/src/index.ts @@ -1,5 +1,5 @@ /*! - * Copyright 2019, OpenTelemetry Authors + * Copyright 2020, OpenTelemetry Authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/opentelemetry-plugin-express/src/types.ts b/packages/opentelemetry-plugin-express/src/types.ts index 011afd37200..af7a0bc06ef 100644 --- a/packages/opentelemetry-plugin-express/src/types.ts +++ b/packages/opentelemetry-plugin-express/src/types.ts @@ -1,5 +1,5 @@ /*! - * Copyright 2019, OpenTelemetry Authors + * Copyright 2020, OpenTelemetry Authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,7 +16,7 @@ import { kLayerPatched } from './express'; import { Request } from 'express'; -import { PluginConfig, Attributes } from '@opentelemetry/types'; +import { PluginConfig, Attributes } from '@opentelemetry/api'; /** * This const define where on the `request` object the plugin will mount the diff --git a/packages/opentelemetry-plugin-express/src/utils.ts b/packages/opentelemetry-plugin-express/src/utils.ts index 9da4974627e..1ec8e348f96 100644 --- a/packages/opentelemetry-plugin-express/src/utils.ts +++ b/packages/opentelemetry-plugin-express/src/utils.ts @@ -1,5 +1,5 @@ /*! - * Copyright 2019, OpenTelemetry Authors + * Copyright 2020, OpenTelemetry Authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -14,7 +14,7 @@ * limitations under the License. */ -import { CanonicalCode, Span, Attributes } from '@opentelemetry/types'; +import { CanonicalCode, Span, Attributes } from '@opentelemetry/api'; import { ExpressLayer, AttributeNames, diff --git a/packages/opentelemetry-plugin-express/test/express.test.ts b/packages/opentelemetry-plugin-express/test/express.test.ts index f691d5d50dd..231663f1b99 100644 --- a/packages/opentelemetry-plugin-express/test/express.test.ts +++ b/packages/opentelemetry-plugin-express/test/express.test.ts @@ -1,5 +1,5 @@ /*! - * Copyright 2019, OpenTelemetry Authors + * Copyright 2020, OpenTelemetry Authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -14,7 +14,7 @@ * limitations under the License. */ -import { NodeTracerRegistry } from '@opentelemetry/node'; +import { NodeTracerProvider } from '@opentelemetry/node'; import * as assert from 'assert'; import * as express from 'express'; import * as http from 'http'; @@ -52,14 +52,14 @@ const httpRequest = { describe('Express Plugin', () => { const logger = new NoopLogger(); - const registry = new NodeTracerRegistry(); + const provider = new NodeTracerProvider(); const memoryExporter = new InMemorySpanExporter(); const spanProcessor = new SimpleSpanProcessor(memoryExporter); - registry.addSpanProcessor(spanProcessor); - const tracer = registry.getTracer('default'); + provider.addSpanProcessor(spanProcessor); + const tracer = provider.getTracer('default'); before(() => { - plugin.enable(express, registry, logger); + plugin.enable(express, provider, logger); }); afterEach(() => { @@ -138,7 +138,7 @@ describe('Express Plugin', () => { const config: ExpressPluginConfig = { ignoreLayersType: [ExpressLayerType.MIDDLEWARE], }; - plugin.enable(express, registry, logger, config); + plugin.enable(express, provider, logger, config); const rootSpan = tracer.startSpan('rootSpan'); const app = express(); app.use(express.json());