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.

Sign up for GitHub

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

Jump to bottom

docs: surface dictionary_path-related settings #101

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: surface dictionary_path-related settings #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ deprecated[3.3.0, Use <<plugins-{type}s-{plugin}-target>> instead. In 4.0 this s

* Value type is <<hash,hash>>
* Default value is `{}`
* This setting _cannot_ be combined with `dictionary_path`

The dictionary to use for translation, when specified in the logstash filter
configuration item (i.e. do not use the `dictionary_path` file).
Expand All @@ -155,6 +156,8 @@ NOTE: It is an error to specify both `dictionary` and `dictionary_path`.

* Value type is <<path,path>>
* There is no default value for this setting.
* This setting _cannot_ be combined with `dictionary`
* See also: <<plugins-{type}s-{plugin}-refresh_interval>> and <<plugins-{type}s-{plugin}-refresh_behaviour>>

The full path of the external dictionary file. The format of the table should be
a standard YAML, JSON, or CSV.
Comment on lines +160 to 163
Copy link
Member

Choose a reason for hiding this comment

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

From the initial request for clarification we also need to make clear that the contents are entirely stored in memory. A suggestion:

Suggested change
* See also: <<plugins-{type}s-{plugin}-refresh_interval>> and <<plugins-{type}s-{plugin}-refresh_behaviour>>
The full path of the external dictionary file. The format of the table should be
a standard YAML, JSON, or CSV.
* See also: <<plugins-{type}s-{plugin}-refresh_interval>> and <<plugins-{type}s-{plugin}-refresh_behaviour>>
The full path of the external dictionary file.
The dictionary is read into memory to allow fast lookups, so make sure the JVM Heap is sized to fit its entire content.
The format of the table should be a standard YAML, JSON, or CSV.

Expand Down Expand Up @@ -390,6 +393,9 @@ Resources on regex formatting are available online.
===== `refresh_behaviour`

* Value type is <<string,string>>
* Acceptable values are:
** `merge`
** `replace`
* Default value is `merge`

When using a dictionary file, this setting indicates how the update will be executed.
Expand Down