Skip to content

Commit 6d5b175

Browse files
authored
docs: consistent naming (#226)
1 parent fbf9f7a commit 6d5b175

File tree

5 files changed

+48
-49
lines changed

5 files changed

+48
-49
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
[![Build Status](https://apm-ci.elastic.co/buildStatus/icon?job=library%2Fapm-aws-lambda-mbp%2Fmain)](https://apm-ci.elastic.co/job/library/job/apm-aws-lambda-mbp/job/main/)
44

5-
This repository contains code and tools for working with Elastic APM's AWS Lambda solution.
5+
This repository contains code and tools for working with the Elastic APM AWS Lambda extension.
66

7-
If you're looking to get started with Elastic's AWS Lambda extension and agent instrumentation, the [AWS Lambda Extension](https://www.elastic.co/guide/en/apm/guide/current/monitoring-aws-lambda.html) documentation is the place to start.
7+
Ready to use Elastic APM to monitor your Lambda functions? See [Monitoring AWS Lambda Functions](https://www.elastic.co/guide/en/apm/guide/current/monitoring-aws-lambda.html) to get started.
88

99
### Update the docs
1010

apm-lambda-extension/DEVELOPMENT.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
### :robot: Automatically
55

6-
Releasing a version of the Lambda Extension requires a tag release.
6+
Releasing a version of the Elastic APM AWS Lambda extension requires a tag release.
77

88
Tag the release via your preferred tagging method. Tagging a release (v0.0.2) via the command line looks something like this.
99

@@ -22,7 +22,7 @@ and a Release in the Github UI.
2222

2323
### :thumbsdown: Manually
2424

25-
Releasing a version of the Lambda Extension is currently a three step manual process.
25+
Releasing a version of the Elastic APM AWS Lambda extension is currently a three step manual process.
2626

2727
1. Tag the Release
2828
2. Create the Build Artifacts
@@ -33,7 +33,7 @@ Releasing a version of the Lambda Extension is currently a three step manual pro
3333
See the above section regarding tagging a release.
3434
### Create the Build Artifacts
3535

36-
Next, create the build artifacts for the release. These are go binaries of the Lambda Extension, built for both Intel and ARM architectures.
36+
Next, create the build artifacts for the release. These are go binaries of the Elastic APM AWS Lambda extension, built for both Intel and ARM architectures.
3737

3838
If you were creating the build artifacts for the v0.0.2 release, that might look something like this
3939

apm-lambda-extension/e2e-testing/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# End-to-End Testing
22

3-
The file `e2e_test.go` contains an end-to-end test of the Elastic APM Lambda Extension. This test is built on top of the AWS SAM CLI, which allows running Lambda functions and their associated layers locally.
3+
The file `e2e_test.go` contains an end-to-end test of the Elastic APM AWS Lambda extension. This test is built on top of the AWS SAM CLI, which allows running Lambda functions and their associated layers locally.
44

55
## Setup
66

77
Since this test is sensibly longer than the other unit tests, it is disabled by default. To enable it, go to `.e2e_test_config` and set the environment variable `RUN_E2E_TESTS` to `true`.
8-
In order to run the Lambda functions locally, the following dependencies must be installed :
8+
In order to run the Lambda functions locally, the following dependencies must be installed :
99
- [Install](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) the SAM CLI. Creating an AWS account is actually not required.
1010
- Install Docker
1111
- Install a Go Runtime
@@ -17,7 +17,7 @@ cd apm-lambda-extension/e2e-testing
1717
go test
1818
```
1919

20-
### Command line arguments
20+
### Command line arguments
2121
The command line arguments are presented with their default value.
2222
```shell
2323
-rebuild=false # Rebuilds the Lambda function images
@@ -31,4 +31,3 @@ Example :
3131
```shell
3232
go test -rebuild=false -lang=java -timer=40 -java-agent-ver=1.28.4
3333
```
34-

docs/add-extension/add-extension-layer.asciidoc

+13-13
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ To add a layer to a Lambda function through the AWS Management Console:
55
1. Navigate to your function in the AWS Management Console
66
2. Scroll to the Layers section and click the _Add a layer_ button image:images/config-layer.png[image of layer configuration section in AWS Console]
77
3. Choose the _Specify an ARN_ radio button
8-
4. Copy and paste the following ARN of the APM Lambda Extension layer in the _Specify an ARN_ text input: +
8+
4. Copy and paste the following ARN of the {apm-lambda-ext} layer in the _Specify an ARN_ text input: +
99
+++<span style="font-size:10pt"><b>EXTENSION_ARN</b></span>+++
1010
image:images/choose-a-layer.png[image of choosing a layer in AWS Console]
1111
5. Click the _Add_ button
@@ -19,10 +19,10 @@ To add the layers to your Lambda function through the AWS Management Console:
1919
1. Navigate to your function in the AWS Management Console
2020
2. Scroll to the Layers section and click the _Add a layer_ button image:images/config-layer.png[image of layer configuration section in AWS Console]
2121
3. Choose the _Specify an ARN_ radio button
22-
4. Copy and paste the following ARNs of the APM Lambda Extension layer and the APM agent layer in the _Specify an ARN_ text input: +
22+
4. Copy and paste the following ARNs of the {apm-lambda-ext} layer and the APM agent layer in the _Specify an ARN_ text input: +
2323
APM Extension layer: +
2424
+++<span style="font-size:10pt"><b>EXTENSION_ARN</b></span>+++ +
25-
APM Agent layer: +
25+
APM agent layer: +
2626
+++<span style="font-size:10pt"><b>AGENT_ARN</b></span>+++
2727
image:images/choose-a-layer.png[image of choosing a layer in AWS Console]
2828
5. Click the _Add_ button
@@ -31,7 +31,7 @@ image:images/choose-a-layer.png[image of choosing a layer in AWS Console]
3131

3232
// tag::cli-extension-only[]
3333

34-
To add the APM Extension Layer ARN through the AWS command line interface execute the following command:
34+
To add the {apm-lambda-ext} Layer ARN through the AWS command line interface execute the following command:
3535

3636
[source,bash]
3737
----
@@ -43,7 +43,7 @@ aws lambda update-function-configuration --function-name yourLambdaFunctionName
4343

4444
// tag::cli-with-agent[]
4545

46-
To add the Layer ARNs of the APM Extension and the APM Agent through the AWS command line interface execute the following command:
46+
To add the Layer ARNs of the {apm-lambda-ext} and the APM agent through the AWS command line interface execute the following command:
4747

4848
[source,bash]
4949
----
@@ -56,7 +56,7 @@ AGENT_ARN
5656

5757
// tag::sam-extension-only[]
5858

59-
In your SAM `template.yml` file add the APM Extension Layer ARN as follows:
59+
In your SAM `template.yml` file add the {apm-lambda-ext} Layer ARN as follows:
6060

6161
[source,yml]
6262
----
@@ -75,7 +75,7 @@ Resources:
7575

7676
// tag::sam-with-agent[]
7777

78-
In your SAM `template.yml` file add the Layer ARNs of the APM Extension and the APM Agent as follows:
78+
In your SAM `template.yml` file add the Layer ARNs of the {apm-lambda-ext} and the APM agent as follows:
7979

8080
[source,yml]
8181
----
@@ -95,7 +95,7 @@ Resources:
9595

9696
// tag::serverless-extension-only[]
9797

98-
In your `serverless.yml` file add the APM Extension Layer ARN to your function as follows:
98+
In your `serverless.yml` file add the {apm-lambda-ext} Layer ARN to your function as follows:
9999

100100
[source,yml]
101101
----
@@ -112,7 +112,7 @@ functions:
112112

113113
// tag::serverless-with-agent[]
114114

115-
In your `serverless.yml` file add the Layer ARNs of the APM Extension and the APM Agent to your function as follows:
115+
In your `serverless.yml` file add the Layer ARNs of the {apm-lambda-ext} and the APM agent to your function as follows:
116116

117117
[source,yml]
118118
----
@@ -129,7 +129,7 @@ functions:
129129
// end::serverless-with-agent[]
130130

131131
// tag::terraform-extension-only[]
132-
To add the APM Extension Layer to your function add the ARN to the `layers` property in your Terraform file:
132+
To add the {apm-lambda-ext} Layer to your function add the ARN to the `layers` property in your Terraform file:
133133

134134
[source,terraform]
135135
----
@@ -144,7 +144,7 @@ resource "aws_lambda_function" "your_lambda_function" {
144144
// end::terraform-extension-only[]
145145

146146
// tag::terraform-with-agent[]
147-
To add the APM Extension and the APM Agent to your function add the ARNs to the `layers` property in your Terraform file:
147+
To add the{apm-lambda-ext} and the APM agent to your function add the ARNs to the `layers` property in your Terraform file:
148148

149149
[source,terraform]
150150
----
@@ -159,7 +159,7 @@ resource "aws_lambda_function" "your_lambda_function" {
159159
// end::terraform-with-agent[]
160160

161161
// tag::container-extension-only[]
162-
To add the APM Extension to your container-based function extend the Dockerfile of your function image as follows:
162+
To add the {apm-lambda-ext} to your container-based function extend the Dockerfile of your function image as follows:
163163

164164
[source,Dockerfile]
165165
----
@@ -174,7 +174,7 @@ COPY --from=lambda-extension /opt/elastic-apm-extension /opt/extensions/elastic-
174174
// end::container-extension-only[]
175175

176176
// tag::container-with-agent[]
177-
To add the APM Extension and the APM Agent to your container-based function extend the Dockerfile of your function image as follows:
177+
To add the {apm-lambda-ext} and the APM agent to your container-based function extend the Dockerfile of your function image as follows:
178178

179179
[source,Dockerfile]
180180
----

0 commit comments

Comments
 (0)