-
Notifications
You must be signed in to change notification settings - Fork 171
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
[AWS Firehose] Clarify where to find ES endpoint #4784
Conversation
Users should use the endpoint with `es` in the URL
A documentation preview will be available soon. Request a new doc build by commenting
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. |
This pull request does not have a backport label. Could you fix it @zmoog? 🙏
|
@alaudazzi, we need to clarify users must use ES endpoint format with the I'm working on the CloudTrail document to find the proper structure before applying it to all other Firehose docs. The goals are:
|
@alaudazzi, I made a few changes to the CloudTrail doc as a pilot for this update. The doc suggests user to find:
Added a simplified "IMPORTANT" note for users to double-check hte URL format. |
Thanks for starting this draft @zmoog -- other than the CloudTrail logs tutorial, which tutorials are impacted by this doc update? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tested the Set up a Firehose delivery stream procedure with the current UI and adjusted the steps.
@zmoog |
You mean the following part is too generic, right? . Set up the delivery stream by specifying the following data:
+
- Elastic endpoint URL
- API key
- Content encoding: gzip
- Retry duration: 60 (default)
- Backup settings: failed data only to s3 bucket
|
It could be helpful to expand more on:
|
LGTM, I'll apply the same changes to the other relevant Firehose guides. |
Apply the same ES endpoint & API key changes to the following Firehose gudies: - Firewall logs - WAF logs - CloudWatch logs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
* Clarify where to find ES endpoint Users should use the endpoint with `es` in the URL * Minor edits * Edits * Edits * Simplify and clarify the IMPORTANT note * Update step 3 * Make the set up delivery stream more explicit * Fix typo * Update ES endpoint URL & API key setup Apply the same ES endpoint & API key changes to the following Firehose gudies: - Firewall logs - WAF logs - CloudWatch logs --------- Co-authored-by: Arianna Laudazzi <arianna.laudazzi@elastic.co> Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> (cherry picked from commit 417b639)
* Clarify where to find ES endpoint Users should use the endpoint with `es` in the URL * Minor edits * Edits * Edits * Simplify and clarify the IMPORTANT note * Update step 3 * Make the set up delivery stream more explicit * Fix typo * Update ES endpoint URL & API key setup Apply the same ES endpoint & API key changes to the following Firehose gudies: - Firewall logs - WAF logs - CloudWatch logs --------- Co-authored-by: Arianna Laudazzi <arianna.laudazzi@elastic.co> Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> (cherry picked from commit 417b639)
When setting up an AWS Firehose data stream, users should use the Elasticsearch endpoint URL that contains the .es subdomain. While the non-.es URLs currently work and will continue to function, the URL containing the .es subdomain is designed as the dedicated endpoint for connecting to Elasticsearch. These URLs are the best option for future-proofing your setup, and we should recommend using them. --------- Co-authored-by: Arianna Laudazzi <arianna.laudazzi@elastic.co> Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> (cherry picked from commit 417b639) Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co>
When setting up an AWS Firehose data stream, users should use the Elasticsearch endpoint URL that contains the .es subdomain. While the non-.es URLs currently work and will continue to function, the URL containing the .es subdomain is designed as the dedicated endpoint for connecting to Elasticsearch. These URLs are the best option for future-proofing your setup, and we should recommend using them. --------- Co-authored-by: Arianna Laudazzi <arianna.laudazzi@elastic.co> Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> (cherry picked from commit 417b639) Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co>
## 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>
Description
When setting up an AWS Firehose data stream, users should use the Elasticsearch endpoint URL that contains the .es subdomain.
While the non-.es URLs currently work and will continue to function, the URL containing the .es subdomain is designed as the dedicated endpoint for connecting to Elasticsearch. These URLs are the best option for future-proofing your setup, and we should recommend using them.
Documentation sets edited in this PR
Check all that apply.
docs/en/observability/*
)docs/en/serverless/*
)docs/en/integrations/*
)Related issue
Closes #
Checklist
Follow-up tasks
Select one.