logstash icon indicating copy to clipboard operation
logstash copied to clipboard

Doc: Rethink plan to reorganize settings docs

Open karenzone opened this issue 3 years ago • 5 comments

The same settings are documented in different places originating from different source files. (See queue settings, for example.) This situation sets us up for documentation getting out of sync because a setting gets updated in one place but not another.

Consider a single-sourcing approach that defines settings (as attributes perhaps) in one file to facilitate reuse wherever we need them.

ToDo: Add documentation about the interaction of overlapping settings in logstash.yml, pipelines.yml, and central management.

See also: #13419

karenzone avatar May 19 '22 23:05 karenzone

Notes to self @karenzone:

  • Think about setting up each setting as an attribute using the definition list format.

  • Possible format for content:

    ``queue.max_bytes`:: The total capacity of _each queue_ in number of bytes. 
    Unless overridden in `pipelines.yml` or central management, each persistent
    queue will be sized at the value of `queue.max_bytes` specified in
    `logstash.yml`. 
    The default is 1024mb (1gb).
    
    Screen Shot 2022-05-19 at 7 21 55 PM
  • This project would also be an opportunity to add notes about the interaction of overlapping settings in logstash.yml, pipelines.yml, and central management.

ToDo:

  • Test to be sure that we could expand content (with +) and keep it inline for situations where additional information is needed. (Tips, notes, etc.)

karenzone avatar May 19 '22 23:05 karenzone

Note to self @karenzone: When adding new attributes and content, review carefully to be sure that no content is dropped because of bad formatting, returns, etc.

karenzone avatar Jun 03 '22 01:06 karenzone

Moved to HOLD because of competing priorities

karenzone avatar Nov 04 '22 17:11 karenzone

This work was started in https://github.com/elastic/logstash/pull/14384 before it was put on hold. When I pick this up again, I will use the work started in #14384, but implement it as a series of smaller, more granular PRs.

TO DO: Divide work into chunks and track in a meta issue.

karenzone avatar Aug 09 '23 21:08 karenzone