| 
 | 1 | +:plugin: example  | 
 | 2 | +:type: input  | 
 | 3 | +:default_codec: plain  | 
 | 4 | +// Update header with plugin name and default codec  | 
 | 5 | + | 
 | 6 | +///////////////////////////////////////////  | 
 | 7 | +START - GENERATED VARIABLES, DO NOT EDIT!  | 
 | 8 | +///////////////////////////////////////////  | 
 | 9 | +:version: %VERSION%  | 
 | 10 | +:release_date: %RELEASE_DATE%  | 
 | 11 | +:changelog_url: %CHANGELOG_URL%  | 
 | 12 | +:include_path: ../../../../logstash/docs/include  | 
 | 13 | +///////////////////////////////////////////  | 
 | 14 | +END - GENERATED VARIABLES, DO NOT EDIT!  | 
 | 15 | +///////////////////////////////////////////  | 
 | 16 | + | 
 | 17 | +[id="plugins-{type}s-{plugin}"]  | 
 | 18 | + | 
 | 19 | +=== Example input plugin  | 
 | 20 | + | 
 | 21 | +include::{include_path}/plugin_header.asciidoc[]  | 
 | 22 | + | 
 | 23 | +==== Description  | 
 | 24 | + | 
 | 25 | +Add plugin description here  | 
 | 26 | + | 
 | 27 | +// Format anchors and links to support generated ids for versioning  | 
 | 28 | +// Sample anchor: [id="plugins-{type}s-{plugin}-setting_name"]  | 
 | 29 | +// Sample link: <<plugins-{type}s-{plugin}-setting_name>>  | 
 | 30 | + | 
 | 31 | +[id="plugins-{type}s-{plugin}-options"]  | 
 | 32 | +==== Example Input Configuration Options  | 
 | 33 | + | 
 | 34 | +[cols="<,<,<",options="header",]  | 
 | 35 | +|=======================================================================  | 
 | 36 | +|Setting |Input type|Required  | 
 | 37 | +| <<plugins-{type}s-{plugin}-a_setting_name>> |<<boolean,boolean>>|No  | 
 | 38 | +| <<plugins-{type}s-{plugin}-another_setting_name>> |<<hash,hash>>|No  | 
 | 39 | +| <<plugins-{type}s-{plugin}-setting_name_3>> |<<string,string>>|No  | 
 | 40 | +| <<plugins-{type}s-{plugin}-setting_name_4>> |<<number,number>>|No  | 
 | 41 | +| <<plugins-{type}s-{plugin}-setting_name_5>> |<<array,array>>|No  | 
 | 42 | +| <<plugins-{type}s-{plugin}-setting_name_6>> |<<bytes,bytes>>|No  | 
 | 43 | +| <<plugins-{type}s-{plugin}-setting_name_7>> |<<path,path>>|No  | 
 | 44 | +| <<plugins-{type}s-{plugin}-setting_name_8>> |<<password,password>>|No  | 
 | 45 | +|=======================================================================  | 
 | 46 | + | 
 | 47 | +[id="plugins-{type}s-{plugin}-a_setting_name"]  | 
 | 48 | +===== `a_setting_name`   | 
 | 49 | + | 
 | 50 | +  * Value type is <<boolean,boolean>>  | 
 | 51 | +  * Default value is `true`  | 
 | 52 | + | 
 | 53 | +Add description here  | 
 | 54 | + | 
 | 55 | +[id="plugins-{type}s-{plugin}-another_setting_name"]  | 
 | 56 | +===== `another_setting_name`   | 
 | 57 | + | 
 | 58 | +  * Value type is <<hash,hash>>  | 
 | 59 | +  * Default value is `{}`  | 
 | 60 | + | 
 | 61 | +Add description here  | 
 | 62 | + | 
 | 63 | +[id="plugins-{type}s-{plugin}-setting_name_3"]  | 
 | 64 | +===== `setting_name_3`   | 
 | 65 | + | 
 | 66 | +  * Value type is <<string,string>>  | 
 | 67 | +  * Default value is `{}`  | 
 | 68 | + | 
 | 69 | +Add description here  | 
 | 70 | + | 
 | 71 | +[id="plugins-{type}s-{plugin}-setting_name_4"]  | 
 | 72 | +===== `setting_name_4`   | 
 | 73 | + | 
 | 74 | +  * Value type is <<number,number>>  | 
 | 75 | +  * Default value is `0`  | 
 | 76 | + | 
 | 77 | +Add description here  | 
 | 78 | + | 
 | 79 | +[id="plugins-{type}s-{plugin}-setting_name_5"]  | 
 | 80 | +===== `setting_name_5`   | 
 | 81 | + | 
 | 82 | +  * Value type is <<array,array>>  | 
 | 83 | +  * Default value is {}  | 
 | 84 | + | 
 | 85 | +Add description here  | 
 | 86 | + | 
 | 87 | +[id="plugins-{type}s-{plugin}-setting_name_6"]  | 
 | 88 | +===== `setting_name_6`   | 
 | 89 | + | 
 | 90 | +  * Value type is <<bytes,bytes>>  | 
 | 91 | +  * Default value is {}  | 
 | 92 | + | 
 | 93 | +Add description here  | 
 | 94 | + | 
 | 95 | +[id="plugins-{type}s-{plugin}-setting_name_7"]  | 
 | 96 | +===== `setting_name_7`   | 
 | 97 | + | 
 | 98 | +  * Value type is <<path,path>>  | 
 | 99 | +  * Default value is {}  | 
 | 100 | + | 
 | 101 | +Add description here  | 
 | 102 | + | 
 | 103 | +[id="plugins-{type}s-{plugin}-setting_name_8"]  | 
 | 104 | +===== `setting_name_8`   | 
 | 105 | + | 
 | 106 | +  * Value type is <<password,password>>  | 
 | 107 | +  * Default value is {}  | 
 | 108 | + | 
 | 109 | +Add description here  | 
 | 110 | + | 
 | 111 | +// The full list of Value Types is here:   | 
 | 112 | +// https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html  | 
 | 113 | + | 
 | 114 | +[id="plugins-{type}s-{plugin}-common-options"]  | 
 | 115 | +include::{include_path}/{type}.asciidoc[]  | 
 | 116 | + | 
 | 117 | +:default_codec!:  | 
0 commit comments