Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

[![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/)

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

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.
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.

### Update the docs

Expand Down
6 changes: 3 additions & 3 deletions apm-lambda-extension/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

### :robot: Automatically

Releasing a version of the Lambda Extension requires a tag release.
Releasing a version of the Elastic APM AWS Lambda extension requires a tag release.

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

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

### :thumbsdown: Manually

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

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

Next, create the build artifacts for the release. These are go binaries of the Lambda Extension, built for both Intel and ARM architectures.
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.

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

Expand Down
7 changes: 3 additions & 4 deletions apm-lambda-extension/e2e-testing/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# End-to-End Testing

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.
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.

## Setup

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`.
In order to run the Lambda functions locally, the following dependencies must be installed :
In order to run the Lambda functions locally, the following dependencies must be installed :
- [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.
- Install Docker
- Install a Go Runtime
Expand All @@ -17,7 +17,7 @@ cd apm-lambda-extension/e2e-testing
go test
```

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

26 changes: 13 additions & 13 deletions docs/add-extension/add-extension-layer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ To add a layer to a Lambda function through the AWS Management Console:
1. Navigate to your function in the AWS Management Console
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]
3. Choose the _Specify an ARN_ radio button
4. Copy and paste the following ARN of the APM Lambda Extension layer in the _Specify an ARN_ text input: +
4. Copy and paste the following ARN of the {apm-lambda-ext} layer in the _Specify an ARN_ text input: +
+++<span style="font-size:10pt"><b>EXTENSION_ARN</b></span>+++
image:images/choose-a-layer.png[image of choosing a layer in AWS Console]
5. Click the _Add_ button
Expand All @@ -19,10 +19,10 @@ To add the layers to your Lambda function through the AWS Management Console:
1. Navigate to your function in the AWS Management Console
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]
3. Choose the _Specify an ARN_ radio button
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: +
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: +
APM Extension layer: +
+++<span style="font-size:10pt"><b>EXTENSION_ARN</b></span>+++ +
APM Agent layer: +
APM agent layer: +
+++<span style="font-size:10pt"><b>AGENT_ARN</b></span>+++
image:images/choose-a-layer.png[image of choosing a layer in AWS Console]
5. Click the _Add_ button
Expand All @@ -31,7 +31,7 @@ image:images/choose-a-layer.png[image of choosing a layer in AWS Console]

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

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

[source,bash]
----
Expand All @@ -43,7 +43,7 @@ aws lambda update-function-configuration --function-name yourLambdaFunctionName

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

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

[source,bash]
----
Expand All @@ -56,7 +56,7 @@ AGENT_ARN

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

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

[source,yml]
----
Expand All @@ -75,7 +75,7 @@ Resources:

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

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

[source,yml]
----
Expand All @@ -95,7 +95,7 @@ Resources:

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

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

[source,yml]
----
Expand All @@ -112,7 +112,7 @@ functions:

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

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

[source,yml]
----
Expand All @@ -129,7 +129,7 @@ functions:
// end::serverless-with-agent[]

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

[source,terraform]
----
Expand All @@ -144,7 +144,7 @@ resource "aws_lambda_function" "your_lambda_function" {
// end::terraform-extension-only[]

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

[source,terraform]
----
Expand All @@ -159,7 +159,7 @@ resource "aws_lambda_function" "your_lambda_function" {
// end::terraform-with-agent[]

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

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

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

[source,Dockerfile]
----
Expand Down
Loading