Skip to content

(Work in progress) Add Filebeat input documentation to agent - #424

Closed
dedemorton wants to merge 11 commits into
elastic:mainfrom
dedemorton:issue#23741
Closed

(Work in progress) Add Filebeat input documentation to agent#424
dedemorton wants to merge 11 commits into
elastic:mainfrom
dedemorton:issue#23741

Conversation

@dedemorton

@dedemorton dedemorton commented Mar 4, 2021

Copy link
Copy Markdown
Contributor

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:

  • Fix the layout/format.
  • Compare content to latest version of Filebeat (the content is very old).
  • Make sure all lists are alphabetized.
  • Make a pass at fixing the examples.
  • Make sure content is correctly flagged as beta.
  • Make sure changes/additions from Update documentation of filestream input with the new improvements beats#25303 get into these docs.
  • Add harvester_buffer_size to topics where it is missing
  • Add "settings" to each section title that contains settings reference info
  • Add shared settings if we agree we want to repeat them
  • Add topic about AWS credentials
  • Add multiline settings.
  • Add info about Kerberos
  • Remove commented out links when the dependency is live

Dev input required:

  • Identify which settings are valid for Elastic Agent
  • Provide correct syntax and examples (current ones are Beats)
  • Review the content (many descriptions have been edited)
  • Verify types shown for settings and provide missing info
  • Identify all required settings
  • Identify missing defaults

TODO after merging:

  • Document basic config file structure and contents - describe what an input is, what a stream is,
@dedemorton dedemorton self-assigned this Mar 4, 2021
@dedemorton dedemorton changed the title Issue#23741 Mar 4, 2021
@ghost

ghost commented Mar 4, 2021

Copy link
Copy Markdown

A documentation preview will be available soon:

@dedemorton dedemorton added the Team:Fleet Label for the Fleet team label Mar 12, 2021
@ph
ph self-requested a review March 15, 2021 17:03
@ph

ph commented Mar 15, 2021

Copy link
Copy Markdown
Contributor

@ph's notes:

  • verify the examples, provide example to dede.
  • PH to commit directly on the PR.
@dedemorton
dedemorton marked this pull request as ready for review March 15, 2021 19:38
----
inputs:
- type: log
paths:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@ph I remember that this is not working and it has to go under streams currently?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes exactly.

@dedemorton dedemorton Apr 1, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.)

@dedemorton

dedemorton commented Apr 1, 2021

Copy link
Copy Markdown
Contributor Author

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:

image

@dedemorton

Copy link
Copy Markdown
Contributor Author

This PR will need to be updated with new settings added in elastic/beats#25303.

@dedemorton

Copy link
Copy Markdown
Contributor Author

@elasticmachine run elasticsearch-ci/docs

@mergify

mergify Bot commented Dec 9, 2021

Copy link
Copy Markdown
Contributor

This pull request is now in conflict. Could you fix it @dedemorton? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue#23741 upstream/issue#23741
git merge upstream/main
git push upstream issue#23741
@mergify

mergify Bot commented Dec 9, 2021

Copy link
Copy Markdown
Contributor

This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
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 Dec 9, 2021
@dedemorton dedemorton added Team:Elastic-Agent Label for the Agent team and removed Team:Fleet Label for the Fleet team labels Jan 12, 2022
@dedemorton

Copy link
Copy Markdown
Contributor Author

@ph Let's revive this PR. Needs a review.

@dedemorton

Copy link
Copy Markdown
Contributor Author

@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?

@ph ph added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label May 19, 2022
@ph
ph removed their request for review May 19, 2022 12:08
@ph

ph commented May 19, 2022

Copy link
Copy Markdown
Contributor

@jlind23 @cmacknz Would be good to have someone from data plane to look into this, for some reason I was not able to add it to the data plane board, it might a permission issue?

@jlind23
jlind23 requested a review from belimawr May 19, 2022 14:23
@jlind23

jlind23 commented May 19, 2022

Copy link
Copy Markdown
Contributor

I've pinged @belimawr on it.

@bmorelli25

Copy link
Copy Markdown
Member

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'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.

@dedemorton

Copy link
Copy Markdown
Contributor Author

@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.

@dedemorton dedemorton changed the title Add Filebeat input documentation to agent May 20, 2022
@belimawr

Copy link
Copy Markdown
Member

@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.

@mergify

mergify Bot commented Jan 24, 2023

Copy link
Copy Markdown
Contributor

This pull request is now in conflict. Could you fix it @dedemorton? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue#23741 upstream/issue#23741
git merge upstream/main
git push upstream issue#23741
@dedemorton

Copy link
Copy Markdown
Contributor Author

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.

@dedemorton dedemorton closed this Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-skip Skip notification from the automated backport with mergify blocked Team:Elastic-Agent Label for the Agent team Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team

6 participants