github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 22:57:16 -04:00
Code Issues Projects Releases Packages Wiki Activity

Prepare core plugin docs for inclusion in LS ref

Browse source 
Fixes #10977
This commit is contained in:
Karen Metts 2019-07-18 16:20:45 -04:00
parent 3d00f3e648
commit bd5f84ab0c
9 changed files with 64 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/include/plugin_header-core.asciidoc Normal file
View file

@ -0,0 +1,14 @@
[subs="attributes"]
++++
<titleabbrev>{plugin}</titleabbrev>
++++
*{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].

15
docs/static/core-plugins/codecs/java-dots.asciidoc → docs/static/core-plugins/codecs/java_dots.asciidoc vendored
View file

@ -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

15
docs/static/core-plugins/codecs/java-line.asciidoc → docs/static/core-plugins/codecs/java_line.asciidoc vendored
View file

@ -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",]
|=======================================================================

15
docs/static/core-plugins/codecs/java-plain.asciidoc → docs/static/core-plugins/codecs/java_plain.asciidoc vendored
View file

@ -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",]
|=======================================================================

14
docs/static/core-plugins/filters/java-uuid-filter.asciidoc → docs/static/core-plugins/filters/java_uuid.asciidoc vendored
View file

@ -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 <<plugins-{type}s-{plugin}-common-options>> described later.

17
docs/static/core-plugins/inputs/java-generator.asciidoc → docs/static/core-plugins/inputs/java_generator.asciidoc vendored
View file

@ -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 <<plugins-{type}s-{plugin}-common-options>> described later.

15
docs/static/core-plugins/inputs/java-stdin.asciidoc → docs/static/core-plugins/inputs/java_stdin.asciidoc vendored
View file

@ -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 <<plugins-{type}s-{plugin}-common-options>>.

17
docs/static/core-plugins/outputs/java-sink.asciidoc → docs/static/core-plugins/outputs/java_sink.asciidoc vendored
View file

@ -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 <<plugins-{type}s-{plugin}-common-options>>.

15
docs/static/core-plugins/outputs/java-stdout.asciidoc → docs/static/core-plugins/outputs/java_stdout.asciidoc vendored
View file

@ -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 <<plugins-{type}s-{plugin}-common-options>>.