-
Notifications
You must be signed in to change notification settings - Fork 182
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update readme to clarify that the collector layer should be use…
…d alongside language layers (#1665) * docs: update readme to clarify that the collector layer should be used alongside language layers * Add clarification of auto vs manual instrumentation for go/dotnet applications
- Loading branch information
1 parent
69be75c
commit e0a5edf
Showing
3 changed files
with
22 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,16 @@ | ||
# OpenTelemetry Lambda Go | ||
|
||
Layer for running Go applications on AWS Lambda with OpenTelemetry. | ||
Examples of Go applications on AWS Lambda with OpenTelemetry. | ||
|
||
## Provided SDK | ||
|
||
[OpenTelemetry Lambda SDK for Go](/~https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation/github.com/aws/aws-lambda-go/otellambda) includes tracing APIs to instrument Lambda handler. | ||
For other instrumentations, such as http, you'll need to include the corresponding library instrumentation from the [instrumentation project](/~https://github.com/open-telemetry/opentelemetry-go) and modify your code to use it in your function. | ||
|
||
## Provided Layer | ||
|
||
[OpenTelemetry Lambda Layer for Collector](https://aws-otel.github.io/docs/getting-started/lambda/lambda-go#lambda-layer) includes OpenTelemetry Collector for Lambda components. Follow [user guide](https://aws-otel.github.io/docs/getting-started/lambda/lambda-go#enable-tracing) to apply this layer to your Lambda handler that's already been instrumented with OpenTelemetry Lambda .NET SDK to enable end-to-end tracing. | ||
|
||
## Sample application | ||
|
||
The [sample application](/~https://github.com/open-telemetry/opentelemetry-lambda/tree/main/go/sample-apps/function/function.go) shows the manual instrumentations of OpenTelemetry Lambda Go SDK on a Lambda handler that triggers downstream requests to AWS S3 and HTTP. |