Skip to content

Commit

Permalink
[docs] Add status header for awsxray receiver (#10444)
Browse files Browse the repository at this point in the history
* Add status header for awsxray receiver

* apply reviewer's suggestion.
  • Loading branch information
Frapschen committed Jun 8, 2022
1 parent 1e96085 commit da38ea3
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions receiver/awsxrayreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# AWS X-Ray Receiver

| Status | |
| ------------------------ |------------------|
| Stability | [beta] |
| Supported pipeline types | traces |
| Distributions | [contrib], [AWS] |

## Overview
The AWS X-Ray receiver accepts segments (i.e. spans) in the [X-Ray Segment format](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html).
This enables the collector to receive spans emitted by the existing X-Ray SDK. [Centralized sampling](https://github.com/aws/aws-xray-daemon/blob/master/CHANGELOG.md#300-2018-08-28) is also supported via a local TCP port.
Expand Down Expand Up @@ -71,3 +77,7 @@ The X-Ray service endpoint which the local TCP server forwards requests to.
Determines whether the ECS/EC2 instance metadata endpoint will be called to fetch the AWS region to send requests to. Set to `true` to skip metadata check.

Default: `false`

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[AWS]: https://aws-otel.github.io/docs/components/x-ray-receiver

0 comments on commit da38ea3

Please sign in to comment.