logstash-filter-syslog_pri 3.0.3 → 3.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 0dfa21ec29ed49ce878e9d5e62ad9259c005f6e0
4
- data.tar.gz: 5a4500bfa268f4b3ef4feb9855982e94c876a464
2
+ SHA256:
3
+ metadata.gz: c3e7172aa14a0a1ac779c183aadb366d15d30e027c7f266aa6ca2dd228aab38e
4
+ data.tar.gz: 3e3274f72b800eb2096d0ba879c4fc17ea42dcee9bdf8de42d646b5de01f9071
5
5
  SHA512:
6
- metadata.gz: 1e26686946b8acce13d9edf8eccc915ea60d885b93e590263aa2f9be5222707206b440e678faf289768360b122191be1a6863f227fbf7a8aab0c6dbdc0e10549
7
- data.tar.gz: 450d1e9f23fb1b0a2e5f24f15920b944412bece282c0af4b356e15ef23858a535370e5b6341754faa96397c7f9b1a298ca2a0f666be118116db2979cdff67636
6
+ metadata.gz: 3ed38b2e8905864b009f31d9c7482b0316c88e83cf0704015af1af15c2d4c0f39525b7f500c99ad6f8d69464df77753356fdc36680b48b99284e4a0d761309d1
7
+ data.tar.gz: a78e217a3defc39b436297e37446754ce024685a83bab05e85c3e382e6b1c7901aeb2bb6ae5e945963519793ad81ae391087cb718cacaaf4a2c2f324c5b124f4
data/CHANGELOG.md CHANGED
@@ -1,16 +1,31 @@
1
+ ## 3.1.1
2
+ - Added preview of ECS-v8 support with existing ECS-v1 implementation [#10](https://github.com/logstash-plugins/logstash-filter-syslog_pri/pull/10)
3
+
4
+ ## 3.1.0
5
+ - Feat: ECS compatibility [#9](https://github.com/logstash-plugins/logstash-filter-syslog_pri/pull/9)
6
+
7
+ ## 3.0.5
8
+ - Update gemspec summary
9
+
10
+ ## 3.0.4
11
+ - Fix some documentation issues
12
+
1
13
  ## 3.0.2
2
14
  - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
3
15
 
4
16
  ## 3.0.1
5
17
  - Republish all the gems under jruby.
18
+
6
19
  ## 3.0.0
7
20
  - Update the plugin to the version 2.0 of the plugin api, this change is required for Logstash 5.0 compatibility. See https://github.com/elastic/logstash/issues/5141
8
- # 2.0.4
21
+
22
+ ## 2.0.4
9
23
  - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
10
- # 2.0.3
24
+
25
+ ## 2.0.3
11
26
  - New dependency requirements for logstash-core for the 5.0 release
27
+
12
28
  ## 2.0.0
13
29
  - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
14
30
  instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
15
31
  - Dependency on logstash-core update to 2.0
16
-
data/LICENSE CHANGED
@@ -1,13 +1,202 @@
1
- Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
2
1
 
3
- Licensed under the Apache License, Version 2.0 (the "License");
4
- you may not use this file except in compliance with the License.
5
- You may obtain a copy of the License at
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
6
5
 
7
- http://www.apache.org/licenses/LICENSE-2.0
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
7
 
9
- Unless required by applicable law or agreed to in writing, software
10
- distributed under the License is distributed on an "AS IS" BASIS,
11
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- See the License for the specific language governing permissions and
13
- limitations under the License.
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
- [![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-syslog_pri.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-syslog_pri)
3
+ [![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-syslog_pri.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-syslog_pri)
4
4
 
5
5
  This is a plugin for [Logstash](https://github.com/elastic/logstash).
6
6
 
data/docs/index.asciidoc CHANGED
@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
12
12
  END - GENERATED VARIABLES, DO NOT EDIT!
13
13
  ///////////////////////////////////////////
14
14
 
15
- [id="plugins-{type}-{plugin}"]
15
+ [id="plugins-{type}s-{plugin}"]
16
16
 
17
17
  === Syslog_pri filter plugin
18
18
 
@@ -35,6 +35,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
35
35
  [cols="<,<,<",options="header",]
36
36
  |=======================================================================
37
37
  |Setting |Input type|Required
38
+ | <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
38
39
  | <<plugins-{type}s-{plugin}-facility_labels>> |<<array,array>>|No
39
40
  | <<plugins-{type}s-{plugin}-severity_labels>> |<<array,array>>|No
40
41
  | <<plugins-{type}s-{plugin}-syslog_pri_field_name>> |<<string,string>>|No
@@ -46,6 +47,20 @@ filter plugins.
46
47
 
47
48
  &nbsp;
48
49
 
50
+ [id="plugins-{type}s-{plugin}-ecs_compatibility"]
51
+ ===== `ecs_compatibility`
52
+
53
+ * Value type is <<string,string>>
54
+ * Supported values are:
55
+ ** `disabled`: does not use ECS-compatible field names (for example, `syslog_severity_code` for syslog severity)
56
+ ** `v1`, `v8`: uses fields that are compatible with Elastic Common Schema (for example, `[log][syslog][severity][code]`)
57
+ * Default value depends on which version of Logstash is running:
58
+ ** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
59
+ ** Otherwise, the default value is `disabled`.
60
+
61
+ Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
62
+ The value of this setting affects the _default_ value of <<plugins-{type}s-{plugin}-syslog_pri_field_name>>.
63
+
49
64
  [id="plugins-{type}s-{plugin}-facility_labels"]
50
65
  ===== `facility_labels`
51
66
 
@@ -66,7 +81,9 @@ Labels for severity levels. This comes from RFC3164.
66
81
  ===== `syslog_pri_field_name`
67
82
 
68
83
  * Value type is <<string,string>>
69
- * Default value is `"syslog_pri"`
84
+ * Default value depends on whether <<plugins-{type}s-{plugin}-ecs_compatibility>> is enabled:
85
+ ** ECS Compatibility disabled: `"syslog_pri"`
86
+ ** ECS Compatibility enabled: `"[log][syslog][priority]"`
70
87
 
71
88
  Name of field which passes in the extracted PRI part of the syslog message
72
89
 
@@ -5,10 +5,10 @@ require "logstash/namespace"
5
5
  # Filter plugin for logstash to parse the `PRI` field from the front
6
6
  # of a Syslog (RFC3164) message. If no priority is set, it will
7
7
  # default to 13 (per RFC).
8
- #
9
- # This filter is based on the original `syslog.rb` code shipped
10
- # with logstash.
11
8
  class LogStash::Filters::Syslog_pri < LogStash::Filters::Base
9
+
10
+ include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
11
+
12
12
  config_name "syslog_pri"
13
13
 
14
14
  # set the status to experimental/beta/stable
@@ -17,7 +17,8 @@ class LogStash::Filters::Syslog_pri < LogStash::Filters::Base
17
17
  config :use_labels, :validate => :boolean, :default => true
18
18
 
19
19
  # Name of field which passes in the extracted PRI part of the syslog message
20
- config :syslog_pri_field_name, :validate => :string, :default => "syslog_pri"
20
+ # default: 'syslog_pri' or '[log][syslog][priority]' with ECS
21
+ config :syslog_pri_field_name, :validate => :string
21
22
 
22
23
  # Labels for facility levels. This comes from RFC3164.
23
24
  config :facility_labels, :validate => :array, :default => [
@@ -59,48 +60,56 @@ class LogStash::Filters::Syslog_pri < LogStash::Filters::Base
59
60
  "debug",
60
61
  ]
61
62
 
62
- public
63
+ def initialize(*params)
64
+ super
65
+
66
+ @facility_code_key = ecs_select[disabled:'syslog_facility_code', v1:'[log][syslog][facility][code]']
67
+ @severity_code_key = ecs_select[disabled:'syslog_severity_code', v1:'[log][syslog][severity][code]']
68
+
69
+ @facility_label_key = ecs_select[disabled:'syslog_facility', v1:'[log][syslog][facility][name]']
70
+ @severity_label_key = ecs_select[disabled:'syslog_severity', v1:'[log][syslog][severity][name]']
71
+
72
+ # config parameter default:
73
+ @syslog_pri_field_name ||= ecs_select[disabled:'syslog_pri', v1:'[log][syslog][priority]']
74
+ end
75
+
63
76
  def register
64
77
  # Nothing
65
78
  end # def register
66
79
 
67
- public
68
80
  def filter(event)
69
-
70
81
  parse_pri(event)
71
82
  filter_matched(event)
72
83
  end # def filter
73
84
 
74
85
  private
86
+
75
87
  def parse_pri(event)
76
88
  # Per RFC3164, priority = (facility * 8) + severity
77
89
  # = (facility << 3) & (severity)
78
- if event.get(@syslog_pri_field_name)
79
- if event.get(@syslog_pri_field_name).is_a?(Array)
80
- priority = event.get(@syslog_pri_field_name).first.to_i
90
+ priority = event.get(@syslog_pri_field_name)
91
+ if priority
92
+ if priority.is_a?(Array)
93
+ priority = priority.first.to_i
81
94
  else
82
- priority = event.get(@syslog_pri_field_name).to_i
95
+ priority = priority.to_i
83
96
  end
84
97
  else
85
98
  priority = 13 # default
86
99
  end
87
- severity = priority & 7 # 7 is 111 (3 bits)
88
- facility = priority >> 3
89
- event.set("syslog_severity_code", severity)
90
- event.set("syslog_facility_code", facility)
100
+
101
+ severity_code = priority & 7 # 7 is 111 (3 bits)
102
+ facility_code = priority >> 3
103
+ event.set(@severity_code_key, severity_code)
104
+ event.set(@facility_code_key, facility_code)
91
105
 
92
106
  # Add human-readable names after parsing severity and facility from PRI
93
107
  if @use_labels
94
- facility_number = event.get("syslog_facility_code")
95
- severity_number = event.get("syslog_severity_code")
108
+ facility_label = @facility_labels[facility_code]
109
+ event.set(@facility_label_key, facility_label) if facility_label
96
110
 
97
- if @facility_labels[facility_number]
98
- event.set("syslog_facility", @facility_labels[facility_number])
99
- end
100
-
101
- if @severity_labels[severity_number]
102
- event.set("syslog_severity", @severity_labels[severity_number])
103
- end
111
+ severity_label = @severity_labels[severity_code]
112
+ event.set(@severity_label_key, severity_label) if severity_label
104
113
  end
105
114
  end # def parse_pri
106
115
  end # class LogStash::Filters::SyslogPRI
@@ -1,9 +1,9 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-filter-syslog_pri'
4
- s.version = '3.0.3'
4
+ s.version = '3.1.1'
5
5
  s.licenses = ['Apache License (2.0)']
6
- s.summary = "Filter plugin for logstash to parse the PRI field from the front of a Syslog (RFC3164) message"
6
+ s.summary = "Parses the `PRI` (priority) field of a `syslog` message"
7
7
  s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
8
8
  s.authors = ["Elastic"]
9
9
  s.email = 'info@elastic.co'
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
21
21
 
22
22
  # Gem dependencies
23
23
  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
24
+ s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
24
25
  s.add_development_dependency 'logstash-devutils'
25
26
 
26
27
  end
@@ -5,109 +5,173 @@ require "logstash/event"
5
5
 
6
6
  describe LogStash::Filters::Syslog_pri do
7
7
 
8
- subject { LogStash::Filters::Syslog_pri.new( "syslog_pri_field_name" => "syslog_pri" ) }
9
- let(:properties) { {:name => "foo" } }
10
- let(:event) { LogStash::Event.new(properties) }
8
+ let(:options) { {} }
9
+ subject { LogStash::Filters::Syslog_pri.new(options) }
10
+ let(:event_data) { { :name => "foo" } }
11
+ let(:event) { LogStash::Event.new.tap { |event| event_data.each { |k, v| event.set(k, v) } } }
11
12
 
12
13
  it "should register without errors" do
13
14
  plugin = LogStash::Plugin.lookup("filter", "syslog_pri").new( "facility_labels" => ["kernel"] )
14
15
  expect { plugin.register }.to_not raise_error
15
16
  end
16
17
 
17
- describe "defaults" do
18
+ context 'defaults', :ecs_compatibility_support do
19
+ ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
18
20
 
19
- subject { LogStash::Filters::Syslog_pri.new( "syslog_pri_field_name" => "my_syslog_pri" ) }
21
+ let(:ecs_compatibility?) { ecs_select.active_mode != :disabled }
20
22
 
21
- let(:properties) { { "syslog_pri" => 1 } }
22
- let(:event) { LogStash::Event.new(properties) }
23
+ let(:options) { { "syslog_pri_field_name" => "my_syslog_pri" } }
24
+ let(:event_data) { { (ecs_compatibility? ? "[log][syslog][priority]" : "syslog_pri") => 1 } }
23
25
 
24
- before(:each) do
25
- subject.register
26
- end
27
-
28
- it "default syslog_facility is user-level" do
29
- subject.filter(event)
30
- expect(event.get("syslog_facility")).to eq("user-level")
31
- end
32
-
33
- it "default syslog severity is notice" do
34
- subject.filter(event)
35
- expect(event.get("syslog_severity")).to eq("notice")
36
- end
37
-
38
- it "default severity to be 5, out of priority default 13" do
39
- subject.filter(event)
40
- expect(event.get("syslog_severity_code")).to eq(5)
41
- end
42
-
43
- end
44
-
45
- describe "filtering" do
26
+ before(:each) do
27
+ allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
46
28
 
47
- let(:properties) { { "syslog_pri" => syslog_pri } }
48
- let(:event) { LogStash::Event.new(properties) }
49
-
50
- before(:each) do
51
- subject.register
52
- end
53
-
54
- context "when critical messages arrive" do
55
- let(:syslog_pri) { 34 }
56
-
57
- it "syslog severity is critical" do
58
- subject.filter(event)
59
- expect(event.get("syslog_severity")).to eq("critical")
29
+ subject.register
60
30
  end
61
31
 
62
32
  it "default syslog_facility is user-level" do
63
33
  subject.filter(event)
64
- expect(event.get("syslog_facility")).to eq("security/authorization")
34
+ if ecs_compatibility?
35
+ expect(event.get("[log][syslog][facility][name]")).to eq("user-level")
36
+ else
37
+ expect(event.get("syslog_facility")).to eq("user-level")
38
+ end
65
39
  end
66
40
 
67
- end
68
-
69
- context "when notice local messages arrive" do
70
- let(:syslog_pri) { 165 }
41
+ it "default syslog severity is notice" do
42
+ subject.filter(event)
43
+ if ecs_compatibility?
44
+ expect(event.get("[log][syslog][severity][name]")).to eq("notice")
45
+ else
46
+ expect(event.get("syslog_severity")).to eq("notice")
47
+ end
48
+ end
71
49
 
72
- it "syslog severity is notice" do
50
+ it "default severity to be 5, out of priority default 13" do
73
51
  subject.filter(event)
74
- expect(event.get("syslog_severity")).to eq("notice")
52
+ if ecs_compatibility?
53
+ expect(event.get("[log][syslog][severity][code]")).to eq(5)
54
+ else
55
+ expect(event.get("syslog_severity_code")).to eq(5)
56
+ end
75
57
  end
76
58
 
77
- it "default syslog_facility is user-level" do
59
+ it "defaults to facility 1" do
78
60
  subject.filter(event)
79
- expect(event.get("syslog_facility")).to eq("local4")
61
+ if ecs_compatibility?
62
+ expect(event.get("[log][syslog][facility][code]")).to eq(1)
63
+ else
64
+ expect(event.get("syslog_facility_code")).to eq(1)
65
+ end
80
66
  end
67
+
81
68
  end
69
+ end
82
70
 
83
- context "when a debug messages arrive" do
84
- let(:syslog_pri) { 191 }
71
+ context 'filtering', :ecs_compatibility_support do
72
+ ecs_compatibility_matrix(:disabled, :v1) do |ecs_select|
85
73
 
86
- it "syslog severity is notice" do
87
- subject.filter(event)
88
- expect(event.get("syslog_severity")).to eq("debug")
74
+ let(:ecs_compatibility?) { ecs_select.active_mode != :disabled }
75
+
76
+ let(:event_data) { { (ecs_compatibility? ? "[log][syslog][priority]" : "syslog_pri") => syslog_pri } }
77
+
78
+ before(:each) do
79
+ allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
80
+
81
+ subject.register
89
82
  end
90
83
 
91
- it "default syslog_facility is user-level" do
92
- subject.filter(event)
93
- expect(event.get("syslog_facility")).to eq("local7")
84
+ context "when critical messages arrive" do
85
+ let(:syslog_pri) { 34 }
86
+
87
+ it "syslog severity is critical" do
88
+ subject.filter(event)
89
+ if ecs_compatibility?
90
+ expect(event.get("[log][syslog][severity][name]")).to eq("critical")
91
+ else
92
+ expect(event.get("syslog_severity")).to eq("critical")
93
+ end
94
+ end
95
+
96
+ it "default syslog_facility is user-level" do
97
+ subject.filter(event)
98
+ if ecs_compatibility?
99
+ expect(event.get("[log][syslog][facility][name]")).to eq("security/authorization")
100
+ else
101
+ expect(event.get("syslog_facility")).to eq("security/authorization")
102
+ end
103
+ end
104
+
94
105
  end
95
- end
96
106
 
97
- context "when an alert messages arrive" do
98
- let(:syslog_pri) { 137 }
107
+ context "when notice local messages arrive" do
108
+ let(:syslog_pri) { 165 }
109
+
110
+ it "syslog severity is notice" do
111
+ subject.filter(event)
112
+ if ecs_compatibility?
113
+ expect(event.get("[log][syslog][severity][name]")).to eq("notice")
114
+ else
115
+ expect(event.get("syslog_severity")).to eq("notice")
116
+ end
117
+ end
118
+
119
+ it "default syslog_facility is user-level" do
120
+ subject.filter(event)
121
+ if ecs_compatibility?
122
+ expect(event.get("[log][syslog][facility][name]")).to eq("local4")
123
+ else
124
+ expect(event.get("syslog_facility")).to eq("local4")
125
+ end
126
+ end
127
+ end
99
128
 
100
- it "syslog severity is notice" do
101
- subject.filter(event)
102
- expect(event.get("syslog_severity")).to eq("alert")
129
+ context "when a debug messages arrive" do
130
+ let(:syslog_pri) { 191 }
131
+
132
+ it "syslog severity is notice" do
133
+ subject.filter(event)
134
+ if ecs_compatibility?
135
+ expect(event.get("[log][syslog][severity][name]")).to eq("debug")
136
+ else
137
+ expect(event.get("syslog_severity")).to eq("debug")
138
+ end
139
+ end
140
+
141
+ it "default syslog_facility is user-level" do
142
+ subject.filter(event)
143
+ if ecs_compatibility?
144
+ expect(event.get("[log][syslog][facility][name]")).to eq("local7")
145
+ else
146
+ expect(event.get("syslog_facility")).to eq("local7")
147
+ end
148
+ end
103
149
  end
104
150
 
105
- it "default syslog_facility is user-level" do
106
- subject.filter(event)
107
- expect(event.get("syslog_facility")).to eq("local1")
151
+ context "when an alert messages arrive" do
152
+ let(:syslog_pri) { '137' }
153
+
154
+ it "syslog severity is notice" do
155
+ subject.filter(event)
156
+ if ecs_compatibility?
157
+ expect(event.get("[log][syslog][severity][name]")).to eq("alert")
158
+ else
159
+ expect(event.get("syslog_severity")).to eq("alert")
160
+ end
161
+ end
162
+
163
+ it "default syslog_facility is user-level" do
164
+ subject.filter(event)
165
+ if ecs_compatibility?
166
+ expect(event.get("[log][syslog][facility][name]")).to eq("local1")
167
+ expect(event.get("[log][syslog][facility][code]")).to eq(17)
168
+ else
169
+ expect(event.get("syslog_facility")).to eq("local1")
170
+ expect(event.get("syslog_facility_code")).to eq(17)
171
+ end
172
+ end
108
173
  end
109
- end
110
174
 
175
+ end
111
176
  end
112
-
113
177
  end
data/spec/spec_helper.rb CHANGED
@@ -1,3 +1,4 @@
1
1
  # encoding: utf-8
2
2
  require "logstash/devutils/rspec/spec_helper"
3
+ require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
3
4
  require 'logstash/filters/syslog_pri'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-filter-syslog_pri
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.3
4
+ version: 3.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-06-23 00:00:00.000000000 Z
11
+ date: 2021-11-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -30,6 +30,20 @@ dependencies:
30
30
  - - "<="
31
31
  - !ruby/object:Gem::Version
32
32
  version: '2.99'
33
+ - !ruby/object:Gem::Dependency
34
+ requirement: !ruby/object:Gem::Requirement
35
+ requirements:
36
+ - - "~>"
37
+ - !ruby/object:Gem::Version
38
+ version: '1.3'
39
+ name: logstash-mixin-ecs_compatibility_support
40
+ prerelease: false
41
+ type: :runtime
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '1.3'
33
47
  - !ruby/object:Gem::Dependency
34
48
  requirement: !ruby/object:Gem::Requirement
35
49
  requirements:
@@ -44,7 +58,9 @@ dependencies:
44
58
  - - ">="
45
59
  - !ruby/object:Gem::Version
46
60
  version: '0'
47
- description: This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
61
+ description: This gem is a Logstash plugin required to be installed on top of the
62
+ Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
63
+ gem is not a stand-alone program
48
64
  email: info@elastic.co
49
65
  executables: []
50
66
  extensions: []
@@ -82,11 +98,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
82
98
  - !ruby/object:Gem::Version
83
99
  version: '0'
84
100
  requirements: []
85
- rubyforge_project:
86
- rubygems_version: 2.4.8
101
+ rubygems_version: 3.1.6
87
102
  signing_key:
88
103
  specification_version: 4
89
- summary: Filter plugin for logstash to parse the PRI field from the front of a Syslog (RFC3164) message
104
+ summary: Parses the `PRI` (priority) field of a `syslog` message
90
105
  test_files:
91
106
  - spec/filters/syslog_pri_spec.rb
92
107
  - spec/spec_helper.rb