Skip to content

Commit 16d68a5

Browse files
authored
Doc: Add plugin name attribute (#415)
Allow for attributes in code samples Bump to v.6.1.2
1 parent 3d0e175 commit 16d68a5

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 6.1.2
2+
- [DOC] Added naming attribute to control plugin name that appears in docs, and set up framework to make attributes viable in code sample
3+
14
## 6.1.1
25
- [DOC] Enhanced ECS compatibility information for ease of use and readability
36
[#413](https://github.com/logstash-plugins/logstash-input-beats/pull/413)

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
6.1.1
1+
6.1.2

docs/index.asciidoc

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
:plugin: beats
22
:type: input
33
:default_codec: plain
4+
:plugin-uc: Beats
45

56
///////////////////////////////////////////
67
START - GENERATED VARIABLES, DO NOT EDIT!
@@ -15,7 +16,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!
1516

1617
[id="plugins-{type}s-{plugin}"]
1718

18-
=== Beats input plugin
19+
=== {plugin-uc} input plugin
1920

2021
include::{include_path}/plugin_header.asciidoc[]
2122

@@ -25,9 +26,9 @@ This input plugin enables Logstash to receive events from the
2526
https://www.elastic.co/products/beats[Elastic Beats] framework.
2627

2728
The following example shows how to configure Logstash to listen on port
28-
5044 for incoming Beats connections and to index into Elasticsearch.
29+
5044 for incoming {plugin-uc} connections and to index into Elasticsearch.
2930

30-
[source,logstash]
31+
["source","sh",subs="attributes"]
3132
-----
3233
3334
input {
@@ -45,16 +46,16 @@ output {
4546
-----
4647
<1> `%{[@metadata][beat]}` sets the first part of the index name to the value
4748
of the `beat` metadata field and `%{[@metadata][version]}` sets the second part to
48-
the Beat's version. For example:
49+
the {plugin-uc}'s version. For example:
4950
metricbeat-7.4.0.
5051

5152
Events indexed into Elasticsearch with the Logstash configuration shown here
52-
will be similar to events directly indexed by Beats into Elasticsearch.
53+
will be similar to events directly indexed by {plugin-uc} into Elasticsearch.
5354

5455
NOTE: If ILM is not being used, set `index` to
5556
`%{[@metadata][beat]}-%{[@metadata][version]}-%{+YYYY.MM.dd}` instead so
5657
Logstash creates an index per day, based on the `@timestamp` value of the events
57-
coming from Beats.
58+
coming from {plugin-uc}.
5859

5960
IMPORTANT: If you are shipping events that span multiple lines, you need to use
6061
the {filebeat-ref}/multiline-examples.html[configuration options available in
@@ -64,7 +65,7 @@ plugin] to handle multiline events. Doing so will result in the failure to start
6465
Logstash.
6566

6667
[id="plugins-{type}s-{plugin}-versioned-indexes"]
67-
==== Versioned Beats Indices
68+
==== Versioned indices
6869

6970
To minimize the impact of future schema changes on your existing indices and
7071
mappings in Elasticsearch, configure the Elasticsearch output to write to
@@ -89,10 +90,14 @@ This configuration results in daily index names like
8990

9091
[id="plugins-{type}s-{plugin}-ecs_metadata"]
9192
==== Event Metadata and the Elastic Common Schema (ECS)
92-
When decoding `beats` events, this plugin adds two fields related to the event: the deprecated `host`
93-
which contains the `hostname` provided by beats and the `ip_address` containing the remote address
94-
of the client's connection. When <<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> is
95-
enabled these are now moved in ECS compatible namespace. Here's how <<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> affects output.
93+
94+
When decoding {plugin-uc} events, this plugin adds two fields related to the event:
95+
the deprecated `host` which contains the `hostname` provided by {plugin-uc} and the
96+
`ip_address` containing the remote address of the client's connection. When
97+
<<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> is enabled
98+
these are now moved in ECS compatible namespace. Here's how
99+
<<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> affects
100+
output.
96101

97102
[cols="<l,<l,e,<e"]
98103
|=======================================================================
@@ -107,7 +112,7 @@ enabled these are now moved in ECS compatible namespace. Here's how <<plugins-{t
107112
|=======================================================================
108113

109114
[id="plugins-{type}s-{plugin}-options"]
110-
==== Beats Input Configuration Options
115+
==== {plugin-uc} Input Configuration Options
111116

112117
This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
113118

0 commit comments

Comments
 (0)