-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Add more context and examples to Filebeat module docs #5341
Conversation
f8dea13
to
8145a3b
Compare
@elastic/beats My updates to the modules doc are ready to review. A few outstanding items (some of which you can help with):
I wanted to get this out tonight in case you can look tomorrow, so my apologies for not putting up a build on firebase. I'm using a lot of includes because there is a lot of shared content. The best way to review is to pull down the files and build the doc. |
I reviewed one module and the included reused sections, very nice! The what-happens section I think should state that we're using ingest node. Right now it sounds like Filebeat does the parsing which is maybe a little misleading. "Parses and processes the log lines..." |
One small nitpick that I found is that at the end of each module there's this phrase: "For a description of each field in the metricset, see the exported fields section.". The nitpick is that metricset is Metricbeat specific terminology, it should just say "module" instead, I think. |
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, really nice! I think the following modules still need to be transformed: Kafka, PostgresSQL, Traefik. And Icinga needs a screenshot. The first three are not in 6.0, so I'd say that's not urgent.
1898e32
to
6cefc4e
Compare
6cefc4e
to
e0ec1f3
Compare
* Remove tutorial * Add more context and examples to module docs * Add fixes from review
* Remove tutorial * Add more context and examples to module docs * Add fixes from review
* Add Collectbeat to community beats (#5327) * Added KrakenBeat (#5393) * Added KrakenBeat https://github.com/PPACI/krakenbeat[krakenbeat]:: Collect information on each transaction on the Kraken crypto platform. * Update communitybeats.asciidoc Fix for alphabetical sort * Add modules.d info to metricbeat docs (#5270) * Add modules.d info to metricbeat docs * Fix issues from review * Add more context and examples to Filebeat module docs (#5341) * Remove tutorial * Add more context and examples to module docs * Add fixes from review * Update screen captures in Filebeat docs * Remove changelog entries
…, elastic#5456 (elastic#5445) * Add Collectbeat to community beats (elastic#5327) * Added KrakenBeat (elastic#5393) * Added KrakenBeat https://github.com/PPACI/krakenbeat[krakenbeat]:: Collect information on each transaction on the Kraken crypto platform. * Update communitybeats.asciidoc Fix for alphabetical sort * Add modules.d info to metricbeat docs (elastic#5270) * Add modules.d info to metricbeat docs * Fix issues from review * Add more context and examples to Filebeat module docs (elastic#5341) * Remove tutorial * Add more context and examples to module docs * Add fixes from review * Update screen captures in Filebeat docs * Remove changelog entries
This effort is to provide more contextual information within the topics about each module so that users who go from the solution pages directly to the modules doc have the info they need to work with the modules without jumping around a lot.
I plan to take all the shared content and pull it into shared files, but I wanted to make the content easier to read for the initial draft.
If this looks like the right approach, I'll apply it to the docs across the Filebeat modules.
I removed the tutorial because it's now redundant (we have the quick start and the config reference info that covers the content that was previously in the tutorial).