logstash-codec-cef 6.0.0-java → 6.2.0-java
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +122 -8
- data/lib/logstash/codecs/cef.rb +350 -156
- data/lib/logstash/codecs/cef/timestamp_normalizer.rb +115 -0
- data/logstash-codec-cef.gemspec +3 -1
- data/spec/codecs/cef/timestamp_normalizer_spec.rb +274 -0
- data/spec/codecs/cef_spec.rb +484 -288
- metadata +33 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 25264d450cdfa027ac9758a05972c0c87119a635238b9bacfc746e4daec40dff
|
|
4
|
+
data.tar.gz: 63dbd8558c231e61c9e55962484042a52c28177cba5b4adcf4d49291aace491a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 62ac45d798abaf3008f99357b578506237bddc024904951cab64bdb36fd61f1c91894e4e70f2ce6a911fde46c4d1a15c69a1368b2a0dd69a6f509e09e8ee8192
|
|
7
|
+
data.tar.gz: 46dd75f39b72ae788dfcd29f21810be7086bb16cb1984f81f50a786682d66f06f7e6a2ee543f3e88a3e8951da5680f99fdcd45d28e606c16171d34bc30ceb4a4
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
## 6.2.0
|
|
2
|
+
- Introduce ECS Compatibility mode [#83](https://github.com/logstash-plugins/logstash-codec-cef/pull/83).
|
|
3
|
+
|
|
4
|
+
## 6.1.2
|
|
5
|
+
- Added error log with full payload when something bad happens in decoding a message[#84](https://github.com/logstash-plugins/logstash-codec-cef/pull/84)
|
|
6
|
+
|
|
7
|
+
## 6.1.1
|
|
8
|
+
- Improved encoding performance, especially when encoding many extension fields [#81](https://github.com/logstash-plugins/logstash-codec-cef/pull/81)
|
|
9
|
+
|
|
10
|
+
## 6.1.0
|
|
11
|
+
- Fixed CEF short to long name translation for ahost/agentHostName field, according to documentation [#75](https://github.com/logstash-plugins/logstash-codec-cef/pull/75)
|
|
12
|
+
|
|
13
|
+
## 6.0.1
|
|
14
|
+
- Fixed support for deep dot notation [#73](https://github.com/logstash-plugins/logstash-codec-cef/pull/73)
|
|
15
|
+
|
|
1
16
|
## 6.0.0
|
|
2
17
|
- Removed obsolete `sev` and `deprecated_v1_fields` fields
|
|
3
18
|
|
data/LICENSE
CHANGED
|
@@ -1,13 +1,202 @@
|
|
|
1
|
-
Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
6
5
|
|
|
7
|
-
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
7
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2020 Elastic and contributors
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Logstash Plugin
|
|
2
2
|
|
|
3
|
-
[](https://travis-ci.com/logstash-plugins/logstash-codec-cef)
|
|
4
4
|
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
|
@@ -27,14 +27,53 @@ https://community.saas.hpe.com/dcvta86296/attachments/dcvta86296/connector-docum
|
|
|
27
27
|
If this codec receives a payload from an input that is not a valid CEF message, then it will
|
|
28
28
|
produce an event with the payload as the 'message' field and a '_cefparsefailure' tag.
|
|
29
29
|
|
|
30
|
+
==== Compatibility with the Elastic Common Schema (ECS)
|
|
31
|
+
|
|
32
|
+
This plugin can be used to decode CEF events _into_ the Elastic Common Schema, or to encode ECS-compatible events into CEF.
|
|
33
|
+
It can also be used _without_ ECS, encoding and decoding events using only CEF-defined field names and keys.
|
|
34
|
+
|
|
35
|
+
The ECS Compatibility mode for a specific plugin instance can be controlled by setting <<plugins-{type}s-{plugin}-ecs_compatibility>> when defining the codec:
|
|
36
|
+
|
|
37
|
+
[source,sh]
|
|
38
|
+
-----
|
|
39
|
+
input {
|
|
40
|
+
tcp {
|
|
41
|
+
# ...
|
|
42
|
+
codec => cef {
|
|
43
|
+
ecs_compatibility => v1
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
-----
|
|
48
|
+
|
|
49
|
+
If left unspecified, the value of the `pipeline.ecs_compatibility` setting is used.
|
|
50
|
+
|
|
51
|
+
===== Timestamps and ECS Compatiblity
|
|
52
|
+
|
|
53
|
+
When running in ECS Compatibility Mode, timestamp-type fields are parsed and normalized
|
|
54
|
+
to specific points on the timeline.
|
|
55
|
+
|
|
56
|
+
Because the CEF format allows ambiguous timestamp formats, some reasonable assumptions are made:
|
|
57
|
+
|
|
58
|
+
- When the timestamp does not include a year, we assume it happened in the recent past
|
|
59
|
+
(or _very_ near future to accommodate out-of-sync clocks and timezone offsets).
|
|
60
|
+
- When the timestamp does not include UTC-offset information, we use the event's
|
|
61
|
+
timezone (`dtz` or `deviceTimeZone` field), or fall through to this plugin's
|
|
62
|
+
<<plugins-{type}s-{plugin}-default_timezone>>.
|
|
63
|
+
- Localized timestamps are parsed using the provided <<plugins-{type}s-{plugin}-locale>>.
|
|
64
|
+
|
|
30
65
|
[id="plugins-{type}s-{plugin}-options"]
|
|
31
66
|
==== Cef Codec Configuration Options
|
|
32
67
|
|
|
33
68
|
[cols="<,<,<",options="header",]
|
|
34
69
|
|=======================================================================
|
|
35
70
|
|Setting |Input type|Required
|
|
71
|
+
| <<plugins-{type}s-{plugin}-default_timezone>> |<<string,string>>|No
|
|
36
72
|
| <<plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
|
|
73
|
+
| <<plugins-{type}s-{plugin}-device>> |<<string,string>>|No
|
|
74
|
+
| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
|
|
37
75
|
| <<plugins-{type}s-{plugin}-fields>> |<<array,array>>|No
|
|
76
|
+
| <<plugins-{type}s-{plugin}-locale>> |<<string,string>>|No
|
|
38
77
|
| <<plugins-{type}s-{plugin}-name>> |<<string,string>>|No
|
|
39
78
|
| <<plugins-{type}s-{plugin}-product>> |<<string,string>>|No
|
|
40
79
|
| <<plugins-{type}s-{plugin}-reverse_mapping>> |<<boolean,boolean>>|No
|
|
@@ -46,6 +85,21 @@ produce an event with the payload as the 'message' field and a '_cefparsefailure
|
|
|
46
85
|
|
|
47
86
|
|
|
48
87
|
|
|
88
|
+
[id="plugins-{type}s-{plugin}-default_timezone"]
|
|
89
|
+
===== `default_timezone`
|
|
90
|
+
|
|
91
|
+
* Value type is <<string,string>>
|
|
92
|
+
* Supported values are:
|
|
93
|
+
** https://en.wikipedia.org/wiki/List_of_tz_database_time_zones[Timezone names] (such as `Europe/Moscow`, `America/Argentina/Buenos_Aires`)
|
|
94
|
+
** UTC Offsets (such as `-08:00`, `+03:00`)
|
|
95
|
+
* The default value is your system time zone
|
|
96
|
+
* This option has no effect when _encoding_.
|
|
97
|
+
|
|
98
|
+
When parsing timestamp fields in ECS mode and encountering timestamps that
|
|
99
|
+
do not contain UTC-offset information, the `deviceTimeZone` (`dtz`) field
|
|
100
|
+
from the CEF payload is used to interpret the given time. If the event does
|
|
101
|
+
not include timezone information, this `default_timezone` is used instead.
|
|
102
|
+
|
|
49
103
|
[id="plugins-{type}s-{plugin}-delimiter"]
|
|
50
104
|
===== `delimiter`
|
|
51
105
|
|
|
@@ -69,21 +123,71 @@ This setting allows the following character sequences to have special meaning:
|
|
|
69
123
|
* `\\r` (backslash "r") - means carriage return (ASCII 0x0D)
|
|
70
124
|
* `\\n` (backslash "n") - means newline (ASCII 0x0A)
|
|
71
125
|
|
|
126
|
+
[id="plugins-{type}s-{plugin}-device"]
|
|
127
|
+
===== `device`
|
|
128
|
+
|
|
129
|
+
* Value type is <<string,string>>
|
|
130
|
+
* Supported values are:
|
|
131
|
+
** `observer`: indicates that device-specific fields represent the device used to _observe_ the event.
|
|
132
|
+
** `host`: indicates that device-specific fields represent the device on which the event _occurred_.
|
|
133
|
+
* The default value for this setting is `observer`.
|
|
134
|
+
* Option has no effect when <<plugins-{type}s-{plugin}-ecs_compatibility,`ecs_compatibility => disabled`>>.
|
|
135
|
+
* Option has no effect when _encoding_
|
|
136
|
+
|
|
137
|
+
Defines a set of device-specific CEF fields as either representing the device on which an
|
|
138
|
+
event _occurred_, or merely the device from which the event was _observed_.
|
|
139
|
+
This causes the relevant fields to be routed to either the `host` or the `observer`
|
|
140
|
+
top-level groupings.
|
|
141
|
+
|
|
142
|
+
If the codec handles data from a variety of sources, the ECS recommendation is to use `observer`.
|
|
143
|
+
|
|
144
|
+
[id="plugins-{type}s-{plugin}-ecs_compatibility"]
|
|
145
|
+
===== `ecs_compatibility`
|
|
146
|
+
|
|
147
|
+
* Value type is <<string,string>>
|
|
148
|
+
* Supported values are:
|
|
149
|
+
** `disabled`: uses CEF-defined field names in the event (e.g., `bytesIn`, `sourceAddress`)
|
|
150
|
+
** `v1`: supports ECS-compatible event fields (e.g., `[source][bytes]`, `[source][ip]`)
|
|
151
|
+
* Default value depends on which version of Logstash is running:
|
|
152
|
+
** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
|
|
153
|
+
** Otherwise, the default value is `disabled`.
|
|
154
|
+
|
|
155
|
+
Controls this plugin's compatibility with the
|
|
156
|
+
{ecs-ref}[Elastic Common Schema (ECS)]
|
|
157
|
+
(ECS)].
|
|
158
|
+
|
|
72
159
|
[id="plugins-{type}s-{plugin}-fields"]
|
|
73
160
|
===== `fields`
|
|
74
161
|
|
|
75
162
|
* Value type is <<array,array>>
|
|
76
163
|
* Default value is `[]`
|
|
164
|
+
* Option has no effect when _decoding_
|
|
165
|
+
|
|
166
|
+
When this codec is used in an Output Plugin, a list of fields can be provided to be included in CEF extensions part as key/value pairs.
|
|
77
167
|
|
|
78
|
-
|
|
168
|
+
[id="plugins-{type}s-{plugin}-locale"]
|
|
169
|
+
===== `locale`
|
|
170
|
+
|
|
171
|
+
* Value type is <<string,string>>
|
|
172
|
+
* Supported values are:
|
|
173
|
+
** Abbreviated language_COUNTRY format (e.g., `en_GB`, `pt_BR`)
|
|
174
|
+
** Valid https://tools.ietf.org/html/bcp47[IETF BCP 47] language tag (e.g., `zh-cmn-Hans-CN`)
|
|
175
|
+
* The default value is your system locale
|
|
176
|
+
* Option has no effect when _encoding_
|
|
177
|
+
|
|
178
|
+
When parsing timestamp fields in ECS mode and encountering timestamps in
|
|
179
|
+
a localized format, this `locale` is used to interpret locale-specific strings
|
|
180
|
+
such as month abbreviations.
|
|
79
181
|
|
|
80
182
|
[id="plugins-{type}s-{plugin}-name"]
|
|
81
183
|
===== `name`
|
|
82
184
|
|
|
83
185
|
* Value type is <<string,string>>
|
|
84
186
|
* Default value is `"Logstash"`
|
|
187
|
+
* Option has no effect when _decoding_
|
|
85
188
|
|
|
86
|
-
|
|
189
|
+
When this codec is used in an Output Plugin, this option can be used to specify the
|
|
190
|
+
value of the name field in the CEF header. The new value can include `%{foo}` strings
|
|
87
191
|
to help you build a new value from other parts of the event.
|
|
88
192
|
|
|
89
193
|
[id="plugins-{type}s-{plugin}-product"]
|
|
@@ -91,8 +195,10 @@ to help you build a new value from other parts of the event.
|
|
|
91
195
|
|
|
92
196
|
* Value type is <<string,string>>
|
|
93
197
|
* Default value is `"Logstash"`
|
|
198
|
+
* Option has no effect when _decoding_
|
|
94
199
|
|
|
95
|
-
|
|
200
|
+
When this codec is used in an Output Plugin, this option can be used to specify the
|
|
201
|
+
value of the device product field in CEF header. The new value can include `%{foo}` strings
|
|
96
202
|
to help you build a new value from other parts of the event.
|
|
97
203
|
|
|
98
204
|
|
|
@@ -101,6 +207,7 @@ to help you build a new value from other parts of the event.
|
|
|
101
207
|
|
|
102
208
|
* Value type is <<boolean,boolean>>
|
|
103
209
|
* Default value is `false`
|
|
210
|
+
* Option has no effect when _decoding_
|
|
104
211
|
|
|
105
212
|
Set to true to adhere to the specifications and encode using the CEF key name (short name) for the CEF field names.
|
|
106
213
|
|
|
@@ -109,8 +216,10 @@ Set to true to adhere to the specifications and encode using the CEF key name (s
|
|
|
109
216
|
|
|
110
217
|
* Value type is <<string,string>>
|
|
111
218
|
* Default value is `"6"`
|
|
219
|
+
* Option has no effect when _decoding_
|
|
112
220
|
|
|
113
|
-
|
|
221
|
+
When this codec is used in an Output Plugin, this option can be used to specify the
|
|
222
|
+
value of the severity field in CEF header. The new value can include `%{foo}` strings
|
|
114
223
|
to help you build a new value from other parts of the event.
|
|
115
224
|
|
|
116
225
|
Defined as field of type string to allow sprintf. The value will be validated
|
|
@@ -122,8 +231,10 @@ All invalid values will be mapped to the default of 6.
|
|
|
122
231
|
|
|
123
232
|
* Value type is <<string,string>>
|
|
124
233
|
* Default value is `"Logstash"`
|
|
234
|
+
* Option has no effect when _decoding_
|
|
125
235
|
|
|
126
|
-
|
|
236
|
+
When this codec is used in an Output Plugin, this option can be used to specify the
|
|
237
|
+
value of the signature ID field in CEF header. The new value can include `%{foo}` strings
|
|
127
238
|
to help you build a new value from other parts of the event.
|
|
128
239
|
|
|
129
240
|
[id="plugins-{type}s-{plugin}-vendor"]
|
|
@@ -131,8 +242,10 @@ to help you build a new value from other parts of the event.
|
|
|
131
242
|
|
|
132
243
|
* Value type is <<string,string>>
|
|
133
244
|
* Default value is `"Elasticsearch"`
|
|
245
|
+
* Option has no effect when _decoding_
|
|
134
246
|
|
|
135
|
-
|
|
247
|
+
When this codec is used in an Output Plugin, this option can be used to specify the
|
|
248
|
+
value of the device vendor field in CEF header. The new value can include `%{foo}` strings
|
|
136
249
|
to help you build a new value from other parts of the event.
|
|
137
250
|
|
|
138
251
|
[id="plugins-{type}s-{plugin}-version"]
|
|
@@ -140,8 +253,9 @@ to help you build a new value from other parts of the event.
|
|
|
140
253
|
|
|
141
254
|
* Value type is <<string,string>>
|
|
142
255
|
* Default value is `"1.0"`
|
|
256
|
+
* Option has no effect when _decoding_
|
|
143
257
|
|
|
144
|
-
|
|
258
|
+
When this codec is used in an Output Plugin, this option can be used to specify the
|
|
259
|
+
value of the device version field in CEF header. The new value can include `%{foo}` strings
|
|
145
260
|
to help you build a new value from other parts of the event.
|
|
146
261
|
|
|
147
|
-
|