-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
Doc: Evaluate restructuring "Configuring Logstash" section #13671
Comments
This restructuring would be foundational to #13488 and would give us one additional heading level to play with. |
As noted in conversation with @alexander-marquardt, "configuring" is a loaded term. As part of this work, we'll do more to clarify and put the focus on creating pipelines. |
Agree. When I think of "Configuring logstash" I intuitively think of configuration settings such as logstash.yml, jvm.options, log4j.properties, as opposed to thinking about declaring a pipeline. For example, it is structured this way in the Configuring elasticsearch documentation. To add to the confusion, in order to distinguish the definition of a pipeline versus configuration of Logstash itself, in Logstash we refer to the Logstash settings file for configuring Logstash. [ As a side note - part of what can cause confusion is caused by the logstash pipeline definition file being called a ".config" file - longer term (I believe) we could theoretically also change the ".config" extension to something more descriptive as I think that the extension is user defined. ] I am not totally clear on the exact name that this section should be called. To me a more accurate section name would be along the lines of (for example): "Defining a Logstash Pipeline", "Pipeline definition". This is not only about the title, but everywhere in the description where we say "to configure logstash", it should be more descriptive - something similar to "to create a logstash pipeline" , "to define a logstash pipeline", etc (whatever makes sense given the context). As an example, in the docs we state the following:
Perhaps a more understandable and SEO friendly structure would be something like the following:
(Note that in the future, we should also evaluate if this should even be called a "config" file or something more descriptive) |
Evaluate restructure "Configuring Logstash" section for better organization and to raise visibility of information
Current TOC structure:
Proposed TOC structure:
This approach groups similar information and foundational concepts under "Configuring," while elevating "Event Data and Fields" to make it easier to find and reference. This approach also elevates Elastic Cloud info to make it obvious that users can easily send data from Logstash to hosted Elasticsearch Service.
The text was updated successfully, but these errors were encountered: