From bd5f84ab0cd252a56e65d4f45a05683b9c207da8 Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Thu, 18 Jul 2019 16:20:45 -0400 Subject: [PATCH] Prepare core plugin docs for inclusion in LS ref Fixes #10977 --- docs/include/plugin_header-core.asciidoc | 14 ++++++++++++++ .../{java-dots.asciidoc => java_dots.asciidoc} | 15 ++++++--------- .../{java-line.asciidoc => java_line.asciidoc} | 15 ++++++--------- ...{java-plain.asciidoc => java_plain.asciidoc} | 15 ++++++--------- ...-uuid-filter.asciidoc => java_uuid.asciidoc} | 14 ++++++-------- ...nerator.asciidoc => java_generator.asciidoc} | 17 +++++++---------- ...{java-stdin.asciidoc => java_stdin.asciidoc} | 15 ++++++--------- .../{java-sink.asciidoc => java_sink.asciidoc} | 17 +++++++---------- ...ava-stdout.asciidoc => java_stdout.asciidoc} | 15 ++++++--------- 9 files changed, 64 insertions(+), 73 deletions(-) create mode 100644 docs/include/plugin_header-core.asciidoc rename docs/static/core-plugins/codecs/{java-dots.asciidoc => java_dots.asciidoc} (64%) rename docs/static/core-plugins/codecs/{java-line.asciidoc => java_line.asciidoc} (94%) rename docs/static/core-plugins/codecs/{java-plain.asciidoc => java_plain.asciidoc} (94%) rename docs/static/core-plugins/filters/{java-uuid-filter.asciidoc => java_uuid.asciidoc} (89%) rename docs/static/core-plugins/inputs/{java-generator.asciidoc => java_generator.asciidoc} (89%) rename docs/static/core-plugins/inputs/{java-stdin.asciidoc => java_stdin.asciidoc} (70%) rename docs/static/core-plugins/outputs/{java-sink.asciidoc => java_sink.asciidoc} (66%) rename docs/static/core-plugins/outputs/{java-stdout.asciidoc => java_stdout.asciidoc} (78%) diff --git a/docs/include/plugin_header-core.asciidoc b/docs/include/plugin_header-core.asciidoc new file mode 100644 index 000000000..64717a25d --- /dev/null +++ b/docs/include/plugin_header-core.asciidoc @@ -0,0 +1,14 @@ +[subs="attributes"] +++++ +{plugin} +++++ + +*{ls} Core Plugin.* The {plugin} {type} plugin cannot be +installed or uninstalled independently of {ls}. + +==== Getting Help + +For questions about the plugin, open a topic in the +http://discuss.elastic.co[Discuss] forums. For bugs or feature requests, open an +issue in https://github.com/logstash[Github]. + diff --git a/docs/static/core-plugins/codecs/java-dots.asciidoc b/docs/static/core-plugins/codecs/java_dots.asciidoc similarity index 64% rename from docs/static/core-plugins/codecs/java-dots.asciidoc rename to docs/static/core-plugins/codecs/java_dots.asciidoc index 6e9b04f7d..486ea30c9 100644 --- a/docs/static/core-plugins/codecs/java-dots.asciidoc +++ b/docs/static/core-plugins/codecs/java_dots.asciidoc @@ -1,22 +1,19 @@ -:plugin: jdots +:plugin: java_dots :type: codec /////////////////////////////////////////// -START - GENERATED VARIABLES, DO NOT EDIT! +REPLACES GENERATED VARIABLES /////////////////////////////////////////// -:version: %VERSION% -:release_date: %RELEASE_DATE% -:changelog_url: %CHANGELOG_URL% -:include_path: ../../../../logstash/docs/include +:include_path: ../../../../../logstash/docs/include /////////////////////////////////////////// -END - GENERATED VARIABLES, DO NOT EDIT! +END - REPLACES GENERATED VARIABLES /////////////////////////////////////////// [id="plugins-{type}s-{plugin}"] -=== Java dots codec plugin +=== Java_dots codec plugin -include::{include_path}/plugin_header.asciidoc[] +include::{include_path}/plugin_header-core.asciidoc[] ==== Description diff --git a/docs/static/core-plugins/codecs/java-line.asciidoc b/docs/static/core-plugins/codecs/java_line.asciidoc similarity index 94% rename from docs/static/core-plugins/codecs/java-line.asciidoc rename to docs/static/core-plugins/codecs/java_line.asciidoc index d769b1b6a..6b0f64d4f 100644 --- a/docs/static/core-plugins/codecs/java-line.asciidoc +++ b/docs/static/core-plugins/codecs/java_line.asciidoc @@ -2,21 +2,18 @@ :type: codec /////////////////////////////////////////// -START - GENERATED VARIABLES, DO NOT EDIT! +REPLACES GENERATED VARIABLES /////////////////////////////////////////// -:version: %VERSION% -:release_date: %RELEASE_DATE% -:changelog_url: %CHANGELOG_URL% -:include_path: ../../../../logstash/docs/include +:include_path: ../../../../../logstash/docs/include /////////////////////////////////////////// -END - GENERATED VARIABLES, DO NOT EDIT! +END - REPLACES GENERATED VARIABLES /////////////////////////////////////////// [id="plugins-{type}s-{plugin}"] -=== Java line codec plugin +=== Java_line codec plugin -include::{include_path}/plugin_header.asciidoc[] +include::{include_path}/plugin_header-core.asciidoc[] ==== Description @@ -27,7 +24,7 @@ Decoding behavior: All text data between specified delimiters will be decoded as Encoding behavior: Each event will be emitted with the specified trailing delimiter. [id="plugins-{type}s-{plugin}-options"] -==== Line Codec Configuration Options +==== Java_line Codec Configuration Options [cols="<,<,<",options="header",] |======================================================================= diff --git a/docs/static/core-plugins/codecs/java-plain.asciidoc b/docs/static/core-plugins/codecs/java_plain.asciidoc similarity index 94% rename from docs/static/core-plugins/codecs/java-plain.asciidoc rename to docs/static/core-plugins/codecs/java_plain.asciidoc index b2d819a97..97685739d 100644 --- a/docs/static/core-plugins/codecs/java-plain.asciidoc +++ b/docs/static/core-plugins/codecs/java_plain.asciidoc @@ -2,21 +2,18 @@ :type: codec /////////////////////////////////////////// -START - GENERATED VARIABLES, DO NOT EDIT! +REPLACES GENERATED VARIABLES /////////////////////////////////////////// -:version: %VERSION% -:release_date: %RELEASE_DATE% -:changelog_url: %CHANGELOG_URL% -:include_path: ../../../../logstash/docs/include +:include_path: ../../../../../logstash/docs/include /////////////////////////////////////////// -END - GENERATED VARIABLES, DO NOT EDIT! +END - REPLACES GENERATED VARIABLES /////////////////////////////////////////// [id="plugins-{type}s-{plugin}"] -=== Java plain codec plugin +=== Java_plain codec plugin -include::{include_path}/plugin_header.asciidoc[] +include::{include_path}/plugin_header-core.asciidoc[] ==== Description @@ -24,7 +21,7 @@ The `java_plain` codec is for text data with no delimiters between events. It is already have a defined framing in their transport protocol such as ZeroMQ, RabbitMQ, Redis, etc. [id="plugins-{type}s-{plugin}-options"] -==== Plain Codec Configuration Options +==== Java_plain Codec Configuration Options [cols="<,<,<",options="header",] |======================================================================= diff --git a/docs/static/core-plugins/filters/java-uuid-filter.asciidoc b/docs/static/core-plugins/filters/java_uuid.asciidoc similarity index 89% rename from docs/static/core-plugins/filters/java-uuid-filter.asciidoc rename to docs/static/core-plugins/filters/java_uuid.asciidoc index 603704431..bfa66aaa0 100644 --- a/docs/static/core-plugins/filters/java-uuid-filter.asciidoc +++ b/docs/static/core-plugins/filters/java_uuid.asciidoc @@ -2,21 +2,19 @@ :type: filter /////////////////////////////////////////// -START - GENERATED VARIABLES, DO NOT EDIT! +REPLACES GENERATED VARIABLES /////////////////////////////////////////// -:version: %VERSION% -:release_date: %RELEASE_DATE% -:changelog_url: %CHANGELOG_URL% :include_path: ../../../../../logstash/docs/include /////////////////////////////////////////// -END - GENERATED VARIABLES, DO NOT EDIT! +END - REPLACES GENERATED VARIABLES /////////////////////////////////////////// + [id="plugins-{type}s-{plugin}"] -=== Java UUID filter plugin +=== Java_uuid filter plugin -include::{include_path}/plugin_header.asciidoc[] +include::{include_path}/plugin_header-core.asciidoc[] ==== Description @@ -36,7 +34,7 @@ represented in standard hexadecimal string format, e.g. "e08806fe-02af-406c-bbde-8a5ae4475e57". [id="plugins-{type}s-{plugin}-options"] -==== Uuid Filter Configuration Options +==== Java_uuid Filter Configuration Options This plugin supports the following configuration options plus the <> described later. diff --git a/docs/static/core-plugins/inputs/java-generator.asciidoc b/docs/static/core-plugins/inputs/java_generator.asciidoc similarity index 89% rename from docs/static/core-plugins/inputs/java-generator.asciidoc rename to docs/static/core-plugins/inputs/java_generator.asciidoc index d3b9b422e..b888a8fa7 100644 --- a/docs/static/core-plugins/inputs/java-generator.asciidoc +++ b/docs/static/core-plugins/inputs/java_generator.asciidoc @@ -3,32 +3,29 @@ :default_codec: plain /////////////////////////////////////////// -START - GENERATED VARIABLES, DO NOT EDIT! +REPLACES GENERATED VARIABLES /////////////////////////////////////////// -:version: %VERSION% -:release_date: %RELEASE_DATE% -:changelog_url: %CHANGELOG_URL% -:include_path: ../../../../logstash/docs/include +:include_path: ../../../../../logstash/docs/include /////////////////////////////////////////// -END - GENERATED VARIABLES, DO NOT EDIT! +END - REPLACES GENERATED VARIABLES /////////////////////////////////////////// [id="plugins-{type}s-{plugin}"] -=== Java generator input plugin +=== Java_generator input plugin -include::{include_path}/plugin_header.asciidoc[] +include::{include_path}/plugin_header-core.asciidoc[] ==== Description -Generate synthethic log events. +Generate synthetic log events. This plugin generates a stream of synthetic events that can be used to test the correctness or performance of a Logstash pipeline. [id="plugins-{type}s-{plugin}-options"] -==== Generator Input Configuration Options +==== Java_generator Input Configuration Options This plugin supports the following configuration options plus the <> described later. diff --git a/docs/static/core-plugins/inputs/java-stdin.asciidoc b/docs/static/core-plugins/inputs/java_stdin.asciidoc similarity index 70% rename from docs/static/core-plugins/inputs/java-stdin.asciidoc rename to docs/static/core-plugins/inputs/java_stdin.asciidoc index e103cc094..d7137540e 100644 --- a/docs/static/core-plugins/inputs/java-stdin.asciidoc +++ b/docs/static/core-plugins/inputs/java_stdin.asciidoc @@ -3,21 +3,18 @@ :default_codec: java_line /////////////////////////////////////////// -START - GENERATED VARIABLES, DO NOT EDIT! +REPLACES GENERATED VARIABLES /////////////////////////////////////////// -:version: %VERSION% -:release_date: %RELEASE_DATE% -:changelog_url: %CHANGELOG_URL% -:include_path: ../../../../logstash/docs/include +:include_path: ../../../../../logstash/docs/include /////////////////////////////////////////// -END - GENERATED VARIABLES, DO NOT EDIT! +END - REPLACES GENERATED VARIABLES /////////////////////////////////////////// [id="plugins-{type}s-{plugin}"] -=== Java stdin input plugin +=== Java_stdin input plugin -include::{include_path}/plugin_header.asciidoc[] +include::{include_path}/plugin_header-core.asciidoc[] ==== Description @@ -27,7 +24,7 @@ By default, each event is assumed to be terminated by end-of-line. If you want e method, you'll need to use a codec with support for that encoding. [id="plugins-{type}s-{plugin}-options"] -==== Stdin Input Configuration Options +==== Java_stdin Input Configuration Options There are no special configuration options for this plugin, but it does support the <>. diff --git a/docs/static/core-plugins/outputs/java-sink.asciidoc b/docs/static/core-plugins/outputs/java_sink.asciidoc similarity index 66% rename from docs/static/core-plugins/outputs/java-sink.asciidoc rename to docs/static/core-plugins/outputs/java_sink.asciidoc index e52b2e8ed..cfec6dbb9 100644 --- a/docs/static/core-plugins/outputs/java-sink.asciidoc +++ b/docs/static/core-plugins/outputs/java_sink.asciidoc @@ -1,23 +1,20 @@ -:plugin: sink +:plugin: java_sink :type: output :default_codec!: /////////////////////////////////////////// -START - GENERATED VARIABLES, DO NOT EDIT! +REPLACES GENERATED VARIABLES /////////////////////////////////////////// -:version: %VERSION% -:release_date: %RELEASE_DATE% -:changelog_url: %CHANGELOG_URL% -:include_path: ../../../../logstash/docs/include +:include_path: ../../../../../logstash/docs/include /////////////////////////////////////////// -END - GENERATED VARIABLES, DO NOT EDIT! +END - REPLACES GENERATED VARIABLES /////////////////////////////////////////// [id="plugins-{type}s-{plugin}"] -=== Sink output plugin +=== Java_sink output plugin -include::{include_path}/plugin_header.asciidoc[] +include::{include_path}/plugin_header-core.asciidoc[] ==== Description @@ -25,7 +22,7 @@ An event sink that discards any events received. Generally useful for testing th and filters. [id="plugins-{type}s-{plugin}-options"] -==== Sink Output Configuration Options +==== Java_sink Output Configuration Options There are no special configuration options for this plugin, but it does support the <>. diff --git a/docs/static/core-plugins/outputs/java-stdout.asciidoc b/docs/static/core-plugins/outputs/java_stdout.asciidoc similarity index 78% rename from docs/static/core-plugins/outputs/java-stdout.asciidoc rename to docs/static/core-plugins/outputs/java_stdout.asciidoc index c040c3451..315a109b8 100644 --- a/docs/static/core-plugins/outputs/java-stdout.asciidoc +++ b/docs/static/core-plugins/outputs/java_stdout.asciidoc @@ -3,21 +3,18 @@ :default_codec: java_line /////////////////////////////////////////// -START - GENERATED VARIABLES, DO NOT EDIT! +REPLACES GENERATED VARIABLES /////////////////////////////////////////// -:version: %VERSION% -:release_date: %RELEASE_DATE% -:changelog_url: %CHANGELOG_URL% -:include_path: ../../../../logstash/docs/include +:include_path: ../../../../../logstash/docs/include /////////////////////////////////////////// -END - GENERATED VARIABLES, DO NOT EDIT! +END - REPLACES GENERATED VARIABLES /////////////////////////////////////////// [id="plugins-{type}s-{plugin}"] -=== Java stdout output plugin +=== Java_stdout output plugin -include::{include_path}/plugin_header.asciidoc[] +include::{include_path}/plugin_header-core.asciidoc[] ==== Description @@ -42,7 +39,7 @@ java_stdout. } [id="plugins-{type}s-{plugin}-options"] -==== Stdout Output Configuration Options +==== Java_stdout Output Configuration Options There are no special configuration options for this plugin, but it does support the <>.