Add data stream docs to Fleet user guide #429
Conversation
|
A docs preview will be available soon: |
bmorelli25
changed the title
| As an added bonus, only relevant fields are shown in Discover. | ||
|
|
||
| * *More granular data control*: For example, filesystem, load, cpu, network, and process metrics are sent | ||
| to different indices–each potentially with its own rollover, retention, and security permissions. |
There was a problem hiding this comment.
| to different indices–each potentially with its own rollover, retention, and security permissions. | |
| to different indices–-each potentially with its own rollover, retention, and security permissions. |
There was a problem hiding this comment.
I think -- gets converted into an em dash.
There was a problem hiding this comment.
That's already an em dash :)
There was a problem hiding this comment.
It's hard to tell in the source file, but a little easier in the built version:
| <type>-<dataset>-<namespace> | ||
| -- | ||
|
|
||
| For example, if you've set up the Nginx integration with a namespace of `prod`, |
There was a problem hiding this comment.
You might want to format this differently to make it easier to scan. Maybe more white space? Honestly I think the line wraps in the middle of names are making it harder to follow the example.
There was a problem hiding this comment.
I added additional white space and moved the examples to code blocks in 2ddd984.
|
|
||
| TIP: If you're familiar with the concept of indices, you can think of each data stream as a separate index in {es}. | ||
| Under the hood though, things are a bit more complex. | ||
| All of the juicy details are available in {ref}/data-streams.html[{es} Data streams]. |
There was a problem hiding this comment.
Nice! Knowing "juicy details" is way more intriguing than having to read some other docs. :->
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
Summary
This PR adds a general overview of data streams to the Fleet user guide. The content is not complete yet, but I don't have any additional time to devote to this in the current iteration. I'd like to publish this and circle back later with additional updates.
Unbeknownst to DeDe and I, it appears that the Elasticsearch documentation team has already put a lot of work into creating docs about data streams–as expected, some of this content is particularly useful for Fleet/Agent users. I'm not going to reinvent the wheel, so this PR borrows very heavily from the following sources:
Eventually, we may want to single-source some snippets of content from the ES repository.
Documentation preview
Click here to view a documentation preview
Related issues
For elastic/apm-server#4494.