Improved getting started guide for AWS Lambda

[AlexanderWert]

Depends on:

• Restructured docs for AWS Lambda apm-aws-lambda#158

[AlexanderWert]

Hi @bmorelli25,

this is the Java Agent counter part to elastic/apm-aws-lambda#158.

Corresponding Node.js Agent and Python Agent PRs will follow soon.

This PR contains some dependencies on elastic/apm-aws-lambda#158 - is something needed in addition to make those dependencies / includes / links work properly, once elastic/apm-aws-lambda#158 is merged?

Thanks!

[ghost]

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

• Start Time: 2022-03-31T21:07:07.128+0000

• Duration: 3 min 21 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

• /test : Re-trigger the build.

• run benchmark tests : Run the benchmark tests.

• run jdk compatibility tests : Run the JDK Compatibility tests.

• run integration tests : Run the Agent Integration tests.

• run end-to-end tests : Run the APM-ITs.

• run windows tests : Build & tests on windows.

• run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

[bmorelli25]

Before this will pass docs ci, three things need to happen:

• elastic/apm-aws-lambda needs to be added as a docs dependency (this tells the build where exactly {apm-aws-repo-dir} is) docs: add apm-aws-lambda as a dependency docs#2404
• The included widget content needs to exist in current. I'm going to cherry-pick the relevant parts of Restructured docs for AWS Lambda apm-aws-lambda#158 to 8.1 so we can pass ci [8.1] Cherrypick revamped docs to current apm-aws-lambda#162

  {apm-aws-repo-dir}/add-extension/code.asciidoc
  {apm-aws-repo-dir}/lambda-selector/lambda-attributes-selector.asciidoc
  {apm-aws-repo-dir}/lambda-selector/extension-arn-replacement.asciidoc
  {apm-aws-repo-dir}/add-extension/add-extension-layer-widget.asciidoc
  

• This page needs to exist in the APM Guide in current: {apm-guide-ref}/aws-lambda-config-options.html [8.1] Cherrypick revamped docs to current apm-aws-lambda#162

[bmorelli25]

@elasticmachine, run elasticsearch-ci/docs

[bmorelli25]

@elasticmachine, run elasticsearch-ci/docs

[bmorelli25]

The preview is looking good! Here are some thoughts and comments.

[felixbarny]

The guide assumes that users have an APM Server set up already. We might want to add a step that links to https://www.elastic.co/guide/en/apm/server/current/getting-started-apm-server.html#_hosted_elasticsearch_service so that users that just get started know where to go. We should also add a recommendation that users are recommended to create a cluster on ESS in the same region as their Lambda function.

[AlexanderWert]

@bmorelli25 The build docs are failing now because I added a back link to the Lambda extension {apm-guide-ref}/aws-lambda-arch.html. Will this resolve when elastic/apm-aws-lambda#158 is merged or is something in addition needed (e.g. cherry picking like you did for {apm-guide-ref}/aws-lambda-config-options.html) ?

[bmorelli25]

@bmorelli25 The build docs are failing now because I added a back link to the Lambda extension {apm-guide-ref}/aws-lambda-arch.html. Will this resolve when elastic/apm-aws-lambda#158 is merged or is something in addition needed (e.g. cherry picking like you did for {apm-guide-ref}/aws-lambda-config-options.html) ?

That's correct, a cherry-pick to 8.1 is needed. I'll update.

[bmorelli25]

Nice! I like this. FYI I moved the table include into a block element. This allows us to nest it under the accompanying bullet point with a +.

[bmorelli25]

@elasticmachine, run elasticsearch-ci/docs

[eyalkoren]

Looks really good!! 👏

[bmorelli25]

/test