Skip to content

Commit e0a5edf

Browse files
docs: update readme to clarify that the collector layer should be used 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
1 parent 69be75c commit e0a5edf

File tree

3 files changed

+22
-11
lines changed

3 files changed

+22
-11
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,27 @@
88

99
## OpenTelemetry Lambda Layers
1010

11-
The OpenTelemetry Lambda Layers provide the OpenTelemetry (OTel) code to export telemetry asynchronously from AWS Lambda functions. It does this by embedding a stripped-down version of [OpenTelemetry Collector Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) inside an [AWS Lambda Extension Layer](https://aws.amazon.com/blogs/compute/introducing-aws-lambda-extensions-in-preview/).
11+
The OpenTelemetry Lambda Layers provide the OpenTelemetry (OTel) code to export telemetry asynchronously from AWS Lambda functions. It does this by embedding a stripped-down version of [OpenTelemetry Collector Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) inside an [AWS Lambda Extension Layer](https://aws.amazon.com/blogs/compute/introducing-aws-lambda-extensions-in-preview/). This allows Lambda functions to use OpenTelemetry to send traces and metrics to any configured backend.
1212

13-
Some layers include the corresponding OTel language SDK for the Lambda. This allows Lambda functions to use OpenTelemetry to send traces and metrics to any configured backend.
13+
There are 2 types of lambda layers
14+
1. Collector Layer - Embeds a stripped down version of the OpenTelemetry Collector
15+
2. Language Specific Layer - Includes language specific nuances to allow lambda functions to automatically consume context from upstream callers, create spans, and automatically instrument the AWS SDK
1416

15-
## Extension Layer Language Support
17+
These 2 layers are meant to be used in conjunction to instrument your lambda functions. The reason that the collector is not embedded in specific language layers is to give users flexibility
1618

17-
* ### [Python + Collector Lambda Layer](python/README.md)
18-
* ### [Java + Collector Lambda Layer](java/README.md)
19-
* ### [NodeJS + Collector Lambda Layer](nodejs/README.md)
20-
* ### [.NET + Collector Lambda Layer](dotnet/README.md)
21-
* ### [Ruby + Collector Lambda Layer](ruby/README.md)
22-
* ### [Go + Collector Lambda Layer](go/README.md)
19+
## Collector Layer
2320
* ### [Collector Lambda Layer](collector/README.md)
2421

22+
## Extension Layer Language Support
23+
* ### [Python Lambda Layer](python/README.md)
24+
* ### [Java Lambda Layer](java/README.md)
25+
* ### [NodeJS Lambda Layer](nodejs/README.md)
26+
* ### [Ruby Lambda Layer](ruby/README.md)
27+
28+
## Additional language tooling not currently supported
29+
* ### [Go Lambda Library](go/README.md)
30+
* ### [.NET Lambda Layer](dotnet/README.md)
31+
2532
## FAQ
2633

2734
* **What exporters/receivers/processors are included from the OpenTelemetry Collector?**

dotnet/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenTelemetry Lambda .NET
22

3-
Nuget package and layer for running .NET applications on AWS Lambda with OpenTelemetry.
3+
Nuget package for running .NET applications on AWS Lambda with OpenTelemetry.
44

55
## Provided SDK
66

go/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
# OpenTelemetry Lambda Go
22

3-
Layer for running Go applications on AWS Lambda with OpenTelemetry.
3+
Examples of Go applications on AWS Lambda with OpenTelemetry.
44

55
## Provided SDK
66

77
[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.
88
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.
99

10+
## Provided Layer
11+
12+
[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.
13+
1014
## Sample application
1115

1216
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.

0 commit comments

Comments
 (0)