Add the ability to exclude functions from being instrumented #135
Conversation
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
brett0000FF
approved these changes
Sep 19, 2024
serverless/README.md
Outdated
| @@ -121,7 +121,9 @@ To further configure your plugin, use the following custom parameters: | |||
| | `nodeLayerVersion` | Version of the Node.js Lambda layer to install, such as "29". Required if you are deploying at least one Lambda function written in Node.js and `addLayers` is true. Find the latest version number from [https://github.com/DataDog/datadog-lambda-js/releases][6]. | | |||
| | `dotnetLayerVersion` | Version of the .NET Lambda layer to install, such as "14". Required if you are deploying at least one Lambda function written in .NET and `addLayers` is true. Find the latest version number from [https://github.com/DataDog/dd-trace-dotnet-aws-lambda-layer/releases][9]. | |||
| | `javaLayerVersion` | Version of the Java Lambda layer to install, such as "12". Required if you are deploying at least one Lambda function written in Java and `addLayers` is true. Find the latest version number from [https://github.com/DataDog/datadog-lambda-java/releases][10]. | |||
| | `extensionLayerVersion` | Version of the Datadog Lambda Extension layer to install, such as "5". When `extensionLayerVersion` is set, `apiKey` (or if encrypted, `apiKMSKey` or `apiKeySecretArn`) needs to be set as well. While using `extensionLayerVersion` do not set `forwarderArn`. Learn more about the Lambda extension [here][8]. | | |||
| | `extensionLayerVersion` | Version of the Datadog Lambda Extension layer to install, such as "5". When `extensionLayerVersion` is set, `apiKey` (or if encrypted, `apiKMSKey` or `apiKeySecretArn`) needs to be set as well. | | |||
| | `addExtension` | Whether to add the Lambda extension layer to the Lambda function. Defaults to true. When true, the extension layer is applied which handles sending logs, traces and custom metrics. The Parameter `extensionLayerVersion` must be set. While using `extensionLayerVersion` do not set `forwarderArn`. Learn more about the Lambda extension [here][8]. | | |||
There was a problem hiding this comment.
Suggested change
| | `addExtension` | Whether to add the Lambda extension layer to the Lambda function. Defaults to true. When true, the extension layer is applied which handles sending logs, traces and custom metrics. The Parameter `extensionLayerVersion` must be set. While using `extensionLayerVersion` do not set `forwarderArn`. Learn more about the Lambda extension [here][8]. | | |
| | `addExtension` | Whether to add the Lambda extension layer to the Lambda function. Defaults to true. When true, the extension layer is applied which handles sending logs, traces, and custom metrics. The parameter `extensionLayerVersion` must be set. While using `extensionLayerVersion` do not set `forwarderArn`. To learn more, read the [Datadog Lambda Extension][8] documentation. | |
duncanista
reviewed
Sep 19, 2024
serverless/README.md
Outdated
Comment on lines
125
to
126
| | `addExtension` | Whether to add the Lambda extension layer to the Lambda function. Defaults to true. When true, the extension layer is applied which handles sending logs, traces and custom metrics. The Parameter `extensionLayerVersion` must be set. While using `extensionLayerVersion` do not set `forwarderArn`. Learn more about the Lambda extension [here][8]. | | ||
| | `exclude` | When set, the macro will ignore lambda specified functions. Use this if there are any functions that do not require datadog instrumentation. Defaults to []. | |
There was a problem hiding this comment.
Mmm where does addExtension come from?
There was a problem hiding this comment.
This was added in a previous commit. At the time I thought documentation was in a separate place. 😬 I am addressing it in this PR.
duncanista
reviewed
Sep 19, 2024
Updating the readme based on suggestion.
Fixing a typo.
duncanista
reviewed
Sep 19, 2024
| @@ -63,6 +63,9 @@ export interface Configuration { | |||
| // Optionally set by customer using `sam deploy --parameter-overrides DDGitData="$(git rev-parse HEAD),$(git config --get remote.origin.url)"` | |||
| // The customer template takes in the DDGitData override param and passes that to this macro's gitData param | |||
| gitData?: string; | |||
| // When set, the list of strings will be evalutated when processing each lambda function. if the string matches that function will not be instrumented by the macro. | |||
| exclude?: string[]; | |||
There was a problem hiding this comment.
Set the default to empty in the defaultConfiguration
duncanista
reviewed
Sep 19, 2024
Co-authored-by: Rey Abolofia <[email protected]>
purple4reina
approved these changes
Sep 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This pr introduces the parameter exclude that allows functions to be ignored by the transform command.
Motivation
Customers might encounter a situation where they may not want to instrument a function. This could be for many reason but one is for functions that require low latency
Testing Guidelines
I wrote a test case to ensure the that the function is not modified with layers and ensuring that the handler is not changed.
I also tested with a test deployment that had multiple functions with one function excluded. It instrumented the intended functions while leaving the desired excluded function untouched.
Additional Notes
Types of changes
Check all that apply