Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sd containerized lambda v3 #17050

Merged
merged 26 commits into from Apr 30, 2024
Merged

Sd containerized lambda v3 #17050

merged 26 commits into from Apr 30, 2024

Conversation

homelessbirds
Copy link
Contributor

Please follow conventional commit standards
in your commit messages and pull request title.

Give us some context

  • What problems does this PR solve?
  • Add any context that will help us review your changes such as testing notes,
    links to related docs, screenshots, etc.
  • If your issue relates to an existing GitHub issue, please link to it.

@homelessbirds homelessbirds added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Apr 23, 2024
@homelessbirds homelessbirds self-assigned this Apr 23, 2024
@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues Apr 23, 2024
Copy link

Hi @homelessbirds 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes). If you add any more commits, you can comment netlify build on this PR to update the preview.

Copy link

netlify bot commented Apr 23, 2024

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 0cd8ff8
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/6631665c6e2de50008f53943
😎 Deploy Preview https://deploy-preview-17050--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rhetoric101 rhetoric101 moved this from Hero to triage to In progress in Docs PRs and Issues Apr 23, 2024
1. Create a new Lambda function using the image you pushed to AWS ECR. For more information on how to create this function, we recommend reviewing the AWS guide: [Working with container images](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html).
2. Configure the Lambda function with the same settings as your original function, but ensure you add any required environment variables for New Relic integration.
3. Update your function's handler to point to the newly attached layer in `cmd` override for your function. You can do that using the instructions in these two docs:
* [Instrument your own Lambda functions](/docs/serverless-function-monitoring/aws-lambda-monitoring/enable-lambda-monitoring/instrument-your-own/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specifically, the Lambda console UI configuration section details the handler wrapper details they will need to know.
https://docs.newrelic.com/docs/serverless-function-monitoring/aws-lambda-monitoring/enable-lambda-monitoring/instrument-your-own/#console

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I fixed this

Copy link
Contributor

@keegoid-nr keegoid-nr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some inline comments

jeff-colucci
jeff-colucci previously approved these changes Apr 25, 2024
Copy link
Contributor

@jeff-colucci jeff-colucci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just a couple of small things. I think once you fix them you'll be good roll!

freshnessValidatedDate: never
---

If you're using a containerized image for Lambda and want to monitor your application, you'll need to add New Relic to your code. After you add our pre-built layer to your image, push the image to your AWS Elastic Container Registry. From there, whenever you run your function, New Relic will run, at the same time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you're using a containerized image for Lambda and want to monitor your application, you'll need to add New Relic to your code. After you add our pre-built layer to your image, push the image to your AWS Elastic Container Registry. From there, whenever you run your function, New Relic will run, at the same time.
If you're using a containerized image for Lambda and want to monitor your application, you'll need to add New Relic to your code. After you add our pre-built layer to your image, push the image to your AWS Elastic Container Registry. From there, whenever you run your function, New Relic will run at the same time.

path: /docs/serverless-function-monitoring/aws-lambda-monitoring/enable-lambda-monitoring/account-linking
- title: 'Step 2: Set up AWS API Polling or Metric Streams'
- title: 'Set up AWS API Polling or Metric Streams'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd update the titles themselves in the doc to remove the "Step X" in all the docs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

homelessbirds and others added 2 commits April 30, 2024 14:18
…itoring/enable-lambda-monitoring/containerized-images.mdx

Co-authored-by: alexa <81787716+akristen@users.noreply.github.com>
…itoring/enable-lambda-monitoring/containerized-images.mdx

Co-authored-by: alexa <81787716+akristen@users.noreply.github.com>
akristen
akristen previously approved these changes Apr 30, 2024
Copy link
Contributor

@akristen akristen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, no typos and doc makes sense / has good flow. some fast follows:

  • Def update the tab component ids to be specific to the content rather than just the default numerals. There's some buggy behavior that can happen if we. keep the ids as the default values
  • I'd update the titles of the docs to match what appears in the nav. for eample, when you click "Link accounts", the doc still says "Step 1"

My more general thoughts are mostly about thinking through how to make this less abstract. Some of the steps can be a little confusing if this is your first time doing this kind of task, especially since the users have to reference different docs sites.

I'm not sure what the solution is, but there are a few places where having an example throughline might help. For example:

  • In step "Create image", do customers name this new image? In step 1 of configure lambda function -- "the image you pushed to AWS ECR", using an example name for a docker image might be helpful so customers can be confident that it's the new image and not the other ones that they had to use
  • In "Configure your Lambda function", you mention an "original function", but I'm not sure it's clear what you're referrring to. Are we configuring the original Lambda function, making a copy of the function and customizing the copy?
  • The configure your Lambda function seems like it needs some unspooling and a bit more hand holding. I have a lot more questions than I have answers, and I worry that we might miss some users who aren't Lambda experts or New Relic experts. The step seems to really address more advanced users, but I think it's helpful to unspool and add etail where possible

@homelessbirds homelessbirds merged commit d04c3d6 into develop Apr 30, 2024
17 checks passed
@homelessbirds homelessbirds deleted the sd-containerized-lambda-v3 branch April 30, 2024 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants