Skip to content

Commit 4d00e18

Browse files
authored
Add applies_to metadata (#694)
* Add applies_to metadata * Remove products
1 parent 64314fd commit 4d00e18

File tree

5 files changed

+47
-11
lines changed

5 files changed

+47
-11
lines changed

docs/reference/aws-lambda-config-options.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/lambda/current/aws-lambda-config-options.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
48
---
59

610
# Configuration options [aws-lambda-config-options]
@@ -58,7 +62,11 @@ The configured name of your application or service. The APM agent will use this
5862

5963
### `ELASTIC_APM_DATA_RECEIVER_TIMEOUT` [aws-lambda-config-data-receiver-timeout]
6064

61-
Added in: v1.2.0. Replaces `ELASTIC_APM_DATA_RECEIVER_TIMEOUT_SECONDS`.
65+
```{applies_to}
66+
product: ga 1.2.0
67+
```
68+
69+
Replaces `ELASTIC_APM_DATA_RECEIVER_TIMEOUT_SECONDS`.
6270

6371
The {{apm-lambda-ext}}'s timeout value, for receiving data from the APM agent. The *default* is `15s`.
6472

@@ -70,9 +78,13 @@ The port on which the {{apm-lambda-ext}} listens to receive data from the APM ag
7078

7179
### `ELASTIC_APM_DATA_FORWARDER_TIMEOUT` [aws-lambda-config-data-forwarder-timeout]
7280

73-
Added in: v1.2.0. Replaces `ELASTIC_APM_DATA_FORWARDER_TIMEOUT_SECONDS`.
81+
```{applies_to}
82+
product: ga 1.2.0
83+
```
84+
85+
Replaces `ELASTIC_APM_DATA_FORWARDER_TIMEOUT_SECONDS`.
7486

75-
The timeout value, for the {{apm-lambda-ext}}'s HTTP client sending data to the APM Server. The *default* is `3s`. If the extensions 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.
87+
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.
7688

7789

7890
### `ELASTIC_APM_SEND_STRATEGY` [_elastic_apm_send_strategy]
@@ -95,30 +107,38 @@ The logging level to be used by both the APM Agent and the {{apm-lambda-ext}}. S
95107

96108
### `ELASTIC_APM_LAMBDA_VERIFY_SERVER_CERT` [_elastic_apm_lambda_verify_server_cert]
97109

98-
Added in: v1.3.0.
110+
```{applies_to}
111+
product: ga 1.3.0
112+
```
99113

100-
Whether to enable {{apm-lambda-ext}} to verify APM Servers certificate chain and host name.
114+
Whether to enable {{apm-lambda-ext}} to verify APM Server's certificate chain and host name.
101115

102116

103117
### `ELASTIC_APM_LAMBDA_SERVER_CA_CERT_PEM` [_elastic_apm_lambda_server_ca_cert_pem]
104118

105-
Added in: v1.3.0.
119+
```{applies_to}
120+
product: ga 1.3.0
121+
```
106122

107-
The certificate passed as environment variable. To be used to verify APM Servers certificate chain if verify server certificate is enabled.
123+
The certificate passed as environment variable. To be used to verify APM Server's certificate chain if verify server certificate is enabled.
108124

109125

110126
### `ELASTIC_APM_SERVER_CA_CERT_FILE` [_elastic_apm_server_ca_cert_file]
111127

112-
Added in: v1.3.0.
128+
```{applies_to}
129+
product: ga 1.3.0
130+
```
113131

114-
The certificate passed as a file name available to the extension. To be used to verify APM Servers certificate chain if verify server certificate is enabled.
132+
The certificate passed as a file name available to the extension. To be used to verify APM Server's certificate chain if verify server certificate is enabled.
115133

116134

117135
### `ELASTIC_APM_SERVER_CA_CERT_ACM_ID` [_elastic_apm_server_ca_cert_acm_id]
118136

119-
Added in: v1.3.0.
137+
```{applies_to}
138+
product: ga 1.3.0
139+
```
120140

121-
The ARN for Amazon-issued certificate. To be used to verify APM Servers certificate chain if verify server certificate is enabled.
141+
The ARN for Amazon-issued certificate. To be used to verify APM Server's certificate chain if verify server certificate is enabled.
122142

123143
::::{note}
124144
You may see errors similar to the following in {{stack}} versions less than 8.5:

docs/reference/aws-lambda-overhead.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/lambda/current/aws-lambda-overhead.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
48
---
59

610
# Performance impact and overhead [aws-lambda-overhead]

docs/reference/aws-lambda-secrets-manager.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/lambda/current/aws-lambda-secrets-manager.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
48
---
59

610
# Using AWS Secrets Manager to manage APM authentication keys [aws-lambda-secrets-manager]

docs/reference/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/lambda/current/aws-lambda-arch.html
44
- https://www.elastic.co/guide/en/apm/lambda/current/index.html
5+
applies_to:
6+
stack:
7+
serverless:
8+
observability:
59
---
610

711
# APM Architecture for AWS Lambda [aws-lambda-arch]

docs/release-notes/release-notes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
navigation_title: "Elastic APM AWS Lambda Extension"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/apm/lambda/current/aws-lambda-release-notes.html
5+
applies_to:
6+
stack:
7+
serverless:
8+
observability:
59
---
610

711
# {{apm-lambda-ext}} release notes [elastic-apm-aws-lambda-extension-release-notes]

0 commit comments

Comments
 (0)