Skip to content

Commit 0a67396

Browse files
authored
docs: update lambda config (#365)
1 parent 25f4aa6 commit 0a67396

File tree

1 file changed

+42
-18
lines changed

1 file changed

+42
-18
lines changed

docs/monitoring-aws-lambda.asciidoc

+42-18
Original file line numberDiff line numberDiff line change
@@ -92,39 +92,23 @@ Instead of specifying the <<aws-lambda-config-authentication-keys>> as plain tex
9292
=== `ELASTIC_APM_SERVICE_NAME`
9393
The configured name of your application or service. The APM agent will use this value when reporting data to the APM Server. If unset, the APM agent will automatically set the value based on the Lambda function name. Use this config option if you want to group multiple Lambda functions under a single service entity in APM.
9494

95-
[float]
96-
[[aws-lambda-config-data-receiver-timeout-seconds]]
97-
=== `ELASTIC_APM_DATA_RECEIVER_TIMEOUT_SECONDS`
98-
99-
deprecated::[1.2.0,Replaced by `ELASTIC_APM_DATA_RECEIVER_TIMEOUT`. See <<aws-lambda-config-data-receiver-timeout>>]
100-
101-
The {apm-lambda-ext}'s timeout value, in seconds, for receiving data from the APM agent. The _default_ is `15`.
102-
10395
[float]
10496
[[aws-lambda-config-data-receiver-timeout]]
10597
=== `ELASTIC_APM_DATA_RECEIVER_TIMEOUT`
10698

107-
coming::[1.2.0,Replaces `ELASTIC_APM_DATA_RECEIVER_TIMEOUT_SECONDS`. See <<aws-lambda-config-data-receiver-timeout-seconds>>]
99+
[small]#Added in: v1.2.0. Replaces `ELASTIC_APM_DATA_RECEIVER_TIMEOUT_SECONDS`.#
108100

109101
The {apm-lambda-ext}'s timeout value, for receiving data from the APM agent. The _default_ is `15s`.
110102

111103
[float]
112104
=== `ELASTIC_APM_DATA_RECEIVER_SERVER_PORT`
113105
The port on which the {apm-lambda-ext} listens to receive data from the APM agent. The _default_ is `8200`.
114106

115-
[float]
116-
[[aws-lambda-config-data-forwarder-timeout-seconds]]
117-
=== `ELASTIC_APM_DATA_FORWARDER_TIMEOUT_SECONDS`
118-
119-
deprecated::[1.2.0,Replaced by `ELASTIC_APM_DATA_FORWARDER_TIMEOUT`. See <<aws-lambda-config-data-forwarder-timeout>>]
120-
121-
The timeout value, in seconds, for the {apm-lambda-ext}'s HTTP client sending data to the APM Server. The _default_ is `3`. If the extension's attempt to send APM data during this time interval is not successful, the extension queues back the data. Further attempts at sending the data are governed by an exponential backoff algorithm: data will be sent after a increasingly large grace period of 0, then circa 1, 4, 9, 16, 25 and 36 seconds, provided that the Lambda function execution is ongoing.
122-
123107
[float]
124108
[[aws-lambda-config-data-forwarder-timeout]]
125109
=== `ELASTIC_APM_DATA_FORWARDER_TIMEOUT`
126110

127-
coming::[1.2.0,Replaces `ELASTIC_APM_DATA_FORWARDER_TIMEOUT_SECONDS`. See <<aws-lambda-config-data-forwarder-timeout-seconds>>]
111+
[small]#Added in: v1.2.0. Replaces `ELASTIC_APM_DATA_FORWARDER_TIMEOUT_SECONDS`.#
128112

129113
The timeout value, for the {apm-lambda-ext}'s HTTP client sending data to the APM Server. The _default_ is `3s`. If the extension's attempt to send APM data during this time interval is not successful, the extension queues back the data. Further attempts at sending the data are governed by an exponential backoff algorithm: data will be sent after a increasingly large grace period of 0, then circa 1, 4, 9, 16, 25 and 36 seconds, provided that the Lambda function execution is ongoing.
130114

@@ -148,6 +132,46 @@ though it ensures that all APM data is sent to the APM server.
148132
=== `ELASTIC_APM_LOG_LEVEL`
149133
The logging level to be used by both the APM Agent and the {apm-lambda-ext}. Supported values are `trace`, `debug`, `info`, `warning`, `error`, `critical` and `off`.
150134

135+
[float]
136+
=== `ELASTIC_APM_LAMBDA_CAPTURE_LOGS`
137+
138+
preview:[]
139+
Starting in Elastic Stack version 8.5.0, the Elastic APM lambda extension supports the collection of log events by default.
140+
Log events can be viewed in {kib} in the APM UI. Disable log collection by setting this to `false`.
141+
142+
[NOTE]
143+
====
144+
You may see errors similar to the following in {stack} versions less than 8.5:
145+
146+
[source,text]
147+
----
148+
client error: response status code: 400
149+
message: log: did not recognize object type
150+
----
151+
152+
Users on older versions should disable log collection by setting `ELASTIC_APM_LAMBDA_CAPTURE_LOGS` to `false`.
153+
====
154+
155+
[float]
156+
[[aws-lambda-config-deprecated]]
157+
=== Deprecated options
158+
159+
[float]
160+
[[aws-lambda-config-data-receiver-timeout-seconds]]
161+
==== `ELASTIC_APM_DATA_RECEIVER_TIMEOUT_SECONDS`
162+
163+
[small]#Deprecated in: v1.2.0. Use <<aws-lambda-config-data-receiver-timeout>> instead.#
164+
165+
The {apm-lambda-ext}'s timeout value, in seconds, for receiving data from the APM agent. The _default_ is `15`.
166+
167+
[float]
168+
[[aws-lambda-config-data-forwarder-timeout-seconds]]
169+
==== `ELASTIC_APM_DATA_FORWARDER_TIMEOUT_SECONDS`
170+
171+
[small]#Deprecated in: v1.2.0. Use <<aws-lambda-config-data-forwarder-timeout>> instead.#
172+
173+
The timeout value, in seconds, for the {apm-lambda-ext}'s HTTP client sending data to the APM Server. The _default_ is `3`. If the extension's attempt to send APM data during this time interval is not successful, the extension queues back the data. Further attempts at sending the data are governed by an exponential backoff algorithm: data will be sent after a increasingly large grace period of 0, then circa 1, 4, 9, 16, 25 and 36 seconds, provided that the Lambda function execution is ongoing.
174+
151175
[[aws-lambda-secrets-manager]]
152176
== Using AWS Secrets Manager to manage APM authentication keys
153177
When using the config options <<aws-lambda-config-authentication-keys>> for authentication of the {apm-lambda-ext}, the corresponding keys are specified in plain text in the environment variables of your Lambda function. If you prefer to securely store the authentication keys, you can use the AWS Secrets Manager and let the extension retrieve the actual keys from the AWS Secrets Manager. Follow the instructions below to set up the AWS Secrets Manager with the extension.

0 commit comments

Comments
 (0)