Skip to content

[Work in progress] Versioned plugin doc fixes #445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

[Work in progress] Versioned plugin doc fixes #445

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dedf9e5
Create prototype of versioned plugin docs
dedemorton Nov 30, 2017
7b7eac6
remove examples
jsvd Jan 11, 2018
1190795
initial attempt at versioned plugin docs
jsvd Jan 11, 2018
3705235
make it simpler
jsvd Jan 11, 2018
af38a05
Fix errors round 1
dedemorton Jan 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions docs/versioned-plugins/codecs/cef-v4.1.3.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}-{plugin}"]
[id="{version}-plugins-{type}s-{plugin}"]
Copy link
Contributor Author

@dedemorton dedemorton Jan 14, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This problem is caused by bad asciidoc in older versions of the plugin.


=== Cef codec plugin {version}

Expand All @@ -33,22 +33,22 @@ produce an event with the payload as the 'message' field and a '_cefparsefailure
[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<{version}-plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-fields>> |<<array,array>>|No
| <<{version}-plugins-{type}s-{plugin}-name>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-product>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-severity>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-signature>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-vendor>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-version>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-delimiter>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
Copy link
Contributor Author

@dedemorton dedemorton Jan 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script needs to replace all type links so that they point to the Logstash Reference.

| <<{version}-plugins-{type}s-{plugin}-fields>> |{logstash-ref}/configuration-file-structure.html#array[array]|No
| <<{version}-plugins-{type}s-{plugin}-name>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-product>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-severity>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-signature>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-vendor>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-version>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
|=======================================================================

&nbsp;

[id="{version}-plugins-{type}s-{plugin}-delimiter"]
===== `delimiter`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* There is no default value for this setting.

If your input puts a delimiter between each CEF event, you'll want to set
Expand All @@ -72,7 +72,7 @@ This setting allows the following character sequences to have special meaning:
===== `deprecated_v1_fields` (DEPRECATED)

* DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
* Value type is <<boolean,boolean>>
* Value type is {logstash-ref}/configuration-file-structure.html#boolean[boolean]
* There is no default value for this setting.

Set this flag if you want to have both v1 and v2 fields indexed at the same time. Note that this option will increase
Expand All @@ -82,15 +82,15 @@ This option is available to ease transition to new schema
[id="{version}-plugins-{type}s-{plugin}-fields"]
===== `fields`

* Value type is <<array,array>>
* Value type is {logstash-ref}/configuration-file-structure.html#array[array]
* Default value is `[]`

Fields to be included in CEV extension part as key/value pairs

[id="{version}-plugins-{type}s-{plugin}-name"]
===== `name`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Logstash"`

Name field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -99,7 +99,7 @@ to help you build a new value from other parts of the event.
[id="{version}-plugins-{type}s-{plugin}-product"]
===== `product`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Logstash"`

Device product field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -109,7 +109,7 @@ to help you build a new value from other parts of the event.
===== `sev` (DEPRECATED)

* DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* There is no default value for this setting.

Deprecated severity field for CEF header. The new value can include `%{foo}` strings
Expand All @@ -124,7 +124,7 @@ All invalid values will be mapped to the default of 6.
[id="{version}-plugins-{type}s-{plugin}-severity"]
===== `severity`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"6"`

Severity field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -137,7 +137,7 @@ All invalid values will be mapped to the default of 6.
[id="{version}-plugins-{type}s-{plugin}-signature"]
===== `signature`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Logstash"`

Signature ID field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -146,7 +146,7 @@ to help you build a new value from other parts of the event.
[id="{version}-plugins-{type}s-{plugin}-vendor"]
===== `vendor`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Elasticsearch"`

Device vendor field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -155,7 +155,7 @@ to help you build a new value from other parts of the event.
[id="{version}-plugins-{type}s-{plugin}-version"]
===== `version`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"1.0"`

Device version field in CEF header. The new value can include `%{foo}` strings
Expand Down
36 changes: 18 additions & 18 deletions docs/versioned-plugins/codecs/cef-v4.1.4.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,22 +33,22 @@ produce an event with the payload as the 'message' field and a '_cefparsefailure
[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<{version}-plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-fields>> |<<array,array>>|No
| <<{version}-plugins-{type}s-{plugin}-name>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-product>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-severity>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-signature>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-vendor>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-version>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-delimiter>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-fields>> |{logstash-ref}/configuration-file-structure.html#array[array]|No
| <<{version}-plugins-{type}s-{plugin}-name>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-product>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-severity>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-signature>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-vendor>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-version>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
|=======================================================================

&nbsp;

[id="{version}-plugins-{type}s-{plugin}-delimiter"]
===== `delimiter`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* There is no default value for this setting.

If your input puts a delimiter between each CEF event, you'll want to set
Expand All @@ -72,7 +72,7 @@ This setting allows the following character sequences to have special meaning:
===== `deprecated_v1_fields` (DEPRECATED)

* DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
* Value type is <<boolean,boolean>>
* Value type is {logstash-ref}/configuration-file-structure.html#boolean[boolean]
* There is no default value for this setting.

Set this flag if you want to have both v1 and v2 fields indexed at the same time. Note that this option will increase
Expand All @@ -82,15 +82,15 @@ This option is available to ease transition to new schema
[id="{version}-plugins-{type}s-{plugin}-fields"]
===== `fields`

* Value type is <<array,array>>
* Value type is {logstash-ref}/configuration-file-structure.html#array[array]
* Default value is `[]`

Fields to be included in CEV extension part as key/value pairs

[id="{version}-plugins-{type}s-{plugin}-name"]
===== `name`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Logstash"`

Name field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -99,7 +99,7 @@ to help you build a new value from other parts of the event.
[id="{version}-plugins-{type}s-{plugin}-product"]
===== `product`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Logstash"`

Device product field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -109,7 +109,7 @@ to help you build a new value from other parts of the event.
===== `sev` (DEPRECATED)

* DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* There is no default value for this setting.

Deprecated severity field for CEF header. The new value can include `%{foo}` strings
Expand All @@ -124,7 +124,7 @@ All invalid values will be mapped to the default of 6.
[id="{version}-plugins-{type}s-{plugin}-severity"]
===== `severity`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"6"`

Severity field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -137,7 +137,7 @@ All invalid values will be mapped to the default of 6.
[id="{version}-plugins-{type}s-{plugin}-signature"]
===== `signature`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Logstash"`

Signature ID field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -146,7 +146,7 @@ to help you build a new value from other parts of the event.
[id="{version}-plugins-{type}s-{plugin}-vendor"]
===== `vendor`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Elasticsearch"`

Device vendor field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -155,7 +155,7 @@ to help you build a new value from other parts of the event.
[id="{version}-plugins-{type}s-{plugin}-version"]
===== `version`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"1.0"`

Device version field in CEF header. The new value can include `%{foo}` strings
Expand Down
36 changes: 18 additions & 18 deletions docs/versioned-plugins/codecs/cef-v5.0.0.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,22 +33,22 @@ produce an event with the payload as the 'message' field and a '_cefparsefailure
[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<{version}-plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-fields>> |<<array,array>>|No
| <<{version}-plugins-{type}s-{plugin}-name>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-product>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-severity>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-signature>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-vendor>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-version>> |<<string,string>>|No
| <<{version}-plugins-{type}s-{plugin}-delimiter>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-fields>> |{logstash-ref}/configuration-file-structure.html#array[array]|No
| <<{version}-plugins-{type}s-{plugin}-name>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-product>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-severity>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-signature>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-vendor>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
| <<{version}-plugins-{type}s-{plugin}-version>> |{logstash-ref}/configuration-file-structure.html#string[string]|No
|=======================================================================

&nbsp;

[id="{version}-plugins-{type}s-{plugin}-delimiter"]
===== `delimiter`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* There is no default value for this setting.

If your input puts a delimiter between each CEF event, you'll want to set
Expand All @@ -72,21 +72,21 @@ This setting allows the following character sequences to have special meaning:
===== `deprecated_v1_fields` (OBSOLETE)

* OBSOLETE WARNING: This configuration item is obsolete and will prevent the pipeline from starting if used
* Value type is <<boolean,boolean>>
* Value type is {logstash-ref}/configuration-file-structure.html#boolean[boolean]
* There is no default value for this setting.

[id="{version}-plugins-{type}s-{plugin}-fields"]
===== `fields`

* Value type is <<array,array>>
* Value type is {logstash-ref}/configuration-file-structure.html#array[array]
* Default value is `[]`

Fields to be included in CEV extension part as key/value pairs

[id="{version}-plugins-{type}s-{plugin}-name"]
===== `name`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Logstash"`

Name field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -95,7 +95,7 @@ to help you build a new value from other parts of the event.
[id="{version}-plugins-{type}s-{plugin}-product"]
===== `product`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Logstash"`

Device product field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -105,15 +105,15 @@ to help you build a new value from other parts of the event.
===== `sev` (OBSOLETE)

* OBSOLETE WARNING: This configuration item is obsolete and will prevent the pipeline from starting.
* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* There is no default value for this setting.

Obsolete severity field for CEF header use :severity instead.

[id="{version}-plugins-{type}s-{plugin}-severity"]
===== `severity`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"6"`

Severity field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -126,7 +126,7 @@ All invalid values will be mapped to the default of 6.
[id="{version}-plugins-{type}s-{plugin}-signature"]
===== `signature`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Logstash"`

Signature ID field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -135,7 +135,7 @@ to help you build a new value from other parts of the event.
[id="{version}-plugins-{type}s-{plugin}-vendor"]
===== `vendor`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"Elasticsearch"`

Device vendor field in CEF header. The new value can include `%{foo}` strings
Expand All @@ -144,7 +144,7 @@ to help you build a new value from other parts of the event.
[id="{version}-plugins-{type}s-{plugin}-version"]
===== `version`

* Value type is <<string,string>>
* Value type is {logstash-ref}/configuration-file-structure.html#string[string]
* Default value is `"1.0"`

Device version field in CEF header. The new value can include `%{foo}` strings
Expand Down
Loading