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

Add sample doc files to plugin generator

Browse source 
Fixes #10029
This commit is contained in:
Karen Metts 2018-09-27 18:58:26 -04:00
parent 1f29c7145d
commit 67e62a9c00
4 changed files with 433 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

102
lib/pluginmanager/templates/codec-plugin/docs/index.asciidoc Normal file
View file

@ -0,0 +1,102 @@
:plugin: example
:type: codec
// Update header with plugin name
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
[id="plugins-{type}s-{plugin}"]
=== Example codec plugin
include::{include_path}/plugin_header.asciidoc[]
==== Description
Add plugin description here
// Format anchors and links to support generated ids for versioning
// Sample anchor: [id="plugins-{type}s-{plugin}-setting_name"]
// Sample link: <<plugins-{type}s-{plugin}-setting_name>>
[id="plugins-{type}s-{plugin}-options"]
==== Example Codec Configuration Options
[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-a_setting_name>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-another_setting_name>> |<<hash,hash>>|No
| <<plugins-{type}s-{plugin}-setting_name_3>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-setting_name_4>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-setting_name_5>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-setting_name_6>> |<<bytes,bytes>>|No
| <<plugins-{type}s-{plugin}-setting_name_7>> |<<path,path>>|No
|=======================================================================
[id="plugins-{type}s-{plugin}-a_setting_name"]
===== `a_setting_name`
* Value type is <<boolean,boolean>>
* Default value is `true`
Add description here
[id="plugins-{type}s-{plugin}-another_setting_name"]
===== `another_setting_name`
* Value type is <<hash,hash>>
* Default value is `{}`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_3"]
===== `setting_name_3`
* Value type is <<string,string>>
* Default value is `{}`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_4"]
===== `setting_name_4`
* Value type is <<number,number>>
* Default value is `0`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_5"]
===== `setting_name_5`
* Value type is <<array,array>>
* Default value is {}
Add description here
[id="plugins-{type}s-{plugin}-setting_name_6"]
===== `setting_name_6`
* Value type is <<bytes,bytes>>
* Default value is {}
Add description here
[id="plugins-{type}s-{plugin}-setting_name_7"]
===== `setting_name_7`
* Value type is <<path,path>>
* Default value is {}
Add description here
// The full list of Value Types is here:
// https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html

87
lib/pluginmanager/templates/filter-plugin/docs/index.asciidoc Normal file
View file

@ -0,0 +1,87 @@
:plugin: example
:type: filter
// Update header with plugin name
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
[id="plugins-{type}s-{plugin}"]
=== Example filter plugin
include::{include_path}/plugin_header.asciidoc[]
==== Description
Add plugin description here
// Format anchors and links to support generated ids for versioning
// Sample anchor: [id="plugins-{type}s-{plugin}-setting_name"]
// Sample link: <<plugins-{type}s-{plugin}-setting_name>>
[id="plugins-{type}s-{plugin}-options"]
==== Example Filter Configuration Options
[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-a_setting_name>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-another_setting_name>> |<<hash,hash>>|No
| <<plugins-{type}s-{plugin}-setting_name_3>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-setting_name_4>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-setting_name_5>> |<<array,array>>|No
|=======================================================================
[id="plugins-{type}s-{plugin}-a_setting_name"]
===== `a_setting_name`
* Value type is <<boolean,boolean>>
* Default value is `true`
Add description here
[id="plugins-{type}s-{plugin}-another_setting_name"]
===== `another_setting_name`
* Value type is <<hash,hash>>
* Default value is `{}`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_3"]
===== `setting_name_3`
* Value type is <<string,string>>
* Default value is `{}`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_4"]
===== `setting_name_4`
* Value type is <<number,number>>
* Default value is `0`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_5"]
===== `setting_name_5`
* Value type is <<array,array>>
* Default value is {}
Add description here
// The full list of Value Types is here:
// https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html
[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

117
lib/pluginmanager/templates/input-plugin/docs/index.asciidoc Normal file
View file

@ -0,0 +1,117 @@
:plugin: example
:type: input
:default_codec: plain
// Update header with plugin name and default codec
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
[id="plugins-{type}s-{plugin}"]
=== Example input plugin
include::{include_path}/plugin_header.asciidoc[]
==== Description
Add plugin description here
// Format anchors and links to support generated ids for versioning
// Sample anchor: [id="plugins-{type}s-{plugin}-setting_name"]
// Sample link: <<plugins-{type}s-{plugin}-setting_name>>
[id="plugins-{type}s-{plugin}-options"]
==== Example Input Configuration Options
[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-a_setting_name>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-another_setting_name>> |<<hash,hash>>|No
| <<plugins-{type}s-{plugin}-setting_name_3>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-setting_name_4>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-setting_name_5>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-setting_name_6>> |<<bytes,bytes>>|No
| <<plugins-{type}s-{plugin}-setting_name_7>> |<<path,path>>|No
| <<plugins-{type}s-{plugin}-setting_name_8>> |<<password,password>>|No
|=======================================================================
[id="plugins-{type}s-{plugin}-a_setting_name"]
===== `a_setting_name`
* Value type is <<boolean,boolean>>
* Default value is `true`
Add description here
[id="plugins-{type}s-{plugin}-another_setting_name"]
===== `another_setting_name`
* Value type is <<hash,hash>>
* Default value is `{}`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_3"]
===== `setting_name_3`
* Value type is <<string,string>>
* Default value is `{}`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_4"]
===== `setting_name_4`
* Value type is <<number,number>>
* Default value is `0`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_5"]
===== `setting_name_5`
* Value type is <<array,array>>
* Default value is {}
Add description here
[id="plugins-{type}s-{plugin}-setting_name_6"]
===== `setting_name_6`
* Value type is <<bytes,bytes>>
* Default value is {}
Add description here
[id="plugins-{type}s-{plugin}-setting_name_7"]
===== `setting_name_7`
* Value type is <<path,path>>
* Default value is {}
Add description here
[id="plugins-{type}s-{plugin}-setting_name_8"]
===== `setting_name_8`
* Value type is <<password,password>>
* Default value is {}
Add description here
// The full list of Value Types is here:
// https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html
[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]
:default_codec!:

127
lib/pluginmanager/templates/output-plugin/docs/index.asciidoc Normal file
View file

@ -0,0 +1,127 @@
:plugin: example
:type: output
:default_codec: plain
// Update header with plugin name and default codec
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
[id="plugins-{type}s-{plugin}"]
=== Example output plugin
include::{include_path}/plugin_header.asciidoc[]
==== Description
Add plugin description here
// Format anchors and links to support generated ids for versioning
// Sample anchor: [id="plugins-{type}s-{plugin}-setting_name"]
// Sample link: <<plugins-{type}s-{plugin}-setting_name>>
[id="plugins-{type}s-{plugin}-options"]
==== Example Output Configuration Options
[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-a_setting_name>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-another_setting_name>> |<<hash,hash>>|No
| <<plugins-{type}s-{plugin}-setting_name_3>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-setting_name_4>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-setting_name_5>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-setting_name_6>> |<<bytes,bytes>>|No
| <<plugins-{type}s-{plugin}-setting_name_7>> |<<path,path>>|No
| <<plugins-{type}s-{plugin}-setting_name_8>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-setting_name_9>> |<<uri,uri>>|No
|=======================================================================
[id="plugins-{type}s-{plugin}-a_setting_name"]
===== `a_setting_name`
* Value type is <<boolean,boolean>>
* Default value is `true`
Add description here
[id="plugins-{type}s-{plugin}-another_setting_name"]
===== `another_setting_name`
* Value type is <<hash,hash>>
* Default value is `{}`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_3"]
===== `setting_name_3`
* Value type is <<string,string>>
* Default value is `{}`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_4"]
===== `setting_name_4`
* Value type is <<number,number>>
* Default value is `0`
Add description here
[id="plugins-{type}s-{plugin}-setting_name_5"]
===== `setting_name_5`
* Value type is <<array,array>>
* Default value is {}
Add description here
[id="plugins-{type}s-{plugin}-setting_name_6"]
===== `setting_name_6`
* Value type is <<bytes,bytes>>
* Default value is {}
Add description here
[id="plugins-{type}s-{plugin}-setting_name_7"]
===== `setting_name_7`
* Value type is <<path,path>>
* Default value is {}
Add description here
[id="plugins-{type}s-{plugin}-setting_name_8"]
===== `setting_name_8`
* Value type is <<password,password>>
* Default value is {}
Add description here
[id="plugins-{type}s-{plugin}-setting_name_9"]
===== `setting_name_9`
* Value type is <<uri,uri>>
* Default value is {}
Add description here
// The full list of Value Types is here:
// https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html
[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]
:default_codec!: