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

Add a new section on how to collect any log from CloudWatch using Firehose #3887

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

alaudazzi
Copy link
Contributor

@alaudazzi alaudazzi commented May 14, 2024

This PR:

Closes #3882

@alaudazzi alaudazzi added docs Improvements or additions to documentation enhancement New feature or request backport-8.13 Automated backport with mergify backport-8.14 Automated backport with mergify labels May 14, 2024
@alaudazzi alaudazzi self-assigned this May 14, 2024
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@alaudazzi alaudazzi requested a review from zmoog May 14, 2024 06:51
Copy link
Contributor

mergify bot commented May 28, 2024

This pull request is now in conflict. Could you fix it @alaudazzi? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b cloudwatch-firehose upstream/cloudwatch-firehose
git merge upstream/main
git push upstream cloudwatch-firehose

@zmoog zmoog marked this pull request as ready for review May 28, 2024 16:19
@zmoog zmoog requested a review from a team as a code owner May 28, 2024 16:19
@zmoog zmoog requested a review from dedemorton May 28, 2024 16:19
Copy link
Contributor

@zmoog zmoog left a comment

Choose a reason for hiding this comment

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

I expanded steps 2-5 with the new content I added to the public note we used as a raw material source for this topic.

I think it is ready for a review round! 😇

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

Added some editorial contents. Some of the comments relate to restructuring. If you need help, you can reach out in the obs-docs channel in slack. Hope this is helpful!


In this tutorial, we will write a simple AWS Lambda-based app, collect its application logs, and forward them to Elastic.

Like many other services and platforms in AWS, Lambda functions natively log directly to CloudWatch out of the box. Lambda functions are a great tool for experimenting on AWS.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this sentence is relevant or necessary. I would remove it: "Lambda functions are a great tool for experimenting on AWS."

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I see. My original intent was to explain why we picked up lambda for this tutorial, but I agree it is irrelevant and adds too little value to stay.

@zmoog
Copy link
Contributor

zmoog commented May 28, 2024

@dedemorton, thank you for your helpful review comments and suggestions!

I added all the suggestions and addressed the comments on the structure. Let me know what you think when you have time.

These diagrams help orient users in their journey.
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

A couple more comments for ya!


1. Visit the AWS web console and open the AWS Lambda page.
2. Click **Create function** and select the option to create a function from scratch.
3. Select a **Function name**
Copy link
Member

Choose a reason for hiding this comment

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

For consistency with other steps

Suggested change
3. Select a **Function name**
3. Select a **Function name**.

Comment on lines +118 to +124
Set the **Parameters** in the **Destination settings** section.

[discrete]
[[firehose-cloudwatch-step-three-desination-settings-parameters]]
=== Parameters

Use the following parameters:
Copy link
Member

Choose a reason for hiding this comment

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

It feels like this line should be in the next section?

Suggested change
Set the **Parameters** in the **Destination settings** section.
[discrete]
[[firehose-cloudwatch-step-three-desination-settings-parameters]]
=== Parameters
Use the following parameters:
[discrete]
[[firehose-cloudwatch-step-three-desination-settings-parameters]]
=== Parameters
Set the **Parameters** in the **Destination settings** section.
Use the following parameters:


[discrete]
[[firehose-cloudwatch-step-four-subscription-filter-destination]]
==== Choose destination
Copy link
Member

Choose a reason for hiding this comment

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

These headings don't display correctly but that's a CSS bug. We have a PR open in elastic/docs to fix this.


On the AWS console, visit your Firehose stream and check for entries in the *Destination error logs* section.

If everything is running smoothly, this list will be empty. If there's an error, you can check the details. Here is a delivery stream that fails to send records to the Elastic stack due to bad authentication settings:
Copy link
Member

Choose a reason for hiding this comment

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

This is a good example to include 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.13 Automated backport with mergify backport-8.14 Automated backport with mergify docs Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[AWS monitoring]: Add CloudWatch use case using Amazon Data Firehose
4 participants