Skip to content

AWS Firehose improve integration documentation#12732

Merged
Kavindu-Dodan merged 8 commits into
elastic:mainfrom
Kavindu-Dodan:chore/improve-firehose-documentation
Feb 14, 2025
Merged

AWS Firehose improve integration documentation#12732
Kavindu-Dodan merged 8 commits into
elastic:mainfrom
Kavindu-Dodan:chore/improve-firehose-documentation

Conversation

@Kavindu-Dodan

@Kavindu-Dodan Kavindu-Dodan commented Feb 11, 2025

Copy link
Copy Markdown
Contributor

Proposed commit message

Improves the documentation of the AWS Firehose integration.

  • Improve clarity on Firehose stream configurations
  • Updates screenshots

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Related issues

@Kavindu-Dodan

Copy link
Copy Markdown
Contributor Author

Will conflict with #12687

@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Feb 11, 2025

Copy link
Copy Markdown

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@Kavindu-Dodan Kavindu-Dodan force-pushed the chore/improve-firehose-documentation branch from 16d05c5 to 6708b87 Compare February 11, 2025 21:31
@Kavindu-Dodan Kavindu-Dodan marked this pull request as ready for review February 11, 2025 21:31
@Kavindu-Dodan Kavindu-Dodan requested a review from a team as a code owner February 11, 2025 21:31
@Kavindu-Dodan Kavindu-Dodan force-pushed the chore/improve-firehose-documentation branch 3 times, most recently from b5761b3 to 6ea7bfa Compare February 11, 2025 22:13
@Kavindu-Dodan Kavindu-Dodan requested a review from zmoog February 11, 2025 22:45
Comment thread packages/awsfirehose/_dev/build/docs/README.md Outdated
Comment thread packages/awsfirehose/_dev/build/docs/README.md Outdated
Comment thread packages/awsfirehose/_dev/build/docs/README.md Outdated
Comment thread packages/awsfirehose/_dev/build/docs/README.md Outdated
Comment thread packages/awsfirehose/_dev/build/docs/README.md Outdated
Comment thread packages/awsfirehose/_dev/build/docs/README.md Outdated
Comment thread packages/awsfirehose/docs/README.md Outdated
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>

# Conflicts:
#	packages/awsfirehose/changelog.yml
#	packages/awsfirehose/manifest.yml
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
@Kavindu-Dodan Kavindu-Dodan force-pushed the chore/improve-firehose-documentation branch from 6885354 to 6175506 Compare February 12, 2025 15:35

@zmoog zmoog left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Solid update. LGTM.

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
Comment thread packages/awsfirehose/_dev/build/docs/README.md Outdated
Comment thread packages/awsfirehose/docs/README.md Outdated
Kavindu-Dodan and others added 2 commits February 13, 2025 21:55
Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>
Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>
@gizas

gizas commented Feb 14, 2025

Copy link
Copy Markdown
Contributor

Nicely done!!!!

WAF | Firehose, CloudWatch. S3 |

Nit: There is a comma missing (can not make a comment as this part not updated)

Idea: So mainly we send Cloudwatch or S3 logs to Firehose.
The Cloudwatch needs subscription filters, shall we write this and put a link https://docs.aws.amazon.com/firehose/latest/dev/writing-with-cloudwatch-logs.html? Shall we diffrentiate this from S3

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
@Kavindu-Dodan

Copy link
Copy Markdown
Contributor Author

@gizas Ahh thanks, fixed with commit 9398c30

Idea: So mainly we send Cloudwatch or S3 logs to Firehose.

There're also improvements to Elastic Documentation 1 which provide detailed guides. Besides, there are multiple ways a Firehose stream could get its data. For example, CloudTrail logs can be ingested through Firehose 2. So we can't simply add a single reference here. However, we can do a follow-up PR once documentation changes ready to link Elastic Documentation into the integration.

Footnotes

  1. https://github.com/elastic/observability-docs/pull/4818

  2. https://www.elastic.co/guide/en/observability/current/monitor-aws-cloudtrail-firehose.html

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
@elastic-sonarqube

Copy link
Copy Markdown

@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

@Kavindu-Dodan Kavindu-Dodan merged commit 3df66d3 into elastic:main Feb 14, 2025
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown

Package awsfirehose - 1.5.1 containing this change is available at https://epr.elastic.co/package/awsfirehose/1.5.1/

Kavindu-Dodan added a commit to elastic/docs-content that referenced this pull request Feb 28, 2025
## Description

Improves AWS Firehose documentation, aligning with the update done on
AWS Firehose Integration documentation at
elastic/integrations#12732

This is a follow-up of
elastic/observability-docs#4818 for the new doc
content repository.


### Related issue

Related PR - elastic/observability-docs#4818 
Related : elastic/integrations#12150 
Related : elastic/observability-docs#4784

---------

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
@andrewkroh andrewkroh added the Integration:awsfirehose Amazon Data Firehose label Mar 13, 2025
flexitrev pushed a commit that referenced this pull request Mar 20, 2025
* improve aws firehose integration documentation

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>

# Conflicts:
#	packages/awsfirehose/changelog.yml
#	packages/awsfirehose/manifest.yml

* review changes

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>

* improve documentation

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>

* add recommendation on s3 backups

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>

* Update packages/awsfirehose/_dev/build/docs/README.md

Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>

* Update packages/awsfirehose/docs/README.md

Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>

* minor fix

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>

* update doc with minor fix

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>

---------

Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Integration:awsfirehose Amazon Data Firehose

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants