chore: rename plugin to instrumentation

plugins/node/opentelemetry-plugin-koa/README.md → plugins/node/opentelemetry-koa-instrumentation/README.md

@@ -12,16 +12,16 @@ For automatic instrumentation see the
 ## Installation
 
 ```bash
-npm install --save @opentelemetry/plugin-koa
+npm install --save @opentelemetry/koa-instrumentation
 ```
 ### Supported Versions
- - `^2.0.0`
+ - Koa `^2.0.0`
 
 ## Usage
 
 OpenTelemetry Koa Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.
 
-To load a specific plugin (Koa in this case), specify it in the Node Tracer's configuration.
+To load a specific instrumentation (Koa in this case), specify it in the Node Tracer's configuration.
 ```js
 const { NodeTracerProvider } = require('@opentelemetry/node');
 
@@ -30,13 +30,13 @@ const provider = new NodeTracerProvider({
     koa: {
       enabled: true,
       // You may use a package name or absolute path to the file.
-      path: '@opentelemetry/plugin-koa',
+      path: '@opentelemetry/koa-instrumentation',
     }
   }
 });
 ```
 
-To load all of 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.
+To load all of the [supported instrumentations](https://github.com/open-telemetry/opentelemetry-js#plugins), use below approach. Each instrumentation is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing instrumentations for unused modules.
 ```js
 const { NodeTracerProvider } = require('@opentelemetry/node');
 
@@ -62,11 +62,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
 [license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/master/LICENSE
 [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
-[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib/status.svg?path=plugins/node/opentelemetry-plugin-koa
-
-[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins/node/opentelemetry-plugin-koa
-
-[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib/dev-status.svg?path=plugins/node/opentelemetry-plugin-koa
-
-[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins/node/opentelemetry-plugin-koa&type=dev
-
+[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib/status.svg?path=plugins/node/opentelemetry-koa-instrumentation
+[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins/node/opentelemetry-koa-instrumentation
+[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib/dev-status.svg?path=plugins/node/opentelemetry-koa-instrumentation
+[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins/node/opentelemetry-koa-instrumentation&type=dev

plugins/node/opentelemetry-plugin-koa/package.json → plugins/node/opentelemetry-koa-instrumentation/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@opentelemetry/plugin-koa",
+  "name": "@opentelemetry/koa-instrumentation",
   "version": "0.8.0",
   "description": "OpenTelemetry Koa automatic instrumentation package.",
   "main": "build/src/index.js",
@@ -23,7 +23,8 @@
     "nodejs",
     "tracing",
     "profiling",
-    "plugin"
+    "plugin",
+    "instrumentation"
   ],
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
@@ -51,6 +52,7 @@
     "@types/node": "12.12.47",
     "@types/shimmer": "1.0.1",
     "codecov": "3.7.0",
+    "eslint": "^7.4.0",
     "gts": "2.0.2",
     "koa": "^2.13.0",
     "mocha": "7.2.0",
@@ -65,7 +67,6 @@
   "dependencies": {
     "@opentelemetry/api": "^0.9.0",
     "@opentelemetry/core": "^0.9.0",
-    "eslint": "^7.4.0",
     "shimmer": "^1.2.1"
   }
 }

plugins/node/opentelemetry-plugin-koa/src/koa.ts → plugins/node/opentelemetry-koa-instrumentation/src/koa.ts

@@ -33,12 +33,12 @@ import Router = require('@koa/router');
  */
 export const kLayerPatched: unique symbol = Symbol('koa-layer-patched');
 
-/** Koa instrumentation plugin for OpenTelemetry */
-export class KoaPlugin extends BasePlugin<typeof koa> {
+/** Koa instrumentation for OpenTelemetry */
+export class KoaInstrumentation extends BasePlugin<typeof koa> {
   static readonly component = KoaComponentName;
 
   constructor(readonly moduleName: string) {
-    super('@opentelemetry/plugin-koa', VERSION);
+    super('@opentelemetry/koa-instrumentation', VERSION);
   }
 
   protected patch(): typeof koa {
@@ -71,9 +71,9 @@ export class KoaPlugin extends BasePlugin<typeof koa> {
     ) {
       let patchedFunction;
       if (middlewareFunction.router) {
-        patchedFunction = plugin._patchRouterDispatch(middlewareFunction);
+        patchedFunction = koaInstrumentation._patchRouterDispatch(middlewareFunction);
       } else {
-        patchedFunction = plugin._patchLayer(middlewareFunction, false);
+        patchedFunction = koaInstrumentation._patchLayer(middlewareFunction, false);
       }
 
       args[0] = patchedFunction;
@@ -138,4 +138,4 @@ export class KoaPlugin extends BasePlugin<typeof koa> {
   }
 }
 
-export const plugin = new KoaPlugin(KoaPlugin.component);
+export const koaInstrumentation = new KoaInstrumentation(KoaComponentName);

plugins/node/opentelemetry-plugin-koa/test/koa-router.test.ts → plugins/node/opentelemetry-koa-instrumentation/test/koa-router.test.ts

@@ -25,11 +25,9 @@ import {
 import * as assert from 'assert';
 import * as koa from 'koa';
 import * as KoaRouter from '@koa/router';
-// const router = require('@koa/router')();
-
 import * as http from 'http';
 import { AddressInfo } from 'net';
-import { plugin } from '../src';
+import { koaInstrumentation } from '../src';
 import { AttributeNames, KoaLayerType, KoaComponentName } from '../src/types';
 
 const httpRequest = {
@@ -51,7 +49,7 @@ const httpRequest = {
   },
 };
 
-describe('Koa Plugin - Router Tests', () => {
+describe('Koa Instrumentation - Router Tests', () => {
   const logger = new NoopLogger();
   const provider = new NodeTracerProvider();
   const memoryExporter = new InMemorySpanExporter();
@@ -61,7 +59,7 @@ describe('Koa Plugin - Router Tests', () => {
   let contextManager: AsyncHooksContextManager;
 
   before(() => {
-    plugin.enable(koa, provider, logger);
+    koaInstrumentation.enable(koa, provider, logger);
   });
 
   beforeEach(() => {

plugins/node/opentelemetry-plugin-koa/test/koa.test.ts → plugins/node/opentelemetry-koa-instrumentation/test/koa.test.ts

@@ -26,7 +26,7 @@ import * as assert from 'assert';
 import * as koa from 'koa';
 import * as http from 'http';
 import { AddressInfo } from 'net';
-import { plugin } from '../src';
+import { koaInstrumentation } from '../src';
 import { AttributeNames, KoaLayerType, KoaComponentName } from '../src/types';
 
 const httpRequest = {
@@ -48,7 +48,7 @@ const httpRequest = {
   },
 };
 
-describe('Koa Plugin - Core Tests', () => {
+describe('Koa Instrumentation - Core Tests', () => {
   const logger = new NoopLogger();
   const provider = new NodeTracerProvider();
   const memoryExporter = new InMemorySpanExporter();
@@ -58,7 +58,7 @@ describe('Koa Plugin - Core Tests', () => {
   let contextManager: AsyncHooksContextManager;
 
   before(() => {
-    plugin.enable(koa, provider, logger);
+    koaInstrumentation.enable(koa, provider, logger);
   });
 
   beforeEach(() => {
@@ -195,9 +195,9 @@ describe('Koa Plugin - Core Tests', () => {
     });
   });
 
-  describe('Disabling plugin', () => {
+  describe('Disabling koa instrumentation', () => {
     it('should not create new spans', async () => {
-      plugin.disable();
+      koaInstrumentation.disable();
       const rootSpan = tracer.startSpan('rootSpan');
       const app = new koa();
       app.use(customMiddleware);

plugins/node/opentelemetry-plugin-koa/tsconfig.json → plugins/node/opentelemetry-koa-instrumentation/tsconfig.json

@@ -9,4 +9,3 @@
       "test/**/*.ts"
     ]
   }
-