-
Notifications
You must be signed in to change notification settings - Fork 192
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Lambda exec wrapper calls upstream OTel Python auto instr script
- Loading branch information
1 parent
e6e7905
commit 5916901
Showing
5 changed files
with
311 additions
and
224 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,141 @@ | ||
#!/usr/bin/env python3 | ||
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
# SPDX-License-Identifier: MIT-0 | ||
|
||
from os import environ, system | ||
import sys | ||
|
||
# the path to the interpreter and all of the originally intended arguments | ||
args = sys.argv[1:] | ||
|
||
# enable OTel wrapper | ||
environ["ORIG_HANDLER"] = environ.get("_HANDLER") | ||
environ["_HANDLER"] = "otel_wrapper.lambda_handler" | ||
|
||
# config default traces exporter if missing | ||
environ.setdefault("OTEL_TRACES_EXPORTER", "otlp_proto_grpc_span") | ||
|
||
# set service name | ||
if environ.get("OTEL_RESOURCE_ATTRIBUTES") is None: | ||
environ["OTEL_RESOURCE_ATTRIBUTES"] = "service.name=%s" % ( | ||
environ.get("AWS_LAMBDA_FUNCTION_NAME") | ||
) | ||
elif "service.name=" not in environ.get("OTEL_RESOURCE_ATTRIBUTES"): | ||
environ["OTEL_RESOURCE_ATTRIBUTES"] = "service.name=%s,%s" % ( | ||
environ.get("AWS_LAMBDA_FUNCTION_NAME"), | ||
environ.get("OTEL_RESOURCE_ATTRIBUTES"), | ||
) | ||
|
||
# TODO: Remove if sdk support resource detector env variable configuration. | ||
lambda_resource_attributes = ( | ||
"cloud.region=%s,cloud.provider=aws,faas.name=%s,faas.version=%s" | ||
% ( | ||
environ.get("AWS_REGION"), | ||
environ.get("AWS_LAMBDA_FUNCTION_NAME"), | ||
environ.get("AWS_LAMBDA_FUNCTION_VERSION"), | ||
) | ||
) | ||
environ["OTEL_RESOURCE_ATTRIBUTES"] = "%s,%s" % ( | ||
lambda_resource_attributes, | ||
environ.get("OTEL_RESOURCE_ATTRIBUTES"), | ||
) | ||
|
||
# start the runtime with the extra options | ||
system(" ".join(args)) | ||
#!/usr/bin/env bash | ||
|
||
# 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. | ||
|
||
: ' | ||
`otel-instrument` | ||
This script configures and sets up OpenTelemetry Python with the values we | ||
expect will be used by the common user. It does this by setting the environment | ||
variables OpenTelemetry uses, and then initializing OpenTelemetry using the | ||
`opentelemetry-instrument` auto instrumentation script from the | ||
`opentelemetry-instrumentation` package. | ||
Additionally, this configuration assumes the user is using packages conforming | ||
to the `opentelemetry-instrumentation` and `opentelemetry-sdk` specifications. | ||
DO NOT use this script for anything else besides SETTING ENVIRONMENT VARIABLES. | ||
See more: | ||
https://docs.aws.amazon.com/lambda/latest/dg/runtimes-modify.html#runtime-wrapper | ||
Usage | ||
----- | ||
We expect this file to be at the root of a Lambda Layer. Having it anywhere else | ||
seems to mean AWS Lambda cannot find it. | ||
In the configuration of an AWS Lambda function with this file at the | ||
root level of a Lambda Layer: | ||
.. code:: | ||
AWS_LAMBDA_EXEC_WRAPPER = /opt/otel-instrument | ||
' | ||
|
||
# Use constants to access the environment variables we want to use in this | ||
# script. | ||
|
||
# See more: | ||
# https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime | ||
|
||
# - Reserved environment variables | ||
|
||
# - - $AWS_LAMBDA_FUNCTION_NAME | ||
# - - $LAMBDA_RUNTIME_DIR | ||
|
||
# - Unreserved environment variables | ||
|
||
# - - $PYTHONPATH | ||
|
||
# Update the python paths for packages with `sys.path` and `PYTHONPATH` | ||
|
||
# - We know that the path to the Lambda Layer OpenTelemetry Python packages are | ||
# well defined, so we can add them to the PYTHONPATH. | ||
# | ||
# See more: | ||
# https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html#configuration-layers-path | ||
|
||
export LAMBDA_LAYER_PKGS_DIR="/opt/python" | ||
|
||
# - Set Lambda Layer python packages in PYTHONPATH so `opentelemetry-instrument` | ||
# script can find them (it needs to find `opentelemetry` to find the auto | ||
# instrumentation `run()` method later) | ||
|
||
if [ -z ${PYTHONPATH} ]; then | ||
export PYTHONPATH=$LAMBDA_LAYER_PKGS_DIR; | ||
else | ||
export PYTHONPATH="$LAMBDA_LAYER_PKGS_DIR:$PYTHONPATH"; | ||
fi | ||
|
||
# - Set Lambda runtime python packages in PYTHONPATH so | ||
# `opentelemetry-instrument` script can find them during auto instrumentation | ||
# and instrument them. | ||
|
||
export PYTHONPATH="$LAMBDA_RUNTIME_DIR:$PYTHONPATH"; | ||
|
||
# Configure OpenTelemetry Python with environment variables | ||
|
||
# - Set the default Trace Exporter | ||
|
||
if [ -z ${OTEL_TRACES_EXPORTER} ]; then | ||
export OTEL_TRACES_EXPORTER="otlp_proto_grpc_span"; | ||
fi | ||
|
||
# - Set the service name | ||
|
||
if [ -z ${OTEL_SERVICE_NAME} ]; then | ||
export OTEL_SERVICE_NAME=$AWS_LAMBDA_FUNCTION_NAME; | ||
fi | ||
|
||
# - Set the Resource Detectors (Resource Attributes) | ||
# | ||
# TODO: waiting on OTel Python support for configuring Resource Detectors from | ||
# an environment variable. Replace the bottom code with the following when | ||
# this is possible. | ||
# | ||
# export OTEL_RESOURCE_DETECTORS="aws_lambda"; | ||
# | ||
export LAMBDA_RESOURCE_ATTRIBUTES="cloud.region=$AWS_REGION,cloud.provider=aws,faas.name=$AWS_LAMBDA_FUNCTION_NAME,faas.version=$AWS_LAMBDA_FUNCTION_VERSION" | ||
|
||
if [ -z ${OTEL_RESOURCE_ATTRIBUTES} ]; then | ||
export OTEL_RESOURCE_ATTRIBUTES=$LAMBDA_RESOURCE_ATTRIBUTES; | ||
else | ||
export OTEL_RESOURCE_ATTRIBUTES="$LAMBDA_RESOURCE_ATTRIBUTES,$OTEL_RESOURCE_ATTRIBUTES"; | ||
fi | ||
|
||
# - Set the default propagators | ||
|
||
if [ -z ${OTEL_PROPAGATORS} ]; then | ||
export OTEL_PROPAGATORS="tracecontext,b3,xray"; | ||
fi | ||
|
||
# - Use a wrapper because AWS Lambda's `python3 /var/runtime/bootstrap.py` will | ||
# use `imp.load_module` to load the function from the `_HANDLER` environment | ||
# variable. This RELOADS the module and REMOVES any instrumentation patching | ||
# done earlier. So we delay instrumentation until `boostrap.py` imports | ||
# `otel_wrapper.py` at which we know the patching will be picked up. | ||
# | ||
# See more: | ||
# https://docs.python.org/3/library/imp.html#imp.load_module | ||
|
||
export ORIG_HANDLER=$_HANDLER; | ||
export _HANDLER="otel_wrapper.lambda_handler"; | ||
|
||
# - Call the upstream auto instrumentation script | ||
|
||
python3 $LAMBDA_LAYER_PKGS_DIR/bin/opentelemetry-instrument "$@" | ||
|
||
|
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 was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# 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. | ||
|
||
|
||
def handler(event, context): | ||
return "200 ok" |
Oops, something went wrong.