logstash-output-email 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9113b32924f9aa3aaf948a2def10f4de02e304a6
-  data.tar.gz: 685b26596c503699d5ab855720619cff6cb26075
+  metadata.gz: 0fb4c27da8842a79052b5274c3e3f418ba106559
+  data.tar.gz: 0ec34781d9e6e54ab5cdfb3a7e81d0a1915cca76
 SHA512:
-  metadata.gz: e29a2e50322bd6b9eef87bc9f786834b0f4f58ff4f1a2746c14282915e8635fc2ce948bb48f03b188d07d014f5cc3a238503f6b3616f05460c59f00d4c901dad
-  data.tar.gz: c9ac9d5fe22bbf02b1a57e2348b5d26b19fd6eb5709d7509ffb61fdc5958a314c74405784f136f17c623ba5103b39fd3461e343f0cd3eb77e57a36cc1ea61bf5
+  metadata.gz: 24be2f1aa8ea57d9a2e5919ac0d66618e42c5d7d1c2af0e28bf76049ad362a10959ccd7a14d390b7d955fce222c8679b06d12783f6ca4a8891b224a325dfc779
+  data.tar.gz: 85eb7feb2ad575fd3dff7648cffd916732da230cba9ccfabe21afaac25a588be2edd6c672a2b5665ccfe0b713d44d2eec120f679830f1d237f96e622cf63f7a2

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 2.0.0
+  - Introduced new configuration options for the smtp server, the
+    options option is gone and now you need to specify each option
+    independetly. This require you to change your previous configuration
+    when updating.
+  - Removed the deprecated option match. This option was deprecatred in
+    favor of using conditionals. This change also require you to change
+    your current cnofiguration if using this option.
+
 # 1.1.0
   - Make the delivery method more reliable to failure by catching and
     logging exceptions when happen, like this LS is not going to break

data/lib/logstash/outputs/email.rb

@@ -8,14 +8,6 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
 
   config_name "email"
 
-  # This setting is deprecated in favor of Logstash's "conditionals" feature
-  # If you were using this setting previously, please use conditionals instead.
-  #
-  # If you need help converting your older `match` setting to a conditional,
-  # I welcome you to join the #logstash irc channel on freenode or to post
-  # a message on https://discuss.elastic.co/c/logstash and ask for help! :)
-  config :match, :validate => :hash, :deprecated => true
-
   # The fully-qualified email address to send the email to.
   #
   # This field also accepts a comma-separated string of addresses, for example: 
@@ -39,51 +31,29 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
   # How Logstash should send the email, either via SMTP or by invoking sendmail.
   config :via, :validate => :string, :default => "smtp"
 
-  # Specify the options to use:
-  #
-  # Via SMTP: `smtpIporHost`, `port`, `domain`, `userName`, `password`, `authenticationType`, `starttls`
-  #
-  # Via sendmail: `location`, `arguments`
-  #
-  # If you do not specify any `options`, you will get the following equivalent code set in
-  # every new mail object:
-  # [source,ruby]
-  #     Mail.defaults do
-  #       delivery_method :smtp, { :smtpIporHost         => "localhost",
-  #                                :port                 => 25,
-  #                                :domain               => 'localhost.localdomain',
-  #                                :userName             => nil,
-  #                                :password             => nil,
-  #                                :authenticationType   => nil,(plain, login and cram_md5)
-  #                                :starttls             => true  }
-  #
-  #       retriever_method :pop3, { :address             => "localhost",
-  #                                 :port                => 995,
-  #                                 :user_name           => nil,
-  #                                 :password            => nil,
-  #                                 :enable_ssl          => true }
-  #
-  #       Mail.delivery_method.new  #=> Mail::SMTP instance
-  #       Mail.retriever_method.new #=> Mail::POP3 instance
-  #     end
-  #
-  # Each mail object inherits the defaults set in Mail.delivery_method. However, on
-  # a per email basis, you can override the method:
-  # [source,ruby]
-  #     mail.delivery_method :sendmail
-  #
-  # Or you can override the method and pass in settings:
-  # [source,ruby]
-  #     mail.delivery_method :sendmail, { :address => 'some.host' }
-  #
-  # You can also just modify the settings:
-  # [source,ruby]
-  #     mail.delivery_settings = { :address => 'some.host' }
-  #
-  # The hash you supply is just merged against the defaults with "merge!" and the result
-  # assigned to the mail object.  For instance, the above example will change only the
-  # `:address` value of the global `smtp_settings` to be 'some.host', retaining all other values.
-  config :options, :validate => :hash, :default => {}
+  # The address used to connect to the mail server
+  config :address, :validate => :string, :default => "localhost"
+
+  # Port used to communicate with the mail server
+  config :port, :validate => :number, :default => 25
+
+  # Domain used to send the email messages
+  config :domain, :validate => :string, :default => "localhost"
+
+  # Username to authenticate with the server
+  config :username, :validate => :string
+
+  # Password to authenticate with the server
+  config :password, :validate => :string
+
+  # Authentication method used when identifying with the server
+  config :authentication, :validate => :string
+
+  # Enables TLS when communicating with the server
+  config :use_tls, :validate => :boolean, :default => false
+
+  # Run the mail relay in debug mode
+  config :debug, :validate => :boolean, :default => false
 
   # Subject: for the email.
   config :subject, :validate => :string, :default => ""
@@ -105,22 +75,20 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
   def register
     require "mail"
 
-    # Mail uses instance_eval which changes the scope of self so @options is
-    # inaccessible from inside 'Mail.defaults'. So set a local variable instead.
-    options = @options
+    options = {
+      :address              => @address,
+      :port                 => @port,
+      :domain               => @domain,
+      :user_name            => @username,
+      :password             => @password,
+      :authentication       => @authentication,
+      :enable_starttls_auto => @use_tls,
+      :debug                => @debug
+    }
 
     if @via == "smtp"
       Mail.defaults do
-        delivery_method :smtp, {
-          :address              => options.fetch("smtpIporHost", "localhost"),
-          :port                 => options.fetch("port", 25),
-          :domain               => options.fetch("domain", "localhost"),
-          :user_name            => options.fetch("userName", nil),
-          :password             => options.fetch("password", nil),
-          :authentication       => options.fetch("authenticationType", nil),
-          :enable_starttls_auto => options.fetch("starttls", false),
-          :debug                => options.fetch("debug", false)
-        }
+        delivery_method :smtp, options
       end
     elsif @via == 'sendmail'
       Mail.defaults do
@@ -131,96 +99,17 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
         delivery_method :@via, options
       end
     end # @via tests
-    @logger.debug("Email Output Registered!", :config => @config)
+    @logger.debug("Email Output Registered!", :config => options, :via => @via)
   end # def register
 
   public
   def receive(event)
     return unless output?(event)
-      @logger.debug("Event being tested for Email", :tags => @tags, :event => event)
-      # Set Intersection - returns a new array with the items that are the same between the two
-      if !@tags.empty? && (event["tags"] & @tags).size == 0
-         # Skip events that have no tags in common with what we were configured
-         @logger.debug("No Tags match for Email Output!")
-         return
-      end
 
-    @logger.debug? && @logger.debug("Match data for Email - ", :match => @match)
-    successful = false
-    matchName = ""
-    operator = ""
-
-    # TODO(sissel): Delete this once match support is removed.
-    @match && @match.each do |name, query|
-      if successful
-        break
-      else
-        matchName = name
-      end
-      # now loop over the csv query
-      queryArray = query.split(',')
-      index = 1
-      while index < queryArray.length
-        field = queryArray.at(index -1)
-        value = queryArray.at(index)
-        index = index + 2
-        if field == ""
-          if value.downcase == "and"
-            operator = "and"
-          elsif value.downcase == "or"
-            operator = "or"
-          else
-            operator = "or"
-            @logger.error("Operator Provided Is Not Found, Currently We Only Support AND/OR Values! - defaulting to OR")
-          end
-        else
-          hasField = event[field]
-          @logger.debug? and @logger.debug("Does Event Contain Field - ", :hasField => hasField)
-          isValid = false
-          # if we have maching field and value is wildcard - we have a success
-          if hasField
-            if value == "*"
-              isValid = true
-            else
-              # we get an array so we need to loop over the values and find if we have a match
-              eventFieldValues = event[field]
-              @logger.debug? and @logger.debug("Event Field Values - ", :eventFieldValues => eventFieldValues)
-              eventFieldValues = [eventFieldValues] if not eventFieldValues.respond_to?(:each)
-              eventFieldValues.each do |eventFieldValue|
-                isValid = validateValue(eventFieldValue, value)
-                if isValid # no need to iterate any further
-                  @logger.debug("VALID CONDITION FOUND - ", :eventFieldValue => eventFieldValue, :value => value) 
-                  break
-                end
-              end # end eventFieldValues.each do
-            end # end value == "*"
-          end # end hasField
-          # if we have an AND operator and we have a successful == false break
-          if operator == "and" && !isValid
-            successful = false
-          elsif operator == "or" && (isValid || successful)
-            successful = true
-          else
-            successful = isValid
-          end
-        end
-      end
-    end # @match.each do
-
-    # The 'match' setting is deprecated and optional. If not set,
-    # default to success.
-    successful = true if @match.nil?
-
-    @logger.debug? && @logger.debug("Email Did we match any alerts for event : ", :successful => successful)
-
-    if successful
-      # first add our custom field - matchName - so we can use it in the sprintf function
-      event["matchName"] = matchName unless matchName.empty?
       @logger.debug? and @logger.debug("Creating mail with these settings : ", :via => @via, :options => @options, :from => @from, :to => @to, :cc => @cc, :subject => @subject, :body => @body, :content_type => @contenttype, :htmlbody => @htmlbody, :attachments => @attachments, :to => to, :to => to)
       formatedSubject = event.sprintf(@subject)
       formattedBody = event.sprintf(@body)
       formattedHtmlBody = event.sprintf(@htmlbody)
-      # we have a match(s) - send email
       mail = Mail.new
       mail.from = event.sprintf(@from)
       mail.to = event.sprintf(@to)
@@ -253,55 +142,5 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
         @logger.error("Something happen while delivering an email", :exception => e)
         @logger.debug? && @logger.debug("Processed event: ", :event => event)
       end
-    end # end if successful
   end # def receive
-
-
-  private
-  def validateValue(eventFieldValue, value)
-    valid = false
-    # order of this if-else is important - please don't change it
-    if value.start_with?(">=")# greater than or equal
-      value.gsub!(">=","")
-      if eventFieldValue.to_i >= value.to_i
-        valid = true
-      end
-    elsif value.start_with?("<=")# less than or equal
-      value.gsub!("<=","")
-      if eventFieldValue.to_i <= value.to_i
-        valid = true
-      end
-    elsif value.start_with?(">")# greater than
-      value.gsub!(">","")
-      if eventFieldValue.to_i > value.to_i
-        valid = true
-      end
-    elsif value.start_with?("<")# less than
-      value.gsub!("<","")
-      if eventFieldValue.to_i < value.to_i
-        valid = true
-      end
-    elsif value.start_with?("*")# contains
-      value.gsub!("*","")
-      if eventFieldValue.include?(value)
-        valid = true
-      end
-    elsif value.start_with?("!*")# does not contain
-      value.gsub!("!*","")
-      if !eventFieldValue.include?(value)
-        valid = true
-      end
-    elsif value.start_with?("!")# not equal
-      value.gsub!("!","")
-      if eventFieldValue != value
-        valid = true
-      end
-    else # default equal
-      if eventFieldValue == value
-        valid = true
-      end
-    end
-    return valid
-  end # end validateValue()
-
 end # class LogStash::Outputs::Email

data/logstash-output-email.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-email'
-  s.version         = '1.1.0'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Send email when an output is received."
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"

data/spec/outputs/email_spec.rb

@@ -27,25 +27,23 @@ describe "outputs/email" do
 
       it "supports list of emails in to field" do
         subject = plugin.new("to" => ["email1@host, email2@host"],
-                             "match" => ["mymatch", "dummy_match,ok"],
-                             "options" => ["port", port])
+                             "port" => port)
         subject.register
-        subject.receive(LogStash::Event.new("message" => "hello", "dummy_match" => "ok"))
+        subject.receive(LogStash::Event.new("message" => "hello"))
         expect(message_observer.messages.size).to eq(1)
         expect(message_observer.messages[0].to).to eq(["email1@host", "email2@host"])
       end
 
       it "multiple *to* addresses in a field" do
         subject = plugin.new("to" => "%{to_addr}",
-                             "match" => ["mymatch", "dummy_match,ok"],
-                             "options" => ["port", port])
+                             "port" => port)
         subject.register
         subject.receive(LogStash::Event.new("message" => "hello",
-                                            "dummy_match" => "ok",
                                             "to_addr" => ["email1@host", "email2@host"]))
         expect(message_observer.messages.size).to eq(1)
         expect(message_observer.messages[0].to).to eq(["email1@host", "email2@host"])
       end
+
     end
 
     context  "multi-lined text body (LOGSTASH-841)" do
@@ -53,59 +51,43 @@ describe "outputs/email" do
         subject = plugin.new("to" => "me@host",
                              "subject" => "Hello World",
                              "body" => "Line1\\nLine2\\nLine3",
-                             "match" => ["mymatch", "dummy_match,*"],
-                             "options" => ["port", port])
+                             "port" => port)
         subject.register
-        subject.receive(LogStash::Event.new("message" => "hello", "dummy_match" => "ok"))
+        subject.receive(LogStash::Event.new("message" => "hello"))
         expect(message_observer.messages.size).to eq(1)
         expect(message_observer.messages[0].subject).to eq("Hello World")
         expect(message_observer.messages[0].body.raw_source).to eq("Line1\r\nLine2\r\nLine3\r\n")
       end
-    end
 
-    context  "use nil authenticationType (LOGSTASH-559)" do
-      it "reads messages correctly" do
-        subject = plugin.new("to" => "me@host",
-                             "subject" => "Hello World",
-                             "body" => "Line1\\nLine2\\nLine3",
-                             "match" => ["mymatch", "dummy_match,*"],
-                             "options" => ["port", port, "authenticationType", "nil"])
-        subject.register
-        subject.receive(LogStash::Event.new("message" => "hello", "dummy_match" => "ok"))
-        expect(message_observer.messages.size).to eq(1)
-        expect(message_observer.messages[0].subject).to eq("Hello World")
-        expect(message_observer.messages[0].body.raw_source).to eq("Line1\r\nLine2\r\nLine3\r\n")
-      end
-    end
+      context  "use nil authenticationType (LOGSTASH-559)" do
+        it "reads messages correctly" do
+          subject = plugin.new("to" => "me@host",
+                               "subject" => "Hello World",
+                               "body" => "Line1\\nLine2\\nLine3",
+                               "port" => port)
+          subject.register
+          subject.receive(LogStash::Event.new("message" => "hello"))
+          expect(message_observer.messages.size).to eq(1)
+          expect(message_observer.messages[0].subject).to eq("Hello World")
+          expect(message_observer.messages[0].body.raw_source).to eq("Line1\r\nLine2\r\nLine3\r\n")
+        end
 
-    context  "match on source and message (LOGSTASH-826)" do
-      it "reads messages correctly" do
-        subject = plugin.new("to" => "me@host",
-                             "subject" => "Hello World",
-                             "body" => "Mail body",
-                             "match" => [ "messageAndSourceMatch", "message,*hello,,and,type,*generator"],
-                             "options" => ["port", port, "authenticationType", "nil"])
-        subject.register
-        subject.receive(LogStash::Event.new("message" => "hello world", "type" => "generator"))
-        expect(message_observer.messages.size).to eq(1)
-        expect(message_observer.messages[0].subject).to eq("Hello World")
-        expect(message_observer.messages[0].body.raw_source).to eq("Mail body\r\n")
-      end
-    end
 
-    context "having no connection to the email server" do
+        context "having no connection to the email server" do
 
-      subject     { plugin.new("to" => "me@host") }
-      let(:event) { LogStash::Event.new("message" => "hello world") }
+          subject     { plugin.new("to" => "me@host") }
+          let(:event) { LogStash::Event.new("message" => "hello world") }
 
-      before(:each) do
-        subject.register
-      end
+          before(:each) do
+            subject.register
+          end
+
+          it "should send without throwing an error" do
+            expect { subject.receive(event) }.not_to raise_error
+          end
+        end
 
-      it "should send without throwing an error" do
-        expect { subject.receive(event) }.not_to raise_error
       end
     end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-email
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Elastic