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

[AWS Firehose] Clarify where to find ES endpoint #4784

Merged
merged 9 commits into from
Jan 28, 2025

Conversation

zmoog
Copy link
Contributor

@zmoog zmoog commented Jan 23, 2025

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.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

Users should use the endpoint with `es` in the URL
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.

Copy link
Contributor

mergify bot commented Jan 23, 2025

This pull request does not have a backport label. Could you fix it @zmoog? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jan 23, 2025
@zmoog zmoog self-assigned this Jan 23, 2025
@zmoog
Copy link
Contributor Author

zmoog commented Jan 23, 2025

@alaudazzi, we need to clarify users must use ES endpoint format with the es in the URL.

I'm working on the CloudTrail document to find the proper structure before applying it to all other Firehose docs.

The goals are:

  • Guide users to pages on EC/deployment that contain the ES endpoint URL with es (there are pages that show the wrong URL format)
  • Highlight they must use the ES endpoint URL with es

@alaudazzi alaudazzi added backport-8.x Automated backport to the 8.x branch with mergify backport-8.17 Automated backport with mergify labels Jan 24, 2025
@mergify mergify bot removed the backport-skip Skip notification from the automated backport with mergify label Jan 24, 2025
@zmoog
Copy link
Contributor Author

zmoog commented Jan 27, 2025

@alaudazzi, I made a few changes to the CloudTrail doc as a pilot for this update.

The doc suggests user to find:

  • ES endpoint at: EC console > Applications > Elasticsearch > Copy endpoint
  • API key at: Kibana > Stack management > API Keys

Added a simplified "IMPORTANT" note for users to double-check hte URL format.

@zmoog
Copy link
Contributor Author

zmoog commented Jan 27, 2025

Here's a low-fi preview from vscode:

CleanShot 2025-01-27 at 09 53 42@2x

@alaudazzi
Copy link
Contributor

Thanks for starting this draft @zmoog -- other than the CloudTrail logs tutorial, which tutorials are impacted by this doc update?

@alaudazzi alaudazzi self-requested a review January 27, 2025 10:14
Copy link
Contributor

@alaudazzi alaudazzi left a 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.

@alaudazzi
Copy link
Contributor

@zmoog
Should we also be more explicit on what to do with the Elasticsearch endpoint URL after we copied it?

@zmoog
Copy link
Contributor Author

zmoog commented Jan 27, 2025

Should we also be more explicit on what to do with the Elasticsearch endpoint URL after we copied it?

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

@alaudazzi
Copy link
Contributor

It could be helpful to expand more on:

  • Elastic endpoint URL
  • API key

@alaudazzi
Copy link
Contributor

alaudazzi commented Jan 27, 2025

@zmoog

Here is a preview with the latest changes:
image

Let me know what you think.
I'll fix the typo "To Create the API key"

@zmoog
Copy link
Contributor Author

zmoog commented Jan 27, 2025

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
Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

LGTM

@zmoog zmoog marked this pull request as ready for review January 28, 2025 11:31
@zmoog zmoog requested a review from a team as a code owner January 28, 2025 11:31
@alaudazzi alaudazzi merged commit 417b639 into main Jan 28, 2025
7 checks passed
@alaudazzi alaudazzi deleted the zmoog/firehose-docs-refresh branch January 28, 2025 16:41
mergify bot pushed a commit that referenced this pull request Jan 28, 2025
* 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)
mergify bot pushed a commit that referenced this pull request Jan 28, 2025
* 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)
zmoog added a commit that referenced this pull request Jan 31, 2025
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>
zmoog added a commit that referenced this pull request Jan 31, 2025
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>
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.17 Automated backport with mergify needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants