End to end tracing support - Lambda

.github/dependabot.yml

@@ -37,6 +37,16 @@ updates:
     schedule:
       interval: "weekly"
       day: "sunday"
+  -
+    package-ecosystem: "gomod"
+    directory: "/detectors/aws/lambda"
+    labels:
+      - dependencies
+      - go
+      - "Skip Changelog"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
   -
     package-ecosystem: "gomod"
     directory: "/detectors/aws"
@@ -155,6 +165,36 @@ updates:
     schedule:
       interval: "weekly"
       day: "sunday"
+  -
+    package-ecosystem: "gomod"
+    directory: "/instrumentation/github.com/aws/aws-lambda-go/otellambda"
+    labels:
+      - dependencies
+      - go
+      - "Skip Changelog"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+  -
+    package-ecosystem: "gomod"
+    directory: "/instrumentation/github.com/aws/aws-lambda-go/otellambda/example"
+    labels:
+      - dependencies
+      - go
+      - "Skip Changelog"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+  -
+    package-ecosystem: "gomod"
+    directory: "/instrumentation/github.com/aws/aws-lambda-go/otellambda/test"
+    labels:
+      - dependencies
+      - go
+      - "Skip Changelog"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
   -
     package-ecosystem: "gomod"
     directory: "/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache"

CHANGELOG.md

@@ -8,6 +8,11 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+### Added
+
+- Add instrumentation for the `github.com/aws/aws-lambda-go` package. (#882)
+- Add resource detector for AWS Lambda. (#882)
+
 ### Changed
 
 - `otelmongodb` span attributes, name and span status now conform to specification. (#769)

detectors/aws/lambda/README.md

@@ -0,0 +1,67 @@
+# OpenTelemetry AWS Lambda Resource Detector for Golang
+
+[![Go Reference][goref-image]][goref-url]
+[![Apache License][license-image]][license-url]
+
+This module detects resource attributes available in AWS Lambda.
+
+## Installation
+
+```bash
+go get -u go.opentelemetry.io/contrib/detectors/aws/lambda
+```
+
+## Usage
+
+Create a sample Lambda Go application such as below.
+
+```go
+package main
+
+import (
+	"github.com/aws/aws-lambda-go/lambda"
+	sdktrace "go.opencensus.io/otel/sdk/trace"
+	lambdadetector "go.opentelemetry.io/contrib/detectors/aws/lambda"
+)
+
+func main() {
+	detector := lambdadetector.NewResourceDetector()
+	res, err := detector.Detect(context.Background())
+	if err != nil {
+		fmt.Printf("failed to detect lambda resources: %v\n", err)
+	}
+
+	tp := sdktrace.NewTracerProvider(
+		sdktrace.WithResource(res),
+	)
+	lambda.Start(<some lambda handler>)
+}
+```
+
+Now your `TracerProvider` will have the following resource attributes and attach them to new spans:
+
+| Resource Attribute | Example Value |
+| --- | --- |
+| `cloud.provider` | aws
+|`cloud.region` | us-east-1 
+|`faas.name` | MyLambdaFunction 
+|`faas.version` | $LATEST
+
+Of note, `faas.id` and `cloud.account.id` are not set by the Lambda resource detector because they are not available outside a Lambda invocation. For this reason, when using the AWS Lambda Instrumentation these attributes are set as additional span attributes.
+
+## Useful links
+
+- For more on FaaS attribute conventions, visit <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/faas.md>
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For more about OpenTelemetry Go: <https://github.com/open-telemetry/opentelemetry-go>
+- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
+
+## License
+
+Apache 2.0 - See [LICENSE][license-url] for more information.
+
+[license-url]: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/LICENSE
+[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
+[goref-image]: https://pkg.go.dev/badge/go.opentelemetry.io/contrib/detectors/aws/lambda.svg
+[goref-url]: https://pkg.go.dev/go.opentelemetry.io/contrib/detectors/aws/lambda
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-go/discussions

detectors/aws/lambda/detector.go

@@ -0,0 +1,68 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package lambda
+
+import (
+	"context"
+	"errors"
+	"os"
+
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/sdk/resource"
+	semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
+)
+
+const (
+	lambdaFunctionNameEnvVar    = "AWS_LAMBDA_FUNCTION_NAME"
+	awsRegionEnvVar             = "AWS_REGION"
+	lambdaFunctionVersionEnvVar = "AWS_LAMBDA_FUNCTION_VERSION"
+)
+
+var (
+	empty          = resource.Empty()
+	errNotOnLambda = errors.New("process is not on Lambda, cannot detect environment variables from Lambda")
+)
+
+// resource detector collects resource information from Lambda environment
+type resourceDetector struct{}
+
+// compile time assertion that resource detector implements the resource.Detector interface.
+var _ resource.Detector = (*resourceDetector)(nil)
+
+// NewResourceDetector returns a resource detector that will detect AWS Lambda resources.
+func NewResourceDetector() resource.Detector {
+	return &resourceDetector{}
+}
+
+// Detect collects resource attributes available when running on lambda
+func (detector *resourceDetector) Detect(context.Context) (*resource.Resource, error) {
+
+	// Lambda resources come from ENV
+	lambdaName := os.Getenv(lambdaFunctionNameEnvVar)
+	if len(lambdaName) == 0 {
+		return empty, errNotOnLambda
+	}
+	awsRegion := os.Getenv(awsRegionEnvVar)
+	functionVersion := os.Getenv(lambdaFunctionVersionEnvVar)
+
+	attrs := []attribute.KeyValue{
+		semconv.CloudProviderAWS,
+		semconv.CloudRegionKey.String(awsRegion),
+		semconv.FaaSNameKey.String(lambdaName),
+		semconv.FaaSVersionKey.String(functionVersion),
+	}
+
+	return resource.NewWithAttributes(semconv.SchemaURL, attrs...), nil
+}

detectors/aws/lambda/detector_test.go

@@ -0,0 +1,58 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package lambda
+
+import (
+	"context"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/sdk/resource"
+	semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
+)
+
+// successfully return resource when process is running on Amazon Lambda environment
+func TestDetectSuccess(t *testing.T) {
+	os.Clearenv()
+	_ = os.Setenv(lambdaFunctionNameEnvVar, "testFunction")
+	_ = os.Setenv(awsRegionEnvVar, "us-texas-1")
+	_ = os.Setenv(lambdaFunctionVersionEnvVar, "$LATEST")
+
+	attributes := []attribute.KeyValue{
+		semconv.CloudProviderAWS,
+		semconv.CloudRegionKey.String("us-texas-1"),
+		semconv.FaaSNameKey.String("testFunction"),
+		semconv.FaaSVersionKey.String("$LATEST"),
+	}
+	expectedResource := resource.NewWithAttributes(semconv.SchemaURL, attributes...)
+	detector := resourceDetector{}
+	res, err := detector.Detect(context.Background())
+
+	assert.Nil(t, err, "Detector unexpectedly returned error")
+	assert.Equal(t, expectedResource, res, "Resource returned is incorrect")
+}
+
+// return empty resource when not running on lambda
+func TestReturnsIfNoEnvVars(t *testing.T) {
+	os.Clearenv()
+	detector := resourceDetector{}
+	res, err := detector.Detect(context.Background())
+
+	assert.Equal(t, errNotOnLambda, err)
+	assert.Equal(t, 0, len(res.Attributes()))
+}

detectors/aws/lambda/go.mod

@@ -0,0 +1,11 @@
+module go.opentelemetry.io/contrib/detectors/aws/lambda
+
+go 1.15
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/stretchr/testify v1.7.0
+	go.opentelemetry.io/otel v1.0.0-RC2
+	go.opentelemetry.io/otel/sdk v1.0.0-RC2
+	gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776 // indirect
+)

detectors/aws/lambda/go.sum

@@ -0,0 +1,25 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/go-cmp v0.5.6 h1:BKbKCqvP6I+rmFHt06ZmyQtvB8xAkWdhFyr0ZUNZcxQ=
+github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+go.opentelemetry.io/otel v1.0.0-RC2 h1:SHhxSjB+omnGZPgGlKe+QMp3MyazcOHdQ8qwo89oKbg=
+go.opentelemetry.io/otel v1.0.0-RC2/go.mod h1:w1thVQ7qbAy8MHb0IFj8a5Q2QU0l2ksf8u/CN8m3NOM=
+go.opentelemetry.io/otel/sdk v1.0.0-RC2 h1:ROuteeSCBaZNjiT9JcFzZepmInDvLktR28Y6qKo8bCs=
+go.opentelemetry.io/otel/sdk v1.0.0-RC2/go.mod h1:fgwHyiDn4e5k40TD9VX243rOxXR+jzsWBZYA2P5jpEw=
+go.opentelemetry.io/otel/trace v1.0.0-RC2 h1:dunAP0qDULMIT82atj34m5RgvsIK6LcsXf1c/MsYg1w=
+go.opentelemetry.io/otel/trace v1.0.0-RC2/go.mod h1:JPQ+z6nNw9mqEGT8o3eoPTdnNI+Aj5JcxEsVGREIAy4=
+golang.org/x/sys v0.0.0-20210423185535-09eb48e85fd7 h1:iGu644GcxtEcrInvDsQRCwJjtCIOlT2V7IRt6ah2Whw=
+golang.org/x/sys v0.0.0-20210423185535-09eb48e85fd7/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776 h1:tQIYjPdBoyREyB9XMu+nnTclpTYkz2zFM+lzLJFO4gQ=
+gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=