Merge a36fffe into 862ab4e

metapackages/auto-instrumentations-node/README.md

@@ -1,4 +1,5 @@
 # OpenTelemetry Meta Packages for Node
+
 [![NPM Published Version][npm-img]][npm-url]
 [![dependencies][dependencies-image]][dependencies-url]
 [![devDependencies][devDependencies-image]][devDependencies-url]

metapackages/auto-instrumentations-web/README.md

@@ -1,4 +1,5 @@
 # OpenTelemetry Meta Packages for Web
+
 [![NPM Published Version][npm-img]][npm-url]
 [![dependencies][dependencies-image]][dependencies-url]
 [![devDependencies][devDependencies-image]][devDependencies-url]

plugins/node/opentelemetry-instrumentation-aws-lambda/README.md

@@ -18,6 +18,7 @@ npm install --save @opentelemetry/instrumentation-aws-lambda
 ## Usage
 
 Create a file to initialize the instrumentation, such as `lambda-wrapper.js`.
+
 ```js
 const { NodeTracerProvider } = require('@opentelemetry/node');
 const { AwsLambdaInstrumentation } = require('@opentelemetry/instrumentation-aws-lambda');
@@ -30,7 +31,6 @@ registerInstrumentations({
   instrumentations: [
     new AwsLambdaInstrumentation()
   ],
-  tracerProvider: provider,
 });
 ```
 

plugins/node/opentelemetry-instrumentation-bunyan/README.md

@@ -34,7 +34,6 @@ registerInstrumentations({
     }),
     // other instrumentations
   ],
-  tracerProvider: provider,
 });
 
 bunyan.createLogger({ name: 'example' }).info('foo');
@@ -44,6 +43,7 @@ bunyan.createLogger({ name: 'example' }).info('foo');
 ### Fields added to bunyan records
 
 For the current active span, the following will be added to the bunyan record:
+
 * `trace_id`
 * `span_id`
 * `trace_flags`
@@ -52,9 +52,9 @@ When no span context is active or the span context is invalid, injection is skip
 
 ## Useful links
 
-- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
-- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
-- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
+* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+* For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
+* For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
 
 ## License
 

plugins/node/opentelemetry-instrumentation-dns/README.md

@@ -32,7 +32,6 @@ registerInstrumentations({
       // see under for available configuration
     }),
   ],
-  tracerProvider: provider,
 });
 ```
 

plugins/node/opentelemetry-instrumentation-express/README.md

@@ -19,7 +19,8 @@ npm install --save @opentelemetry/instrumentation-http @opentelemetry/instrument
 ```
 
 ### Supported Versions
- - `^4.0.0`
+
+- `^4.0.0`
 
 ## Usage
 
@@ -42,7 +43,6 @@ registerInstrumentations({
     new HttpInstrumentation(),
     new ExpressInstrumentation(),
   ],
-  tracerProvider: provider,
 });
 ```
 
@@ -74,6 +74,7 @@ Express instrumentation has few options available to choose from. You can set th
 - `request_handler` is the name for anything that's not a router or a middleware.
 
 ## Useful links
+
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
 - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
 - For help or feedback on this project, join us in [GitHub Discussions][discussions-url]

plugins/node/opentelemetry-instrumentation-graphql/README.md

@@ -34,7 +34,6 @@ registerInstrumentations({
       // mergeItems: true,
     }),
   ],
-  tracerProvider: provider,
 });
 
 ```

plugins/node/opentelemetry-instrumentation-hapi/README.md

@@ -15,8 +15,10 @@ For automatic instrumentation see the
 ```bash
 npm install --save @opentelemetry/instrumentation-hapi
 ```
+
 ### Supported Versions
- - @hapi/hapi `^17.0.0`
+
+- @hapi/hapi `^17.0.0`
 
 ## Usage
 
@@ -27,12 +29,15 @@ To load a specific instrumentation (Hapi in this case), specify it in the regist
 ```js
 const { NodeTracerProvider } = require('@opentelemetry/node');
 const { registerInstrumentations } = require('@opentelemetry/instrumentation');
+const { HapiInstrumentation } = require('@opentelemetry/instrumentation-hapi');
 
 const provider = new NodeTracerProvider();
 provider.register();
 
 registerInstrumentations({
-  tracerProvider: provider,
+  instrumentations: [
+    new HapiInstrumentation(),
+  ],
 });
 ```
 
@@ -48,34 +53,18 @@ const hapiInstrumentation = new HapiInstrumentation();
 hapiInstrumentation.setTracerProvider(provider);
 ```
 
-You can combine loading default plugins and HapiInstrumentation at the same time:
-
-```js
-const { NodeTracerProvider } = require('@opentelemetry/node');
-const { HapiInstrumentation } = require('@opentelemetry/instrumentation-hapi');
-const { registerInstrumentations } = require('@opentelemetry/instrumentation');
-
-const provider = new NodeTracerProvider();
-provider.register();
-
-registerInstrumentations({
-  instrumentations: [
-    new HapiInstrumentation(),
-  ],
-  tracerProvider: provider,
-});
-```
-
 See [examples/hapi](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/hapi) for a short example using Hapi
 
 <!-- 
 The dev dependency of `@hapi/[email protected]` is required to force the compatible type declarations. See: https://github.com/hapijs/hapi/issues/4240
 -->
 
 ## Hapi Instrumentation Support
+
 This package provides automatic tracing for hapi server routes and [request lifecycle](https://github.com/hapijs/hapi/blob/main/API.md#request-lifecycle) extensions defined either directly or via a Hapi plugin.
 
 ## Useful links
+
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
 - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
 - For help or feedback on this project, join us in [GitHub Discussions][discussions-url]

plugins/node/opentelemetry-instrumentation-ioredis/README.md

@@ -38,7 +38,6 @@ registerInstrumentations({
       // see under for available configuration
     })
   ],
-  tracerProvider: provider,
 })
 ```
 
@@ -52,7 +51,8 @@ IORedis instrumentation has few options available to choose from. You can set th
 | `responseHook` | `RedisResponseCustomAttributeFunction` | Function for adding custom attributes on db response |
 | `requireParentSpan` | `boolean` | Require parent to create ioredis span, default when unset is true |
 
-#### Custom db.statement Serializer
+#### Custom db.statement Serializer
+
 The instrumentation serializes the whole command into a Span attribute called `db.statement`. The standard serialization format is `{cmdName} {cmdArgs.join(',')}`.
 It is also possible to define a custom serialization function. The function will receive the command name and arguments and must return a string.
 

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

@@ -15,8 +15,10 @@ For automatic instrumentation see the
 ```bash
 npm install --save @opentelemetry/instrumentation-koa
 ```
+
 ### Supported Versions
- - Koa `^2.0.0`
+
+- Koa `^2.0.0`
 
 ## Usage
 
@@ -34,7 +36,6 @@ registerInstrumentations({
   instrumentations: [
     new KoaInstrumentation(),
   ],
-  tracerProvider: provider,
 });
 ```
 
@@ -45,6 +46,7 @@ See [examples/koa](https://github.com/open-telemetry/opentelemetry-js-contrib/tr
 This package provides automatic tracing for middleware added using either the core [`Koa`](https://github.com/koajs/koa) package or the [`@koa/router`](https://github.com/koajs/router) package.
 
 ## Useful links
+
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
 - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
 - For help or feedback on this project, join us in [GitHub Discussions][discussions-url]

plugins/node/opentelemetry-instrumentation-mongodb/README.md

@@ -15,6 +15,7 @@ For automatic instrumentation see the
 ```bash
 npm install --save @opentelemetry/instrumentation-mongodb
 ```
+
 ### Supported Versions
  - `'>=3.3 <4`
 
@@ -38,7 +39,6 @@ registerInstrumentations({
       // see under for available configuration
     }),
   ],
-  tracerProvider: provider,
 });
 
 ```
@@ -51,8 +51,8 @@ Mongodb instrumentation has few options available to choose from. You can set th
 | ------- | ---- | ----------- |
 | [`enhancedDatabaseReporting`](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-api/src/trace/instrumentation/instrumentation.ts#L91) | `string` | If true, additional information about query parameters and results will be attached (as `attributes`) to spans representing database operations |
 
-
 ## Useful links
+
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
 - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
 - For help or feedback on this project, join us in [GitHub Discussions][discussions-url]

plugins/node/opentelemetry-instrumentation-mysql/README.md

@@ -17,13 +17,15 @@ npm install --save @opentelemetry/instrumentation-mysql
 ```
 
 ## Supported Versions
+
 - `2.x`
 
 ## Usage
 
 OpenTelemetry MySQL Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with [mysql](https://www.npmjs.com/package/mysql).
 
 To load a specific plugin (**MySQL** in this case), specify it in the registerInstrumentations's configuration
+
 ```js
 const { NodeTracerProvider } = require('@opentelemetry/node');
 const { MySQLInstrumentation } = require('@opentelemetry/instrumentation-mysql');
@@ -36,13 +38,13 @@ registerInstrumentations({
   instrumentations: [
     new MySQLInstrumentation(),
   ],
-  tracerProvider: provider,
 })
 ```
 
 See [examples/mysql](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/mysql) for a short example.
 
 ## Useful links
+
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
 - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
 - For help or feedback on this project, join us in [GitHub Discussions][discussions-url]

plugins/node/opentelemetry-instrumentation-net/README.md

@@ -29,7 +29,6 @@ registerInstrumentations({
     new NetInstrumentation(),
     // other instrumentations
   ],
-  tracerProvider: provider,
 });
 ```
 
@@ -39,16 +38,17 @@ registerInstrumentations({
 * `net.peer.name`: host name or the IPC file path
 
 For TCP:
+
 * `net.peer.ip`
 * `net.peer.port`
 * `net.host.ip`
 * `net.host.port`
 
 ## Useful links
 
-- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
-- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
-- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
+* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+* For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
+* For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
 
 ## License
 

plugins/node/opentelemetry-instrumentation-net/test/utils.ts

@@ -28,7 +28,10 @@ import { IPC_TRANSPORT } from '../src/utils';
 
 export const PORT = 42123;
 export const HOST = 'localhost';
-export const IPC_PATH = path.join(os.tmpdir(), 'otel-js-net-test-ipc');
+export const IPC_PATH =
+  os.platform() !== 'win32'
+    ? path.join(os.tmpdir(), 'otel-js-net-test-ipc')
+    : '\\\\.\\pipe\\otel-js-net-test-ipc';
 
 export function assertTcpSpan(span: ReadableSpan, socket: Socket) {
   assertSpanKind(span);

plugins/node/opentelemetry-instrumentation-pg/README.md

@@ -27,11 +27,11 @@ const { registerInstrumentations } = require('@opentelemetry/instrumentation');
 
 const provider = new NodeTracerProvider();
 provider.register();
+
 registerInstrumentations({
   instrumentations: [
     new PgInstrumentation(),
   ],
-  tracerProvider: provider,
 });
 ```
 
@@ -53,6 +53,7 @@ PostgreSQL instrumentation has few options available to choose from. You can set
 - [pg-pool](https://npmjs.com/package/pg-pool): `2.x`, `3.*` (Installed by `pg`)
 
 ## Useful links
+
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
 - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
 - For help or feedback on this project, join us in [GitHub Discussions][discussions-url]

plugins/node/opentelemetry-instrumentation-pino/README.md

@@ -33,7 +33,6 @@ registerInstrumentations({
     }),
     // other instrumentations
   ],
-  tracerProvider: provider,
 });
 
 const pino = require('pino');
@@ -45,6 +44,7 @@ logger.info('foobar');
 ### Fields added to pino log objects
 
 For the current active span, the following fields are injected:
+
 * `trace_id`
 * `span_id`
 * `trace_flags`
@@ -57,9 +57,9 @@ When no span context is active or the span context is invalid, injection is skip
 
 ## Useful links
 
-- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
-- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
-- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
+* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+* For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
+* For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
 
 ## License
 

plugins/node/opentelemetry-instrumentation-redis/README.md

@@ -12,18 +12,20 @@ For automatic instrumentation see the
 
 ## Installation
 
-```
+```bash
 npm install --save @opentelemetry/instrumentation-redis
 ```
 
 ### Supported Versions
- - `>=2.6.0`
+
+- `>=2.6.0`
 
 ## Usage
 
 OpenTelemetry Redis Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with [redis](https://www.npmjs.com/package/redis).
 
 To load a specific instrumentation (**redis** in this case), specify it in the registerInstrumentations' configuration
+
 ```javascript
 const { NodeTracerProvider } = require('@opentelemetry/node');
 const { RedisInstrumentation } = require('@opentelemetry/instrumentation-redis');
@@ -36,13 +38,13 @@ registerInstrumentations({
   instrumentations: [
     new RedisInstrumentation(),
   ],
-  tracerProvider: provider,
 })
 ```
 
 See [examples/redis](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/redis) for a short example.
 
 ## Useful links
+
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
 - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
 - For help or feedback on this project, join us in [GitHub Discussions][discussions-url]