logstash-filter-syslog_pri 3.1.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3e7172aa14a0a1ac779c183aadb366d15d30e027c7f266aa6ca2dd228aab38e
-  data.tar.gz: 3e3274f72b800eb2096d0ba879c4fc17ea42dcee9bdf8de42d646b5de01f9071
+  metadata.gz: 15045cf32219a84e310c2f9ec1446484c1e5f8e09a4b17c3c8bb0fcdf209b6ce
+  data.tar.gz: 01d2bcfe07f470e70f897c5903b72965502d935da9dfe4a8724d7510eccc9c83
 SHA512:
-  metadata.gz: 3ed38b2e8905864b009f31d9c7482b0316c88e83cf0704015af1af15c2d4c0f39525b7f500c99ad6f8d69464df77753356fdc36680b48b99284e4a0d761309d1
-  data.tar.gz: a78e217a3defc39b436297e37446754ce024685a83bab05e85c3e382e6b1c7901aeb2bb6ae5e945963519793ad81ae391087cb718cacaaf4a2c2f324c5b124f4
+  metadata.gz: 032a33ff35de0d43b33f3e58634d433ae98a70ae380a3fcd6a95ecdfe9d454f96803dcc542f9f9b09f20881072ce3cd1c925dba5463935dfdee24a8ecc2824be
+  data.tar.gz: 670f30eb6740c06ac9264472fca2ac015ff462b23ed0ee9143ba3b4a8781a28947f8ada2e6d3966ba126aa75f6905c5ae33e1f8e18c335942095f34d34721949

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.2.1
+  - Remove spurious leftover text from "use_labels" docs [#15](https://github.com/logstash-plugins/logstash-filter-syslog_pri/pull/15)
+
+## 3.2.0
+  - Feat: add tagging on unrecognized `facility_label` code [#11](https://github.com/logstash-plugins/logstash-filter-syslog_pri/pull/11)
+  - Change: refactored test code to be streamlined when checking ECS fields [#14](https://github.com/logstash-plugins/logstash-filter-syslog_pri/pull/14)
+
 ## 3.1.1
   - Added preview of ECS-v8 support with existing ECS-v1 implementation [#10](https://github.com/logstash-plugins/logstash-filter-syslog_pri/pull/10)
 

data/docs/index.asciidoc

@@ -68,6 +68,8 @@ The value of this setting affects the _default_ value of <<plugins-{type}s-{plug
   * Default value is `["kernel", "user-level", "mail", "daemon", "security/authorization", "syslogd", "line printer", "network news", "uucp", "clock", "security/authorization", "ftp", "ntp", "log audit", "log alert", "clock", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7"]`
 
 Labels for facility levels. This comes from RFC3164.
+If an unrecognized facility code is provided and <<plugins-{type}s-{plugin}-use_labels>> is `true` then the event
+is tagged with `_syslogpriparsefailure`.
 
 [id="plugins-{type}s-{plugin}-severity_labels"]
 ===== `severity_labels` 
@@ -93,10 +95,9 @@ Name of field which passes in the extracted PRI part of the syslog message
   * Value type is <<boolean,boolean>>
   * Default value is `true`
 
-set the status to experimental/beta/stable
 Add human-readable names after parsing severity and facility from PRI
 
 
 
 [id="plugins-{type}s-{plugin}-common-options"]
-include::{include_path}/{type}.asciidoc[]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/syslog_pri.rb

@@ -11,8 +11,6 @@ class LogStash::Filters::Syslog_pri < LogStash::Filters::Base
 
   config_name "syslog_pri"
 
-  # set the status to experimental/beta/stable
-
   # Add human-readable names after parsing severity and facility from PRI
   config :use_labels, :validate => :boolean, :default => true
 
@@ -84,6 +82,8 @@ class LogStash::Filters::Syslog_pri < LogStash::Filters::Base
 
   private
 
+  SYSLOGPRIPARSEFAILURE_TAG = "_syslogpriparsefailure"
+
   def parse_pri(event)
     # Per RFC3164, priority = (facility * 8) + severity
     # = (facility << 3) & (severity)
@@ -104,12 +104,21 @@ class LogStash::Filters::Syslog_pri < LogStash::Filters::Base
     event.set(@facility_code_key, facility_code)
 
     # Add human-readable names after parsing severity and facility from PRI
-    if @use_labels
-      facility_label = @facility_labels[facility_code]
-      event.set(@facility_label_key, facility_label) if facility_label
-
-      severity_label = @severity_labels[severity_code]
-      event.set(@severity_label_key, severity_label) if severity_label
+    return unless @use_labels
+
+    # from Syslog PRI RFC 4.1.1 PRI Part, facility_code the maximum possible value is 124, however it defines just 23 values
+    if facility_code > (@facility_labels.size - 1)
+      # if the facility_code overflow the labels array
+      event.tag(SYSLOGPRIPARSEFAILURE_TAG)
+      logger.debug("Invalid facility code for event", :facility => facility_code)
+      return
     end
+
+    facility_label = @facility_labels[facility_code]
+    event.set(@facility_label_key, facility_label) if facility_label
+
+    # severity code is in range [0..7] by definition, no need to check any bound
+    severity_label = @severity_labels[severity_code]
+    event.set(@severity_label_key, severity_label) if severity_label
   end # def parse_pri
 end # class LogStash::Filters::SyslogPRI

data/logstash-filter-syslog_pri.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-syslog_pri'
-  s.version         = '3.1.1'
+  s.version         = '3.2.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Parses the `PRI` (priority) field of a `syslog` message"
   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"

data/spec/filters/syslog_pri_spec.rb

@@ -9,6 +9,10 @@ describe LogStash::Filters::Syslog_pri do
   subject          { LogStash::Filters::Syslog_pri.new(options) }
   let(:event_data) { { :name => "foo" } }
   let(:event)      { LogStash::Event.new.tap { |event| event_data.each { |k, v| event.set(k, v) } } }
+  let(:syslog_facility_code_field) { ecs_compatibility? ? "[log][syslog][facility][code]" : "syslog_facility_code" }
+  let(:syslog_facility_name_field) { ecs_compatibility? ? "[log][syslog][facility][name]" : "syslog_facility" }
+  let(:syslog_severity_code_field) { ecs_compatibility? ? "[log][syslog][severity][code]" : "syslog_severity_code" }
+  let(:syslog_severity_name_field) { ecs_compatibility? ? "[log][syslog][severity][name]" : "syslog_severity" }
 
   it "should register without errors" do
     plugin = LogStash::Plugin.lookup("filter", "syslog_pri").new( "facility_labels" => ["kernel"] )
@@ -31,38 +35,22 @@ describe LogStash::Filters::Syslog_pri do
 
       it "default syslog_facility is user-level" do
         subject.filter(event)
-        if ecs_compatibility?
-          expect(event.get("[log][syslog][facility][name]")).to eq("user-level")
-        else
-          expect(event.get("syslog_facility")).to eq("user-level")
-        end
+        expect(event.get(syslog_facility_name_field)).to eq("user-level")
       end
 
       it "default syslog severity is notice" do
         subject.filter(event)
-        if ecs_compatibility?
-          expect(event.get("[log][syslog][severity][name]")).to eq("notice")
-        else
-          expect(event.get("syslog_severity")).to eq("notice")
-        end
+        expect(event.get(syslog_severity_name_field)).to eq("notice")
       end
 
       it "default severity to be 5, out of priority default 13" do
         subject.filter(event)
-        if ecs_compatibility?
-          expect(event.get("[log][syslog][severity][code]")).to eq(5)
-        else
-          expect(event.get("syslog_severity_code")).to eq(5)
-        end
+        expect(event.get(syslog_severity_code_field)).to eq(5)
       end
 
       it "defaults to facility 1" do
         subject.filter(event)
-        if ecs_compatibility?
-          expect(event.get("[log][syslog][facility][code]")).to eq(1)
-        else
-          expect(event.get("syslog_facility_code")).to eq(1)
-        end
+        expect(event.get(syslog_facility_code_field)).to eq(1)
       end
 
     end
@@ -86,20 +74,12 @@ describe LogStash::Filters::Syslog_pri do
 
         it "syslog severity is critical" do
           subject.filter(event)
-          if ecs_compatibility?
-            expect(event.get("[log][syslog][severity][name]")).to eq("critical")
-          else
-            expect(event.get("syslog_severity")).to eq("critical")
-          end
+          expect(event.get(syslog_severity_name_field)).to eq("critical")
         end
 
         it "default syslog_facility is user-level" do
           subject.filter(event)
-          if ecs_compatibility?
-            expect(event.get("[log][syslog][facility][name]")).to eq("security/authorization")
-          else
-            expect(event.get("syslog_facility")).to eq("security/authorization")
-          end
+          expect(event.get(syslog_facility_name_field)).to eq("security/authorization")
         end
 
       end
@@ -109,20 +89,12 @@ describe LogStash::Filters::Syslog_pri do
 
         it "syslog severity is notice" do
           subject.filter(event)
-          if ecs_compatibility?
-            expect(event.get("[log][syslog][severity][name]")).to eq("notice")
-          else
-            expect(event.get("syslog_severity")).to eq("notice")
-          end
+          expect(event.get(syslog_severity_name_field)).to eq("notice")
         end
 
         it "default syslog_facility is user-level" do
           subject.filter(event)
-          if ecs_compatibility?
-            expect(event.get("[log][syslog][facility][name]")).to eq("local4")
-          else
-            expect(event.get("syslog_facility")).to eq("local4")
-          end
+          expect(event.get(syslog_facility_name_field)).to eq("local4")
         end
       end
 
@@ -131,20 +103,12 @@ describe LogStash::Filters::Syslog_pri do
 
         it "syslog severity is notice" do
           subject.filter(event)
-          if ecs_compatibility?
-            expect(event.get("[log][syslog][severity][name]")).to eq("debug")
-          else
-            expect(event.get("syslog_severity")).to eq("debug")
-          end
+          expect(event.get(syslog_severity_name_field)).to eq("debug")
         end
 
         it "default syslog_facility is user-level" do
           subject.filter(event)
-          if ecs_compatibility?
-            expect(event.get("[log][syslog][facility][name]")).to eq("local7")
-          else
-            expect(event.get("syslog_facility")).to eq("local7")
-          end
+          expect(event.get(syslog_facility_name_field)).to eq("local7")
         end
       end
 
@@ -153,25 +117,49 @@ describe LogStash::Filters::Syslog_pri do
 
         it "syslog severity is notice" do
           subject.filter(event)
-          if ecs_compatibility?
-            expect(event.get("[log][syslog][severity][name]")).to eq("alert")
-          else
-            expect(event.get("syslog_severity")).to eq("alert")
-          end
+          expect(event.get(syslog_severity_name_field)).to eq("alert")
         end
 
         it "default syslog_facility is user-level" do
           subject.filter(event)
-          if ecs_compatibility?
-            expect(event.get("[log][syslog][facility][name]")).to eq("local1")
-            expect(event.get("[log][syslog][facility][code]")).to eq(17)
-          else
-            expect(event.get("syslog_facility")).to eq("local1")
-            expect(event.get("syslog_facility_code")).to eq(17)
-          end
+          expect(event.get(syslog_facility_name_field)).to eq("local1")
+          expect(event.get(syslog_facility_code_field)).to eq(17)
         end
       end
 
+      context "when malformed messages arrive" do
+        context "if syslog priority value is too high" do
+          let(:syslog_pri) { 193 }
+
+          before(:each) { subject.filter(event) }
+
+          context "if use_labels is enabled (default)" do
+            it "the event is tagged" do
+              expect(event.get("tags")).to include("_syslogpriparsefailure")
+            end
+            it "the facility label isn't set" do
+              expect(event.get(syslog_facility_name_field)).to be_nil
+            end
+            it "the severity label isn't set" do
+              expect(event.get(syslog_severity_name_field)).to be_nil
+            end
+          end
+
+          context "if use_labels is disabled" do
+            let(:options) { super().merge("use_labels" => false) }
+            it "the event is not tagged" do
+              expect(event.get("tags")).to be_nil
+            end
+          end
+
+          it "the facility code is still set" do
+            expect(event.get(syslog_facility_code_field)).to eq(24)
+          end
+          it "the severity code is still set" do
+            expect(event.get(syslog_severity_code_field)).to eq(1)
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-syslog_pri
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2024-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Parses the `PRI` (priority) field of a `syslog` message