-
Notifications
You must be signed in to change notification settings - Fork 204
Add Custom data streams docs #11659
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
base: main
Are you sure you want to change the base?
Add Custom data streams docs #11659
Conversation
🔍 Preview links for changed docs |
|
Pinging @elastic/ingest-docs (Team:Docs) |
theletterf
left a comment
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.
Excellent! Let's get a review by an ingest lead (@AlexanderWert and @jlind23)
|
|
||
| Changing the `dataset` value can cause: | ||
|
|
||
| - Dashboards and {{product.apm}} views to fail to load |
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.
Also any other content pack that you end installing though.
cc @AlexanderWert
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.
Good point, thanks for pointing that out!
| We strongly recommend not changing the default data stream names. Customizing data stream routing diverges from the standard ingestion model and there's no guarantee it will be valid for future versions. | ||
| ::: | ||
|
|
||
| ## When to customize data streams |
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 feel like the order of information could be better here. Right now it's:
- Should I customize?
- Which part is safe to change?
- What is the naming sctructure?
- Which part is safe to change? (again)
- Which part is dangerous to change and why?
I think it'd be better as:
- Should I customize?
- If yes, what is the naming sctructure?
- Which part is safe to change?
- Which part is dangerous to change and why?
for example
When to customize data streams
The only recommended use case for customizing data stream routing is to separate data by environment (for example: dev, staging, and prod).
A data stream name follows this structure:
<type>-<dataset>-<namespace>
We recommend changing only data_stream.namespace, not data_stream.dataset.
data_stream.namespace
The namespace is intended as the configurable part of the name. Elastic dashboards, detectors, and UIs support multiple namespaces automatically.
data_stream.dataset
Only modify dataset if it's absolutely necessary and you're aware of the tradeoffs. Changing the dataset value can cause:
- list of downsides
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 see what you mean. I've changed the order - see if you like it better now
|
This pull request is now in conflicts. Could you fix it? 🙏 |
bmorelli25
left a comment
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.
Thanks for making those changes!
What does this PR do?
Introduces a new page describing advanced data stream routing in EDOT. The page explains when routing customization is appropriate, the recommended pattern of using
data_stream.namespace, the risks associated with modifyingdata_stream.dataset, and the naming constraints for template-based routing.Why is it important?
Until now, this information existed only in a KB and was not discoverable in the official documentation.
Checklist
- [ ] My code follows the style guidelines of this project- [ ] I have commented my code, particularly in hard-to-understand areas- [ ] I have made corresponding change to the default configuration files- [ ] I have added tests that prove my fix is effective or that my feature works- [ ] I have added an entry in./changelog/fragmentsusing the changelog tool- [ ] I have added an integration test or an E2E testDisruptive User Impact
None
Related issues
Closes #4133
Generative AI disclosure
Tool(s) and model(s) used: Claude 4.5 Sonnet via Cursor