(Work in progress) Add Filebeat input documentation to agent - #424
(Work in progress) Add Filebeat input documentation to agent#424dedemorton wants to merge 11 commits into
Conversation
|
A documentation preview will be available soon: |
|
@ph's notes:
|
| ---- | ||
| inputs: | ||
| - type: log | ||
| paths: |
There was a problem hiding this comment.
@ph I remember that this is not working and it has to go under streams currently?
There was a problem hiding this comment.
All of these examples are simply copied from the Beats documentation and need to be modified to follow the new agent syntax. I need help with that, though, because the examples should be reviewed and validated, too. Rather than adding comments, it's probably better for you to pull down the branch and then push the example changes to my fork. I think it's OK if we don't test everything for the first iteration, but we should have a plan to test all of the documented configs before GA. If there's something repetitive that needs to be changed, I can ask other folks on the doc team to help out.
(I had no idea we had SO MANY input settings in Filebeat. Some of the descriptions needed a lot of love, too, so this has been a lot more work than I anticipated.)
|
I've changed the chunk level to make it easier to navigate the settings reference. I think there are too many options for one long, scrolling page (especially in the current doc system where the navigation disappears). We can change this structure when we migrate to the new doc system later on. Here's what it looks like now: |
|
This PR will need to be updated with new settings added in elastic/beats#25303. |
|
@elasticmachine run elasticsearch-ci/docs |
|
This pull request is now in conflict. Could you fix it @dedemorton? 🙏 |
|
This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
|
|
@ph Let's revive this PR. Needs a review. |
|
@bmorelli25 Remember this old thing? It feels like we're reviving Frankenstein's monster. I followed Kibana's lead and formatted this info in tables, but I see that starting with kibana issue 104482, they are using definition lists again. I am super frustrated with how poorly tables are rendered in our current docs (especially when you have long qualified setting names), so I am very tempted to kill the tables. It'll take a little time to cleanup, but I think it might be worth it to avoid having to enter manual breaks to avoid display problems with text in the right-hand column. WDYT? |
|
I've pinged @belimawr on it. |
I'm looking through the Kibana updates and the definition lists greatly improve readability. At the same time, there's the potential for improvement in table functionality and customization in the new doc system. If the time to update this PR isn't too ridiculous, I say go for it. Otherwise we can wait to see if tables will be functional again in the future. |
|
@belimawr Hold off on reviews for a day or so because I want to change the format of these docs. There are rendering issues in tables in our doc system that make the content difficult to read in places. I want to fix that. Also this content hasn't been update for a year, so I want to see if there is additional content that needs to be added. |
No problem, just ping me here once it's ready for review. |
|
This pull request is now in conflict. Could you fix it @dedemorton? 🙏 |
|
Closing this issue because the content is quite out-of-date and out-of-sync with Beats. Whoever works on https://github.com/elastic/ingest-docs/issues/131 might want to look at this PR because I did edit a lot of the content. |

NOTE: This PR is not ready for review
Previews: https://observability-docs_424.docs-preview.app.elstc.co/guide/en/fleet/master/elastic-agent-input-configuration.html
What I need to do to get this ready for review:
filestreaminput with the new improvements beats#25303 get into these docs.Dev input required:
TODO after merging: