Go lambda support #129

bhautikpip · 2021-08-12T22:59:37Z

Draft as replaces Otel go contrib with forked repo for otellambda package as otellambda is not merged into contrib yet. See PR here: open-telemetry/opentelemetry-go-contrib#882

…lambda into go-lambda-support

garrettwegan

Blocked on contrib #983, contrib #984, and aws-otel.github.io #142

TODO: see comments

garrettwegan · 2021-08-13T05:50:30Z

go/README.md

+[OpenTelemetry Lambda SDK for Go]() includes tracing APIs to instrument Lambda handler. Follow the instructions on [user guide]() to manually instrument the 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]() includes OpenTelemetry Collector for Lambda components. Follow [user guide]() to apply this layer to your Lambda handler that's already been instrumented with OpenTelemetry Lambda Go SDK to enable end-to-end tracing.


Links need to be inserted once the targets exist. These should be correct:

Suggested change

[OpenTelemetry Lambda SDK for Go]() includes tracing APIs to instrument Lambda handler. Follow the instructions on [user guide]() to manually instrument the 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]() includes OpenTelemetry Collector for Lambda components. Follow [user guide]() to apply this layer to your Lambda handler that's already been instrumented with OpenTelemetry Lambda Go SDK to enable end-to-end tracing.

[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. Follow the instructions on [user guide]() to manually instrument the 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#instrumentation) to apply this layer to your Lambda handler that's already been instrumented with OpenTelemetry Lambda Go SDK to enable end-to-end tracing.

We should remove the section for the Provided layer because it is vendor-specific.

And also should remove reference to user guide. We should have a section on building the layer if possible like other layers have instead? E.g. https://github.com/open-telemetry/opentelemetry-lambda/tree/main/java#building

Not sure. I think we should keep the guide since it's brief - https://github.com/aws-otel/aws-otel.github.io/pull/142/files. I also think rather than having documentation at 2 places we should only put it in a single place (official docs) which is easier to maintain. Also, sometime just in case if we update official doc and missed updating READEME it would confuse customers.

garrettwegan · 2021-08-13T05:55:58Z

go/README.md

+
+## Sample application
+
+The [sample application]() shows the manual instrumentations of OpenTelemetry Lambda .NET SDK on a Lambda handler that triggers downstream requests to AWS S3 and HTTP.


This link also needs to be populated but is a little different because it points into the PR, can either just do the end goal url ("https://github.com/open-telemetry/opentelemetry-lambda/blob/main/go/sample-apps/function/function.go") or just a relative path ("./sample-apps/function/function.go").

Suggested change

The [sample application]() shows the manual instrumentations of OpenTelemetry Lambda .NET SDK on a Lambda handler that triggers downstream requests to AWS S3 and HTTP.

The [sample application]() shows the manual instrumentations of OpenTelemetry Lambda Go SDK on a Lambda handler that triggers downstream requests to AWS S3 and HTTP.

garrettwegan · 2021-08-13T05:58:20Z

go/sample-apps/function/go.mod

+replace (
+	go.opentelemetry.io/contrib/detectors/aws/lambda => github.com/garrettwegan/opentelemetry-go-contrib/detectors/aws/lambda v0.0.0-20210730164323-986e366f4c23
+	go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda => github.com/garrettwegan/opentelemetry-go-contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda v0.0.0-20210730164323-986e366f4c23
+	go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig => github.com/garrettwegan/opentelemetry-go-contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig v0.0.0-20210730201622-eef81a9505f4
+)


Remove upon merge of contrib PRs #983 and #984 and run go mod tidy

Also need to upgrade to latest versions of OTel go dependencies (1.0.0+)

garrettwegan · 2021-08-13T05:59:00Z

go/sample-apps/function/function.go

+
+func main() {
+	lambda.Start(otellambda.WrapHandlerFunction(lambda_handler, xrayconfig.AllRecommendedOptions()...))
+}


Suggested change

}

}

willarmiros

A few callouts we can change once this PR is unblocked

willarmiros · 2021-10-25T18:52:50Z

go/README.md

+[OpenTelemetry Lambda SDK for Go]() includes tracing APIs to instrument Lambda handler. Follow the instructions on [user guide]() to manually instrument the 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]() includes OpenTelemetry Collector for Lambda components. Follow [user guide]() to apply this layer to your Lambda handler that's already been instrumented with OpenTelemetry Lambda Go SDK to enable end-to-end tracing.


We should remove the section for the Provided layer because it is vendor-specific.

willarmiros · 2021-10-25T18:53:07Z

go/README.md

+
+## Sample application
+
+The [sample application]() shows the manual instrumentations of OpenTelemetry Lambda .NET SDK on a Lambda handler that triggers downstream requests to AWS S3 and HTTP.


Suggested change

The [sample application]() shows the manual instrumentations of OpenTelemetry Lambda .NET SDK on a Lambda handler that triggers downstream requests to AWS S3 and HTTP.

The [sample application]() shows the manual instrumentations of OpenTelemetry Lambda Go SDK on a Lambda handler that triggers downstream requests to AWS S3 and HTTP.

willarmiros · 2021-10-25T18:53:59Z

go/sample-apps/deploy/variables.tf

+variable "collector_layer_arn" {
+  type        = string
+  description = "ARN for the Lambda layer containing the OpenTelemetry collector extension"
+  default     = "arn:aws:lambda:us-east-1:901920570463:layer:aws-otel-collector-ver-0-27-0:1"


Will need to update this to latest

Suggested change

default = "arn:aws:lambda:us-east-1:901920570463:layer:aws-otel-collector-ver-0-27-0:1"

default = "arn:aws:lambda:us-east-1:901920570463:layer:aws-otel-collector-ver-0-29-1:1"

willarmiros · 2021-10-25T18:55:02Z

go/sample-apps/function/go.mod

+replace (
+	go.opentelemetry.io/contrib/detectors/aws/lambda => github.com/garrettwegan/opentelemetry-go-contrib/detectors/aws/lambda v0.0.0-20210730164323-986e366f4c23
+	go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda => github.com/garrettwegan/opentelemetry-go-contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda v0.0.0-20210730164323-986e366f4c23
+	go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig => github.com/garrettwegan/opentelemetry-go-contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig v0.0.0-20210730201622-eef81a9505f4
+)


Also need to upgrade to latest versions of OTel go dependencies (1.0.0+)

…y-lambda into go-lambda-support

willarmiros

Few more comments, then lgtm

willarmiros · 2021-10-28T19:49:45Z

go/README.md

+
+## Sample application
+
+The [sample application]() shows the manual instrumentations of OpenTelemetry Lambda Go SDK on a Lambda handler that triggers downstream requests to AWS S3 and HTTP.


Link the sample app here.

willarmiros · 2021-10-28T19:50:02Z

go/README.md

+
+## 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. Follow the instructions on [user guide](https://aws-otel.github.io/docs/getting-started/lambda/lambda-go) to manually instrument the Lambda handler.


Suggested change

[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. Follow the instructions on [user guide](https://aws-otel.github.io/docs/getting-started/lambda/lambda-go) to manually instrument the Lambda handler.

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

Can't have anything vendor-specific

willarmiros · 2021-10-28T19:52:02Z

go/sample-apps/deploy/variables.tf

+variable "collector_layer_arn" {
+  type        = string
+  description = "ARN for the Lambda layer containing the OpenTelemetry collector extension"
+  default     = "arn:aws:lambda:us-east-1:901920570463:layer:aws-otel-collector-ver-0-27-0:1"


Suggested change

default = "arn:aws:lambda:us-east-1:901920570463:layer:aws-otel-collector-ver-0-27-0:1"

default = "arn:aws:lambda:us-east-1:901920570463:layer:aws-otel-collector-ver-0-29-1:1"

go/sample-apps/deploy/variables.tf

Co-authored-by: Anuraag Agrawal <anuraaga@gmail.com>

garrettwegan and others added 12 commits July 12, 2021 14:10

Implement sample app

751aa49

Implement build script

0071899

Create README

ca05487

Add go support

6bf141f

Merge branch 'open-telemetry:main' into main

3587e81

Use unspecified otellambda version

dfeb33d

Merge branch 'main' of github.com:garrettwegan/opentelemetry-lambda

bda7d74

Change function return type to allow API Gateway Proxy

4daccac

Add terraform files for integration tests

259b41d

Fix file path

43dcb32

Update to use xrayconfig package

1d216cc

Merge branch 'main' of https://github.com/garrettwegan/opentelemetry-…

91ef183

…lambda into go-lambda-support

bhautikpip requested review from anuraaga, codeboten and wangzlei as code owners August 12, 2021 22:59

bhautikpip marked this pull request as draft August 12, 2021 23:16

bhautikpip mentioned this pull request Aug 12, 2021

Add Support for Go on Lambda #118

Closed

garrettwegan reviewed Aug 13, 2021

View reviewed changes

garrettwegan mentioned this pull request Aug 13, 2021

Sample app, CI/CD - Go aws-observability/aws-otel-lambda#127

Merged

willarmiros reviewed Oct 25, 2021

View reviewed changes

bhautikpip added 2 commits October 27, 2021 12:34

Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…

782577e

…y-lambda into go-lambda-support

rebase and minor changes

316ecaa

bhautikpip marked this pull request as ready for review October 28, 2021 19:31

willarmiros approved these changes Oct 28, 2021

View reviewed changes

update collector layer arn and minor README changes

ba19b3a

anuraaga approved these changes Oct 29, 2021

View reviewed changes

go/sample-apps/deploy/variables.tf Outdated Show resolved Hide resolved

Update go/sample-apps/deploy/variables.tf

d219f3a

Co-authored-by: Anuraag Agrawal <anuraaga@gmail.com>

wangzlei approved these changes Oct 29, 2021

View reviewed changes

wangzlei merged commit 941e6db into open-telemetry:main Oct 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Go lambda support #129

Go lambda support #129

bhautikpip commented Aug 12, 2021

garrettwegan left a comment

garrettwegan Aug 13, 2021

willarmiros Oct 25, 2021

willarmiros Oct 27, 2021

bhautikpip Oct 28, 2021

garrettwegan Aug 13, 2021

willarmiros Oct 25, 2021

garrettwegan Aug 13, 2021

willarmiros Oct 25, 2021

garrettwegan Aug 13, 2021

willarmiros left a comment

willarmiros Oct 25, 2021

willarmiros Oct 25, 2021

willarmiros Oct 25, 2021

willarmiros Oct 28, 2021

willarmiros Oct 25, 2021

willarmiros left a comment

willarmiros Oct 28, 2021

willarmiros Oct 28, 2021

willarmiros Oct 28, 2021


		## Sample application

		The [sample application]() shows the manual instrumentations of OpenTelemetry Lambda .NET SDK on a Lambda handler that triggers downstream requests to AWS S3 and HTTP.

	default = "arn:aws:lambda:us-east-1:901920570463:layer:aws-otel-collector-ver-0-27-0:1"
	default = "arn:aws:lambda:us-east-1:901920570463:layer:aws-otel-collector-ver-0-29-1:1"


		## 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. Follow the instructions on [user guide](https://aws-otel.github.io/docs/getting-started/lambda/lambda-go) to manually instrument the Lambda handler.

Go lambda support #129

Go lambda support #129

Conversation

bhautikpip commented Aug 12, 2021

garrettwegan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willarmiros left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willarmiros left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment