[backport 7x] Doc: wildcards in xpack.management.pipeline.id (#12416)

Backports: #12396
Fixes: #12366
This commit is contained in:
kaisecheng 2020-11-05 17:34:14 +01:00 committed by GitHub
parent 92f304a132
commit d473e0b7cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 21 additions and 0 deletions

View file

@ -43,3 +43,4 @@ that the `pipelines.yml` file and settings like `path.config` and
`config.string` are inactive when this feature is enabled.
include::{log-repo-dir}/static/settings/configuration-management-settings.asciidoc[]
include::{log-repo-dir}/static/settings/configuration-wildcard-pipeline-id.asciidoc[]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 143 KiB

Before After
Before After

View file

@ -40,6 +40,7 @@ The default is 5s.
Specify a comma-separated list of pipeline IDs to register for centralized
pipeline management. After changing this setting, you need to restart Logstash
to pick up changes.
Pipeline IDs support `*` as a <<wildcard-in-pipeline-id, wildcard>> for matching multiple IDs
`xpack.management.elasticsearch.hosts`::

View file

@ -0,0 +1,19 @@
[role="xpack"]
[[wildcard-in-pipeline-id]]
==== Wildcard support in pipeline ID
++++
<titleabbrev>Wildcard support in pipeline ID</titleabbrev>
++++
Pipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, and numbers.
You can use `*` in `xpack.management.pipeline.id` to match any number of letters, underscores, dashes, and numbers.
[source,shell]
-----
xpack.management.pipeline.id: ["*logs", "*apache*", "tomcat_log"]
-----
In this example, `"*logs"` matches all IDs ending in `logs`. `"*apache*"` matches any IDs with `apache` in the name.
Wildcard in pipeline IDs is available starting with Elasticsearch 7.10. Logstash can pick up new pipeline without a restart if the new pipeline ID matches the wildcard pattern.