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

Fix processor autodiscovery docs for Filebeat #7937

Merged
merged 2 commits into from
Aug 15, 2018

Conversation

ruflin
Copy link
Contributor

@ruflin ruflin commented Aug 10, 2018

{ needs escaping as otherwise asciidoc will show an empty code block.

{ needs escaping as otherwise asciidoc will show an empty code block.
@ruflin ruflin added docs Filebeat Filebeat needs_backport PR is waiting to be backported to other branches. labels Aug 10, 2018
@ruflin ruflin requested a review from dedemorton August 10, 2018 08:48
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

LGTM as-is, but removing subs="attributes" might be a better approach (see comment).

@@ -75,8 +75,8 @@ arbitrary ordering:

["source","yaml",subs="attributes"]
-------------------------------------------------------------------------------------
co.elastic.logs/processors.1.dissect.tokenizer: "%{key1} %{key2}"
co.elastic.logs/processors.dissect.tokenizer: "%{key2} %{key1}"
co.elastic.logs/processors.1.dissect.tokenizer: "%\{key1} %\{key2}"
Copy link
Contributor

Choose a reason for hiding this comment

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

Escaping works, but you can avoid the need to escape completely by telling asciidoc to treat the whole code block as text. There aren't any asciidoc attributes in this example, so there is no need to usesubs="attributes".

[source,yaml]
-------------------------------------------------------------------------------------
co.elastic.logs/processors.1.dissect.tokenizer: "%{key1} %{key2}"
co.elastic.logs/processors.dissect.tokenizer: "%{key2} %{key1}"
-------------------------------------------------------------------------------------

@dedemorton
Copy link
Contributor

dedemorton commented Aug 10, 2018

Incidentally this is another example of missing content due to the problem described in elastic/docs#220. (Commenting to get this PR added to the list of problems arising from asciidoc's "default" behavior.)

@ruflin
Copy link
Contributor Author

ruflin commented Aug 14, 2018

@dedemorton Changed accordingly.

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

LGTM

@jsoriano jsoriano merged commit 62f8c45 into elastic:master Aug 15, 2018
dedemorton pushed a commit to dedemorton/beats that referenced this pull request Aug 17, 2018
{ needs escaping as otherwise asciidoc will show an empty code block.
jsoriano pushed a commit that referenced this pull request Aug 17, 2018
…#7996)

* Add document for beat export dashboard (#7696)
* Add safeguard related statements for max_backoff setting (#7889)
* Add docs about append_fields (#7903)
* Fix processor autodiscovery docs for Filebeat (#7937)
* Minor fixes to attributes in module docs (#7949)
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Aug 18, 2018
dedemorton pushed a commit to dedemorton/beats that referenced this pull request Aug 30, 2018
{ needs escaping as otherwise asciidoc will show an empty code block.
dedemorton pushed a commit to dedemorton/beats that referenced this pull request Aug 31, 2018
{ needs escaping as otherwise asciidoc will show an empty code block.
dedemorton added a commit that referenced this pull request Sep 4, 2018
…7937 #7939 #7948 #7949 #7950)  (#8188)

* Reset modulename attribute at the end of a file (#7888)

* Add safeguard related statements for max_backoff setting (#7889)

* Add docs about append_fields (#7903)

* Add docs about append_fields
* Remove experimental tag from setup.template.json.enabled description

* Metricbeat: Add compatibility notes where missing (#7939)

* Metricbeat: Add compatibility notes where missing, based on integration tests

* Added review suggestions

* Add missing config options to Logstash section of reference.yml (#7883)

Closes #3062

* Fix processor autodiscovery docs for Filebeat (#7937)

{ needs escaping as otherwise asciidoc will show an empty code block.

* Add document for beat export dashboard (#7696)

* Add document for beat export dashboard

Follow up from #7239

* move to command reference

* address review comments

* review comments applied

* apply review feedback

* Replace golang with Go (#7948)

I've been told that using "golang" instead of "Go" is considered a faux pas in some circles. :-)

I've replaced instances in the external docs, but I did not update the changelog, readmes, or code files.

* Minor fixes to attributes in module docs (#7949)

* Add recommendation to avoid harvesting symlinks when dealing with file rotation (#7950)
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
…tic#7903 elastic#7937 elastic#7949) (elastic#7996)

* Add document for beat export dashboard (elastic#7696)
* Add safeguard related statements for max_backoff setting (elastic#7889)
* Add docs about append_fields (elastic#7903)
* Fix processor autodiscovery docs for Filebeat (elastic#7937)
* Minor fixes to attributes in module docs (elastic#7949)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants