@datadog/datadog-ci-plugin-lambda 3.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +213 -0
- package/package.json +56 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2020 Datadog, Inc.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
You can use the CLI to instrument your AWS Lambda functions with Datadog. The CLI enables instrumentation by modifying existing Lambda functions' configuration and hence does *not* require redeployment. It is the quickest way to get started with Datadog serverless monitoring.
|
|
2
|
+
|
|
3
|
+
You can also add the command to your CI/CD pipelines to enable instrumentation for *all* your serverless applications. Run the command *after* your normal serverless application deployment, so that changes made by the Datadog CLI command do not get overridden.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
To instrument your Lambda functions using the `datadog-ci lambda instrument` command, follow the instructions for a specific runtime listed below:
|
|
8
|
+
|
|
9
|
+
- [.NET](https://docs.datadoghq.com/serverless/installation/dotnet/?tab=datadogcli)
|
|
10
|
+
- [Go](https://docs.datadoghq.com/serverless/installation/go/?tab=datadogcli)
|
|
11
|
+
- [Java](https://docs.datadoghq.com/serverless/installation/java/?tab=datadogcli)
|
|
12
|
+
- [Node.js](https://docs.datadoghq.com/serverless/installation/nodejs/?tab=datadogcli)
|
|
13
|
+
- [Python](https://docs.datadoghq.com/serverless/installation/python/?tab=datadogcli)
|
|
14
|
+
- [Ruby](https://docs.datadoghq.com/serverless/installation/ruby/?tab=datadogcli)
|
|
15
|
+
|
|
16
|
+
## Commands
|
|
17
|
+
|
|
18
|
+
### `instrument`
|
|
19
|
+
|
|
20
|
+
Run `datadog-ci lambda instrument` to apply Datadog instrumentation to a Lambda. This command adds the Datadog Lambda Library and/or the Datadog Lambda Extension as Lambda Layers to the instrumented Lambda functions and modifies their configurations.
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# Instrument multiple functions specified by names
|
|
24
|
+
datadog-ci lambda instrument -f <function-name> -f <another-function-name> -r us-east-1 -v 81 -e 49
|
|
25
|
+
|
|
26
|
+
# Instrument multiple functions specified by full ARNs
|
|
27
|
+
datadog-ci lambda instrument -f <lambda-arn> -f <another-lambda-arn> -f <a-third-lambda-arn> -v 81 -e 49
|
|
28
|
+
|
|
29
|
+
# Instrument function(s) in interactive mode
|
|
30
|
+
datadog-ci lambda instrument -i
|
|
31
|
+
|
|
32
|
+
# Instrument multiple functions that match a regex pattern
|
|
33
|
+
datadog-ci lambda instrument --functions-regex <valid-regex-pattern> -r us-east-1 -v 81 -e 49
|
|
34
|
+
|
|
35
|
+
# Dry run of all updates
|
|
36
|
+
datadog-ci lambda instrument -f <function-name> -f <another-function-name> -r us-east-1 -v 81 -e 49 --dry-run
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### `uninstrument`
|
|
40
|
+
|
|
41
|
+
Run `datadog-ci lambda uninstrument` to revert Datadog instrumentation in a Lambda. This command automatically removes the Datadog configuration, such as the Datadog Lambda Library and the Datadog Lambda Extension layers, as well as other configurations applied by the datadog-ci.
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# Uninstrument multiple functions specified by names
|
|
45
|
+
datadog-ci lambda uninstrument -f <function-name> -f <another-function-name> -r us-east-1
|
|
46
|
+
|
|
47
|
+
# Uninstrument function(s) in interactive mode
|
|
48
|
+
datadog-ci lambda uninstrument -i
|
|
49
|
+
|
|
50
|
+
# Uninstrument multiple functions that match a regex pattern
|
|
51
|
+
datadog-ci lambda uninstrument --functions-regex <valid-regex-pattern> -r us-east-1
|
|
52
|
+
|
|
53
|
+
# Dry run of all updates
|
|
54
|
+
datadog-ci lambda uninstrument -f <function-name> -f <another-function-name> -r us-east-1 --dry-run
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
See the configuration section for additional settings.
|
|
58
|
+
|
|
59
|
+
## Configuration
|
|
60
|
+
|
|
61
|
+
### AWS Credentials
|
|
62
|
+
|
|
63
|
+
You must have valid [AWS credentials][1] configured with access to the Lambda and CloudWatch services where you are running any `datadog-ci lambda` command.
|
|
64
|
+
|
|
65
|
+
### Environment variables
|
|
66
|
+
|
|
67
|
+
You must expose these environment variables in the environment where you are running `datadog-ci lambda instrument`:
|
|
68
|
+
|
|
69
|
+
| Environment Variable | Description | Example |
|
|
70
|
+
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
|
71
|
+
| `DATADOG_API_KEY` | Datadog API Key. Sets the `DD_API_KEY` environment variable on your Lambda function configuration. For more information about getting a Datadog API key, see the [API key documentation][5]. | `export DATADOG_API_KEY=<API_KEY>` |
|
|
72
|
+
| `DATADOG_API_KEY_SECRET_ARN` | The ARN of the secret storing the Datadog API key in AWS Secrets Manager. Sets the `DD_API_KEY_SECRET_ARN` on your Lambda function configuration. Notes: `DD_API_KEY_SECRET_ARN` is ignored when `DD_KMS_API_KEY` is set. Add the `secretsmanager:GetSecretValue` permission to the Lambda execution role. | `export DATADOG_API_KEY_SECRET_ARN=<SECRETS_MANAGER_RESOURCE_ARN>` |
|
|
73
|
+
| `DATADOG_KMS_API_KEY` | Datadog API Key encrypted using KMS. Sets the `DD_KMS_API_KEY` environment variable on your Lambda function configuration. Note: `DD_API_KEY` is ignored when `DD_KMS_API_KEY` is set. | `export DATADOG_KMS_API_KEY=<KMS_ENCRYPTED_API_KEY>` |
|
|
74
|
+
| `DATADOG_SITE` | Set which Datadog site to send data. Only needed when using the Datadog Lambda Extension. Possible values are `datadoghq.com` , `datadoghq.eu` , `us3.datadoghq.com`, `us5.datadoghq.com`, `ap1.datadoghq.com`, `ap2.datadoghq.com`, and `ddog-gov.com`. The default is `datadoghq.com`. Sets the `DD_SITE` environment variable on your Lambda function configurations. | `export DATADOG_SITE="datadoghq.com"` |
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### Arguments
|
|
78
|
+
|
|
79
|
+
Configuration can be done using command-line arguments or a JSON configuration file (see the next section).
|
|
80
|
+
|
|
81
|
+
#### `instrument`
|
|
82
|
+
You can pass the following arguments to `instrument` to specify its behavior. These arguments will override the values set in the configuration file, if any.
|
|
83
|
+
|
|
84
|
+
| Argument | Shorthand | Description | Default |
|
|
85
|
+
|--------------------------------| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |---------|
|
|
86
|
+
| `--function` | `-f` | The ARN of the Lambda function to be **instrumented**, or the name of the Lambda function (`--region` must be defined). | |
|
|
87
|
+
| `--functions-regex` | | A regex pattern to match with the Lambda function name. | |
|
|
88
|
+
| `--interactive` | `-i` | Allows the user to interactively choose how their function gets instrumented. There is no need to provide any other flags if you choose to use interactive mode since you will be prompted for the information instead. | |
|
|
89
|
+
| `--region` | `-r` | Default region to use, when `--function` is specified by the function name instead of the ARN. | |
|
|
90
|
+
| `--service` | | Use `--service` to group related functions belonging to similar workloads. Learn more about the `service` tag [here][8]. | |
|
|
91
|
+
| `--version` | | Add the `--version` tag to correlate spikes in latency, load or errors to new versions. Learn more about the `version` tag [here][7]. | |
|
|
92
|
+
| `--env` | | Use `--env` to separate out your staging, development, and production environments. Learn more about the `env` tag [here][6]. | |
|
|
93
|
+
| `--extra-tags` | | Add custom tags to your Lambda function in Datadog. Must be a list of `<key>:<value>` separated by commas such as: `layer:api,team:intake`. | |
|
|
94
|
+
| `--profile` | | Specify the AWS named profile credentials to use to instrument. Learn more about AWS named profiles [here][11]. | |
|
|
95
|
+
| `--layer-version` | `-v` | Version of the Datadog Lambda Library layer to apply. This varies between runtimes. To see the latest layer version check the [JS][2] or [python][3] datadog-lambda-layer repo release notes. | |
|
|
96
|
+
| `--extension-version` | `-e` | Version of the Datadog Lambda Extension layer to apply. When `extension-version` is set, make sure to export `DATADOG_API_KEY` (or if encrypted, `DATADOG_KMS_API_KEY` or `DATADOG_API_KEY_SECRET_ARN`) in your environment as well. While using `extension-version`, leave out `forwarder`. Learn more about the Lambda Extension [here][4]. | |
|
|
97
|
+
| `--tracing` | | Whether to enable dd-trace tracing on your Lambda. | `true` |
|
|
98
|
+
| `--merge-xray-traces` | | Whether to join dd-trace traces to AWS X-Ray traces. Useful for tracing API Gateway spans. | `false` |
|
|
99
|
+
| `--flush-metrics-to-logs` | | Whether to send metrics via the Datadog Forwarder [asynchronously][10]. If you disable this parameter, it's required to export `DATADOG_API_KEY` (or if encrypted, `DATADOG_KMS_API_KEY` or `DATADOG_API_KEY_SECRET_ARN`). | `true` |
|
|
100
|
+
| `--capture-lambda-payload` | | Whether to capture and store the payload and response of a lambda invocation. | `false` |
|
|
101
|
+
| `--forwarder` | | The ARN of the [datadog forwarder][9] to attach this function's LogGroup to. | |
|
|
102
|
+
| `--dry-run` | `-d` | Preview changes running command would apply. | `false` |
|
|
103
|
+
| `--logging` | | Whether to collect logs using the Lambda Extension. | `true` |
|
|
104
|
+
| `--log-level` | | Set to `debug` to see additional output from the Datadog Lambda Library and/or Lambda Extension for troubleshooting purposes. | |
|
|
105
|
+
| `--source-code-integration` | `-s` | Whether to enable [Datadog Source Code Integration][12]. This will tag your lambda(s) with the Git repository URL and the latest commit hash of the current local directory. **Note**: Git repository must not be ahead of remote, and must not be dirty. | `true` |
|
|
106
|
+
| `--no-source-code-integration` | | Disables Datadog Source Code Integration. | |
|
|
107
|
+
| `--upload-git-metadata` | `-u` | Whether to enable Git metadata uploading, as a part of source code integration. Git metadata uploading is only required if you don't have the Datadog Github Integration installed. | `true` |
|
|
108
|
+
| `--no-upload-git-metadata` | | Disables Git metadata uploading, as a part of source code integration. Use this flag if you have the Datadog Github Integration installed, as it renders Git metadata uploading unnecessary. | |
|
|
109
|
+
| `--apm-flush-deadline` | | Used to determine when to submit spans before a timeout occurs, in milliseconds. When the remaining time in an AWS Lambda invocation is less than the value set, the tracer attempts to submit the current active spans and all finished spans. Supported for NodeJS and Python. Defaults to `100` milliseconds. | |
|
|
110
|
+
| `--llmobs` | | If specified, enables LLM Observability for the instrumented function(s) with the provided ML application name. | `false` |
|
|
111
|
+
| `--lambda-fips` | | Enable FIPS support in the Lambda functions deployed using this tool. Note that for full FIPS compliance, a FIPS endpoint such as `ddog-gov.com` is required. | |
|
|
112
|
+
<br />
|
|
113
|
+
|
|
114
|
+
#### `uninstrument`
|
|
115
|
+
The following arguments are passed to `uninstrument` to specify its behavior. These arguments will override the values set in the configuration file, if any.
|
|
116
|
+
|
|
117
|
+
Any other argument stated on the `instrument` table, but not below, will be ignored, this to allow you to uninstrument quicker, if needed.
|
|
118
|
+
|
|
119
|
+
| Argument | Shorthand | Description | Default |
|
|
120
|
+
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
121
|
+
| `--function` | `-f` | The ARN of the Lambda function to be **uninstrumented**, or the name of the Lambda function (`--region` must be defined). | |
|
|
122
|
+
| `--functions-regex` | | A regex pattern to match with the Lambda function name to be **uninstrumented**. | |
|
|
123
|
+
| `--region` | `-r` | Default region to use, when `--function` is specified by the function name instead of the ARN. | |
|
|
124
|
+
| `--profile` | | Specify the AWS named profile credentials to use to uninstrument. Learn more about AWS named profiles [here][11]. | |
|
|
125
|
+
| `--forwarder` | | The ARN of the [datadog forwarder][9] to remove from this function. | |
|
|
126
|
+
| `--dry-run` | `-d` | Preview changes running command would apply. | `false` |
|
|
127
|
+
|
|
128
|
+
<br/>
|
|
129
|
+
|
|
130
|
+
### Configuration file
|
|
131
|
+
|
|
132
|
+
Instead of supplying arguments, you can create a configuration file in your project and simply run the `datadog-ci lambda {instrument|uninstrument} --config datadog-ci.json` command on each deployment. Specify the `datadog-ci.json` using the `--config` argument, and use this configuration file structure:
|
|
133
|
+
|
|
134
|
+
```json
|
|
135
|
+
{
|
|
136
|
+
"lambda": {
|
|
137
|
+
"layerVersion": 10,
|
|
138
|
+
"extensionVersion": 8,
|
|
139
|
+
"functions": ["arn:aws:lambda:us-east-1:000000000000:function:autoinstrument"],
|
|
140
|
+
"region": "us-east-1",
|
|
141
|
+
"tracing": true,
|
|
142
|
+
"mergeXrayTraces": true,
|
|
143
|
+
"captureLambdaPayload": true,
|
|
144
|
+
"forwarder": "arn:aws:lambda:us-east-1:000000000000:function:datadog-forwarder",
|
|
145
|
+
"logLevel": "debug",
|
|
146
|
+
"service": "some-service",
|
|
147
|
+
"version": "b17s47h3w1n",
|
|
148
|
+
"profile": "my-credentials",
|
|
149
|
+
"environment": "staging",
|
|
150
|
+
"extraTags": "layer:api,team:intake"
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## Troubleshooting Lambda Instrumentation
|
|
156
|
+
|
|
157
|
+
To troubleshoot issues you encounter with Datadog monitoring on your Lambda functions, run the `datadog-ci lambda flare` command in the root of your project directory. This command collects important data about the Lambda function, such as environment variables and the config file. These files will be submitted to Datadog support via a ticket matching the provided Zendesk case ID.
|
|
158
|
+
|
|
159
|
+
**Note**: This command works whether or not your Lambda functions were instrumented using `datadog-ci lambda instrument`.
|
|
160
|
+
|
|
161
|
+
**Examples**
|
|
162
|
+
```bash
|
|
163
|
+
# Collect and send files to Datadog support for a single function
|
|
164
|
+
datadog-ci lambda flare -f <function-arn> -c <case-id> -e <email-on-case-id>
|
|
165
|
+
|
|
166
|
+
# Include recent CloudWatch logs
|
|
167
|
+
datadog-ci lambda flare -f <function-name> -r <AWS region> -c <case-id> -e <email-on-case-id> --with-logs
|
|
168
|
+
|
|
169
|
+
# Dry run: collect data, but don't send to Datadog support
|
|
170
|
+
datadog-ci lambda flare -f <function-arn> -c <case-id> -e <email-on-case-id> --with-logs --dry-run
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
**Arguments**
|
|
174
|
+
|
|
175
|
+
| Argument | Shorthand | Description | Default |
|
|
176
|
+
| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
177
|
+
| `--function` | `-f` | The ARN of the Lambda function to gather data for, or the name of the Lambda function (`--region` must be defined). | |
|
|
178
|
+
| `--region` | `-r` | Default region to use, when `--function` is specified by the function name instead of the ARN. | |
|
|
179
|
+
| `--case-id` | `-c` | The Datadog case ID to send the files to. | |
|
|
180
|
+
| `--email` | `-e` | The email associated with the specified case ID. | |
|
|
181
|
+
| `--with-logs` | | Collect recent CloudWatch logs for the specified function. | `false` |
|
|
182
|
+
| `--start` and `--end` | | Only gather logs within the time range (`--with-logs` must be included.) Both arguments are numbers in milliseconds since Unix Epoch. | |
|
|
183
|
+
| `--dry-run` | `-d` | Preview collected data which would be sent to Datadog support. | `false` |
|
|
184
|
+
|
|
185
|
+
**Permissions**
|
|
186
|
+
|
|
187
|
+
To run this command, you must have the following IAM permissions:
|
|
188
|
+
- `lambda:GetFunction`
|
|
189
|
+
- `lambda:ListTags`
|
|
190
|
+
- `logs:DescribeLogStreams` (required if `--with-logs` is set)
|
|
191
|
+
- `logs:GetLogEvents` (required if `--with-logs` is set)
|
|
192
|
+
|
|
193
|
+
## Community
|
|
194
|
+
|
|
195
|
+
For product feedback and questions, join the `#serverless` channel in the [Datadog community on Slack](https://chat.datadoghq.com/).
|
|
196
|
+
|
|
197
|
+
[1]: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html
|
|
198
|
+
[2]: https://github.com/DataDog/datadog-lambda-layer-js/releases
|
|
199
|
+
[3]: https://github.com/DataDog/datadog-lambda-layer-python/releases
|
|
200
|
+
[4]: https://docs.datadoghq.com/serverless/datadog_lambda_library/extension
|
|
201
|
+
[5]: https://docs.datadoghq.com/account_management/api-app-keys/#api-keys
|
|
202
|
+
[6]: https://docs.datadoghq.com/serverless/troubleshooting/serverless_tagging/#the-env-tag
|
|
203
|
+
[7]: https://docs.datadoghq.com/serverless/troubleshooting/serverless_tagging/#the-version-tag
|
|
204
|
+
[8]: https://docs.datadoghq.com/serverless/troubleshooting/serverless_tagging/#the-service-tag
|
|
205
|
+
[9]: https://docs.datadoghq.com/serverless/forwarder/
|
|
206
|
+
[10]: https://docs.datadoghq.com/serverless/custom_metrics?tab=python#enabling-asynchronous-custom-metrics
|
|
207
|
+
[11]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html#using-profiles
|
|
208
|
+
[12]: https://docs.datadoghq.com/integrations/guide/source-code-integration
|
|
209
|
+
|
|
210
|
+
<!--
|
|
211
|
+
This page is single-sourced:
|
|
212
|
+
https://github.com/DataDog/documentation/blob/7007931530baf7da59310e7224a26dc9a71c53c5/local/bin/py/build/configurations/pull_config_preview.yaml#L301
|
|
213
|
+
-->
|
package/package.json
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@datadog/datadog-ci-plugin-lambda",
|
|
3
|
+
"version": "3.21.0",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"homepage": "https://github.com/DataDog/datadog-ci/tree/master/packages/plugin-lambda",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "https://github.com/DataDog/datadog-ci.git",
|
|
9
|
+
"directory": "packages/plugin-lambda"
|
|
10
|
+
},
|
|
11
|
+
"exports": {
|
|
12
|
+
"./package.json": "./package.json",
|
|
13
|
+
"./commands/*": {
|
|
14
|
+
"development": "./src/commands/*.ts",
|
|
15
|
+
"default": "./dist/commands/*.js"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist/**/*",
|
|
20
|
+
"README",
|
|
21
|
+
"LICENSE"
|
|
22
|
+
],
|
|
23
|
+
"publishConfig": {
|
|
24
|
+
"access": "public"
|
|
25
|
+
},
|
|
26
|
+
"scripts": {
|
|
27
|
+
"build": "yarn package:clean; yarn package:build",
|
|
28
|
+
"lint": "yarn package:lint",
|
|
29
|
+
"prepack": "yarn package:clean-dist"
|
|
30
|
+
},
|
|
31
|
+
"peerDependencies": {
|
|
32
|
+
"@datadog/datadog-ci": "3.21.0"
|
|
33
|
+
},
|
|
34
|
+
"dependencies": {
|
|
35
|
+
"@aws-sdk/client-cloudwatch-logs": "^3.709.0",
|
|
36
|
+
"@aws-sdk/client-lambda": "^3.709.0",
|
|
37
|
+
"@aws-sdk/credential-provider-ini": "^3.709.0",
|
|
38
|
+
"@aws-sdk/credential-providers": "^3.709.0",
|
|
39
|
+
"@aws-sdk/types": "^3.887.0",
|
|
40
|
+
"@datadog/datadog-ci-base": "3.21.0",
|
|
41
|
+
"@smithy/property-provider": "^2.0.12",
|
|
42
|
+
"@smithy/util-retry": "^2.0.4",
|
|
43
|
+
"chalk": "3.0.0",
|
|
44
|
+
"fuzzy": "^0.1.3",
|
|
45
|
+
"inquirer": "^8.2.5",
|
|
46
|
+
"inquirer-checkbox-plus-prompt": "^1.4.2",
|
|
47
|
+
"ora": "5.4.1",
|
|
48
|
+
"typanion": "^3.14.0",
|
|
49
|
+
"upath": "^2.0.1"
|
|
50
|
+
},
|
|
51
|
+
"devDependencies": {
|
|
52
|
+
"aws-sdk-client-mock": "^4.1.0",
|
|
53
|
+
"aws-sdk-client-mock-jest": "^4.1.0",
|
|
54
|
+
"clipanion": "^3.2.1"
|
|
55
|
+
}
|
|
56
|
+
}
|