Clarify -f description and add info about supported glob patterns

Fixes #6327
This commit is contained in:
DeDe Morton 2016-11-22 13:03:58 -08:00
parent 40cd0874b0
commit 97740ab49c
2 changed files with 47 additions and 4 deletions

View file

@ -16,10 +16,23 @@ Any flags that you set at the command line override the corresponding settings i
hostname.
*`-f, --path.config CONFIG_PATH`*::
Load the Logstash config from a specific file or directory. If a directory is given, all
files in that directory will be concatenated in lexicographical order and then parsed as a
single config file. You can also specify wildcards (globs) and any matched files will
be loaded in the order described above.
Load the Logstash config from a specific file or directory. If a directory is given, all
files in that directory will be concatenated in lexicographical order and then parsed as a
single config file. Specifying this flag multiple times is not supported. If you specify
this flag multiple times, Logstash uses the last occurrence (for example, `-f foo -f bar`
is the same as `-f bar`).
+
You can specify wildcards (<<glob-support,globs>>) and any matched files will
be loaded in the order described above. For example, you can use the wildcard feature to
load specific files by name:
+
[source,shell]
---------------------------------------------
bin/logstash --debug -f '/tmp/{one,two,three}'
---------------------------------------------
+
With this command, Logstash concatenates three config files, `/tmp/one`, `/tmp/two`, and
`/tmp/three`, and parses them into a single config.
*`-e, --config.string CONFIG_STRING`*::
Use the given string as the configuration data. Same syntax as the config file. If no

30
docs/static/glob-support.asciidoc vendored Normal file
View file

@ -0,0 +1,30 @@
[[glob-support]]
=== Glob Pattern Support
Logstash supports the following patterns wherever glob patters are allowed:
*`*`*::
Match any file. You can also use an `*` to restrict other values in the glob.
For example, `*conf` matches all files that end in `conf`. `*apache*` matches
any files with `apache` in the name. This pattern does not match hidden files
(dot files) on Unix-like operating systems. To match dot files, use a pattern
like `{*,.*}`.
*`**`*::
Match directories recursively.
*`?`*::
Match any one character.
*`[set]`*::
Match any one character in a set. For example, `[a-z]`. Also supports set negation
(`[^a-z]`).
*`{p,q}`*::
Match either literal `p` or literal `q`. The matching literal can be more than one
character, and you can specify more than two literals. This pattern is the equivalent
to using alternation with the vertical bar in regular expressions (`foo|bar`).
*`\`*::
Escape the next metacharacter. This means that you cannot use a backslash in Windows
as part of a glob. The pattern `c:\foo*` will not work, so use `foo*` instead.