Skip to content
This repository was archived by the owner on Oct 31, 2024. It is now read-only.

Commit 6318cdb

Browse files
author
Amir Blum
committed
docs(plugin-aws-sdk): add aws-sdk plugin to README
1 parent 37521c8 commit 6318cdb

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@
1212
js extensions for the [open-telemetry](https://opentelemetry.io/) project, from [Aspecto](https://www.aspecto.io/) with :heart:
1313

1414
## Plugins
15-
- [opentelemetry-plugin-kafkajs](./packages/plugin-kafkajs) - auto instrumentation for [`kafkajs`](https://kafka.js.org) kafka client
15+
- [opentelemetry-plugin-kafkajs](./packages/plugin-kafkajs) - auto instrumentation for [`kafkajs`](https://kafka.js.org) kafka client
16+
- [opentelemetry-plugin-aws-sdk](./packages/plugin-aws-sdk) - auto instrumentation for [`aws-sdk`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/)

packages/plugin-aws-sdk/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# OpenTelemetry aws-sdk Instrumentation for Node.js
2+
3+
This module provides automatic instrumentation for [`aws-sdk`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/).
4+
5+
## Installation
6+
7+
```
8+
npm install --save opentelemetry-plugin-aws-sdk
9+
```
10+
11+
## Usage
12+
13+
To load a specific plugin (**aws-sdk** in this case), specify it in the Node Tracer's configuration
14+
15+
```js
16+
const { NodeTracerProvider } = require("opentelemetry-plugin-aws-sdk");
17+
18+
const provider = new NodeTracerProvider({
19+
plugins: {
20+
"aws-sdk": {
21+
enabled: true,
22+
// You may use a package name or absolute path to the file.
23+
path: "opentelemetry-plugin-aws-sdk",
24+
},
25+
},
26+
});
27+
```

0 commit comments

Comments
 (0)