Skip to content
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

Beats doc updates in 6.x #5632

dedemorton opened this issue Nov 17, 2017 · 1 comment


None yet
1 participant
Copy link

commented Nov 17, 2017

THIS DOCUMENT IS OBSOLETE. Please contact me for a pointer to the new location of the doc roadmap. All unresolved items from this list have either been moved to the roadmap, added to the backlog, or closed because they were deemed no longer necessary.


  • Resolve #861)
  • [DeDe] Make sure GS guides accurately reflect requirement for using sudo (Most of the Beats require to sudo commands. Exception is Filebeat and Heartbeat (only if icmp is not configured)). Look at the soln docs as a source of truth for recommendations.
  • Random edits:
  • Check FAQ meta issue and determine if any items from the issue should be added to the docs for the next release: #3599 - [x] Config file format (backlog)
    • Filebeat Modules tutorial - possibly rewrite as task-based topics
    • Jolokia module docs
  • #3340 (problem here might be that it's not obvious that processors can be applied to modules because we point off to another topic that describes the shared options. Instead of doing this, maybe we should put the config options in a shared file that gets pulled into the docs for all modules.
  • #4268 (carlos said he might take a crack at this one)
  • #4826 (need to document permissions for things like running ingest pipelines, setting up dashboards, index patterns, etc).
  • Clean up CLI docs so that the user sees one list of commands rather than a list separated into two sections (for beats that add their own options). This will involve some conditional coding to implement.
  • REMOVED Organize FAQ topics (either alphabetically or logically). See #2258 - I'm removing this from my list in favor of more important work because it's low-value. Maybe someday.


  • Add missing config info (paths) to the module docs for the Kibana and Elasticsearch modules: #7835
  • [DeDe] Update dashboards. Need to show the latest version of the dashboards.
  • Follow up: document http endpoint. See #3933. (backport to 6.2, if possible)
  • Follow up: document headers and ssl for metricsets. See #3948 (backport to 6.2, if possible)
  • [DeDe] Filebeat system module startup instructions (Brandon) #4567 (backport to 6.2, if possible)
  • Document backoff setting. See #5419. Fixed in #6903
  • Old defect triage. Resolved 20+ defects.


  • Make sure these get reviewed:
  • [DeDe] Refactor prospector/intput docs. Add a list of prospectors/inputs in the Filebeat docs. Currently, we have a list of the type, but it would be nice to have more visibility (maybe add a separate section about from where to get the logs, via udp, redis slow logs). Also see #5944 for work related to renaming prospectors to inputs. The UDP input, in particular, needs more detail about configuration (see #4452) Also see #6122 and #6375 and #6266
  • Change title of topic about ingest node to say "Parse data" instead of "Parse logs" because "logs" does not make sense in all contexts where ingest node is used with beats.
  • Update Metricbeat getting started to show how to enable/disable by using the modules.d directory. See #5325
  • [DeDe] Need Beats users to know about the additional commands for importing dashboards that are covered here: Right now the info is only obvious to developers...users need to know these options, too. Make it more clear in the Getting Started guides that these options exist. (backport to 6.2, if possible)
  • Add pointer to SSL settings in the Heartbeat monitor docs. See #5599
  • Document beat user permission required to use ingest pipelines (backport to 6.0+, if possible). See #4826
  • REMOVED Improve retrievability of reference info about config options. It's still too hard to find stuff. (We are improving the search, so I'm closing this one)


Marking these items as 6.0 so we remember to backport them.

  • Clarify docs about config reloading. See #5676.
  • [Tudor] Filebeat modules: Machine learning jobs. See #4506. setup command is documented, but we probably need to add info about required privileges plus maybe have some conceptual info.
    language indicating the version of kibana that's required to see the dashboards.
  • Follow up. Make sure that all PRs labeled as needs_docs have documentation, specifically:
    • Use packetbeat protocols to publish beat.Event to new pipeline #4599 (backport in #4878 )
    • [urso] Convert heartbeat to new publisher pipeline #4591 (backport in #4878 )

6.1+ (list is a work-in-progress...created as a place holder)

  • Convert format of the Filebeat modules doc for Kafka, PostgresSQL, and Traefik (any modules added after 6.0) to match the other module docs.
  • Conditionally code pre-release content. See #5652


  • Make sure the docs get updated with info about the password keystore. See #5687
  • Document autodiscover for kubernetes: #6055. See #6065

@dedemorton dedemorton referenced this issue Nov 17, 2017


Beats doc updates in 6.0 #4540

42 of 42 tasks complete

@dedemorton dedemorton changed the title Beats doc updates in 6.1 Beats doc updates in 6.x Dec 14, 2017

@ph ph referenced this issue Dec 21, 2017


[WIP] Rename prospector to input #5944

0 of 5 tasks complete

@dedemorton dedemorton referenced this issue Jan 22, 2018


UDP prospector type with plain harvester #4452

3 of 4 tasks complete

@dedemorton dedemorton added v6.3.0 and removed v6.1.0 labels Apr 12, 2018

@dedemorton dedemorton added v6.4.0 and removed v6.3.0 labels Jul 10, 2018

@dedemorton dedemorton added v6.5.0 and removed v6.4.0 labels Aug 17, 2018


This comment has been minimized.

Copy link
Contributor Author

commented Aug 30, 2018

I'm closing this meta issue because I will no longer be using it to track the doc roadmap starting with Beats 6.5 and later.

@dedemorton dedemorton closed this Aug 30, 2018

@dedemorton dedemorton removed the v6.5.0 label Aug 30, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.