Skip to content

[SVLS-8138] Add remote instrumentation instructions for all runtimes #33256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
TalUsvyatsky wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[SVLS-8138] Add remote instrumentation instructions for all runtimes #33256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/en/serverless/aws_lambda/instrumentation/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ The quick start process configures your Lambda functions on the fly. To instrume

## Instrumentation instructions

For Node.js and Python runtimes, you can use [remote instrumentation][5] to add instrumentation to your AWS Lambda functions and keep them instrumented securely. See [Remote instrumentation for AWS Lambda][5].
You can use [remote instrumentation][5] to add instrumentation to your AWS Lambda functions and keep them instrumented securely. See [Remote instrumentation for AWS Lambda][5].

For other Lambda runtimes (or to instrument your Node.js or Python functions without remote instrumentation) see detailed instrumentation instructions:
To instrument your functions without remote instrumentation, see detailed instrumentation instructions:

{{< partial name="serverless/getting-started-languages.html" >}}

Expand All @@ -54,4 +54,4 @@ After you're done with instrumentation and you've set up telemetry collection, y
[4]: /serverless/aws_lambda/fips-compliance/
[5]: /serverless/aws_lambda/remote_instrumentation
[6]: https://github.com/DataDog/serverless-sample-app
[8]: https://app.datadoghq.com/fleet/install-agent/latest?platform=lambda
[8]: https://app.datadoghq.com/fleet/install-agent/latest?platform=lambda
9 changes: 9 additions & 0 deletions content/en/serverless/aws_lambda/instrumentation/dotnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ further_reading:
If your application is deployed as a container image, use the _Container Image_ method.

{{< tabs >}}
{{% tab "Datadog UI" %}}
You can instrument your .NET AWS Lambda application directly within Datadog. Navigate to the [Serverless > AWS Lambda][2] page and select [**Instrument Functions**][3].

For more information, see [Remote instrumentation for AWS Lambda][1].

[1]: /serverless/aws_lambda/remote_instrumentation
[2]: https://app.datadoghq.com/functions?cloud=aws
[3]: https://app.datadoghq.com/serverless/aws/lambda/setup
{{% /tab %}}
{{% tab "Datadog CLI" %}}

The Datadog CLI modifies existing Lambda functions' configurations to enable instrumentation without requiring a new deployment. It is the quickest way to get started with Datadog's serverless monitoring.
Expand Down
11 changes: 10 additions & 1 deletion content/en/serverless/aws_lambda/instrumentation/go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ If your application is deployed as a container image, use the _Container Image_
**Note**: Datadog recommends that you use Go tracer v1.73.1 for instrumenting AWS Lambda functions. Go tracer v2 is not supported.

{{< tabs >}}
{{% tab "Datadog UI" %}}
You can instrument your Go AWS Lambda application directly within Datadog. Navigate to the [Serverless > AWS Lambda][2] page and select [**Instrument Functions**][3].

For more information, see [Remote instrumentation for AWS Lambda][1].

[1]: /serverless/aws_lambda/remote_instrumentation
[2]: https://app.datadoghq.com/functions?cloud=aws
[3]: https://app.datadoghq.com/serverless/aws/lambda/setup
{{% /tab %}}
{{% tab "Serverless Framework" %}}

The [Datadog Serverless Plugin][1] automatically configures your functions to send metrics, traces, and logs to Datadog through the [Datadog Lambda Extension][2].
Expand Down Expand Up @@ -204,7 +213,7 @@ Replace `<AWS_REGION>` with a valid AWS region, such as `us-east-1`.
### Install the Datadog Lambda library

```
go get github.com/DataDog/dd-trace-go/contrib/aws/datadog-lambda-go/v2
go get github.com/DataDog/dd-trace-go/contrib/aws/datadog-lambda-go/v2
```

### Update your Lambda function code
Expand Down
11 changes: 10 additions & 1 deletion content/en/serverless/aws_lambda/instrumentation/java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ If you are using the Datadog Lambda layers `dd-trace-java:4` (or older) and `Dat
If your application is deployed as a container image, use the _Container Image_ method.

{{< tabs >}}
{{% tab "Datadog UI" %}}
You can instrument your Java AWS Lambda application directly within Datadog. Navigate to the [Serverless > AWS Lambda][2] page and select [**Instrument Functions**][3].

For more information, see [Remote instrumentation for AWS Lambda][1].

[1]: /serverless/aws_lambda/remote_instrumentation
[2]: https://app.datadoghq.com/functions?cloud=aws
[3]: https://app.datadoghq.com/serverless/aws/lambda/setup
{{% /tab %}}
{{% tab "Datadog CLI" %}}

The Datadog CLI modifies existing Lambda functions' configurations to enable instrumentation without requiring a new deployment. It is the quickest way to get started with Datadog's serverless monitoring.
Expand Down Expand Up @@ -332,4 +341,4 @@ module "lambda-datadog" {
[11]: /security/application_security/serverless/
[12]: https://github.com/DataDog/datadog-lambda-extension
[13]: https://github.com/DataDog/datadog-lambda-extension/issues
[14]: /serverless/aws_lambda/configuration?tab=datadogcli#collect-the-request-and-response-payloads
[14]: /serverless/aws_lambda/configuration?tab=datadogcli#collect-the-request-and-response-payloads
11 changes: 10 additions & 1 deletion content/en/serverless/aws_lambda/instrumentation/ruby.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,15 @@ aliases:
If your application is deployed as a container image, use the _Container Image_ method.

{{< tabs >}}
{{% tab "Datadog UI" %}}
You can instrument your Ruby AWS Lambda application directly within Datadog. Navigate to the [Serverless > AWS Lambda][2] page and select [**Instrument Functions**][3].

For more information, see [Remote instrumentation for AWS Lambda][1].

[1]: /serverless/aws_lambda/remote_instrumentation
[2]: https://app.datadoghq.com/functions?cloud=aws
[3]: https://app.datadoghq.com/serverless/aws/lambda/setup
{{% /tab %}}
{{% tab "Datadog CLI" %}}

The Datadog CLI modifies existing Lambda functions' configurations to enable instrumentation without requiring a new deployment. It is the quickest way to get started with Datadog's serverless monitoring.
Expand Down Expand Up @@ -410,4 +419,4 @@ For more information on custom metric submission, see [Serverless Custom Metrics
[8]: /tracing/custom_instrumentation/ruby/
[9]: /security/application_security/serverless/
[10]: https://github.com/DataDog/datadog-lambda-extension
[11]: https://github.com/DataDog/datadog-lambda-extension/issues
[11]: https://github.com/DataDog/datadog-lambda-extension/issues
16 changes: 7 additions & 9 deletions content/en/serverless/aws_lambda/remote_instrumentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ title: Remote instrumentation for AWS Lambda

{{< img src="serverless/lambda/svl_lambda_remote.png" alt="AWS Remote Instrumentation page in Datadog, showing a 'Scope functions to instrument using tags' box and functions available for remote instrumentation." style="width:100%;" >}}

_Supported runtimes_: Node.js, Python

You can use remote instrumentation to quickly add instrumentation to your AWS Lambda functions and keep them instrumented securely.

The _instrumenter_ is a Lambda function that ensures your target functions have the Datadog Lambda extension and Datadog Lambda library added. The instrumenter also ensures that your functions remain instrumented and can send telemetry to Datadog.
Expand Down Expand Up @@ -39,11 +37,11 @@ The instrumenter must be deployed to every region and account where you want to
The CloudFormation stack deploys the instrumenter function, **datadog-remote-instrumenter**, into your account and region. The stack also creates a CloudTrail and some adjacent resources.

1. After the instrumenter function is deployed, select functions to instrument. You can select functions by function name, tags, or combinations of tags. See the [Selecting functions](#selecting-functions) section for more details.

After you finish your selections, click **Next**.

1. Confirm your function selections.
1. Confirm your function selections.

You can also set layer versions and toggle logging and tracing. These settings are used for all future instrumentation and remain fixed until you manually update them. Updates can take a few minutes to be applied.

After you set your configuration, the instrumenter automatically instruments any functions that newly satisfy your configured targeting rules. The instrumenter also keeps your functions instrumented. If Datadog layers or environment variables on a matching function are modified outside of remote instrumentation, the instrumenter automatically re-instruments your function.
Expand Down Expand Up @@ -75,20 +73,20 @@ Datadog recommends that you only instrument Lambda functions with a memory size

## Verification

After the remote instrumenter Lambda has applied instrumentation to your functions, the status column displays an **Instrumented** status. You can also confirm your functions are instrumented by opening your AWS Console and ensuring that two layers (Datadog Lambda extension and `datadog-lambda-python` or `datadog-lambda-js`) have been added to each selected function.
After the remote instrumenter Lambda has applied instrumentation to your functions, the status column displays an **Instrumented** status. You can also confirm your functions are instrumented by opening your AWS Console and ensuring that two layers (Datadog Lambda extension and a Datadog tracing layer) have been added to each selected function.

## Upgrading to a new version

1. Find [datadog-remote-instrument][5] (if you didn't rename it) CloudFormation stack.
2. Find the current version of the stack template in the **Template** tab.
2. Find the current version of the stack template in the **Template** tab.
```yaml
Mappings:
Constants:
DdRemoteInstrumentApp:
Version: <TEMPLATE_VERSION>
```
Note down the value of the template version, such as `1.10.0`, in case you run into issues with the new version and need to roll back.
3. Update the stack using template URL `https://datadog-cloudformation-template.s3.amazonaws.com/aws/remote-instrument/latest.yaml`. You can also replace `latest` with a specific version, such as `1.10.0`, if needed. Check the [releases page][6] for new features and fixes. Make sure to review the changesets before applying the update.
3. Update the stack using template URL `https://datadog-cloudformation-template.s3.amazonaws.com/aws/remote-instrument/latest.yaml`. You can also replace `latest` with a specific version, such as `1.10.0`, if needed. Check the [releases page][6] for new features and fixes. Make sure to review the changesets before applying the update.


## Removing instrumentation
Expand All @@ -109,4 +107,4 @@ If you see issues related to IAM roles, ensure that you have permission to creat
[3]: https://app.datadoghq.com/functions?cloud=aws
[4]: /agent/remote_config/?tab=configurationyamlfile#setup
[5]: https://console.aws.amazon.com/cloudformation/home#/stacks?filteringText=datadog-remote-instrument
[6]: https://github.com/DataDog/serverless-remote-instrumentation/releases
[6]: https://github.com/DataDog/serverless-remote-instrumentation/releases
Loading