Skip to content

Commit 6a59ea3

Browse files
committed
update documentation
1 parent 71fdf0b commit 6a59ea3

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed
Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# AWS Distro for OpenTelemetry (ADOT) OTLP UDP Exporter
1+
# AWS Distro for OpenTelemetry (ADOT) X-Ray UDP Exporter
2+
3+
The AWS X-Ray UDP Exporter allows you to send OpenTelemetry Spans to the AWS X-Ray Daemon endpoint.
4+
Notably, this will work with the X-Ray Daemon that runs in an AWS Lambda Environment.
5+
6+
## Installatio
27

38
Install this package into your NodeJS project with:
49

@@ -8,11 +13,15 @@ npm install --save @aws/aws-distro-opentelemetry-exporter-xray-udp
813

914
## Usage
1015

11-
```ts
12-
import { AwsXrayUdpSpanExporter } from "@aws/aws-distro-opentelemetry-exporter-xray-udp"
13-
import { SpanExporter } from '@opentelemetry/sdk-trace-base';
14-
16+
```js
17+
const { AwsXrayUdpSpanExporter } = require("@aws/aws-distro-opentelemetry-exporter-xray-udp")
1518
// ...
1619

17-
let AwsXrayUdpSpanExporter: SpanExporter = new AwsXrayUdpSpanExporter('127.0.0.1:2000');
20+
const _traceExporter = new AwsXrayUdpSpanExporter();
21+
const _spanProcessor = new SimpleSpanProcessor(_traceExporter);
22+
23+
const sdk = new opentelemetry.NodeSDK({
24+
spanProcessor: _spanProcessor,
25+
// ...
26+
});
1827
```

exporters/aws-distro-opentelemetry-exporter-xray-udp/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@aws/aws-distro-opentelemetry-exporter-xray-udp",
33
"version": "0.0.1",
4-
"description": "This package provides an OTLP UDP Exporter for OpenTelemetry.",
4+
"description": "This package provides an AWS X-Ray UDP Exporter for OpenTelemetry.",
55
"author": {
66
"name": "Amazon Web Services",
77
"url": "http://aws.amazon.com"

0 commit comments

Comments
 (0)