flexciton-logstash-output-opsgenie 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bde1d899898b78b0af27e898c6a07d8daf07e3ae84e97520a2b6fec854944b6f
-  data.tar.gz: dcb75c88e77ba0834b45ce94f564f709b0fa053e796fddbd5b7677c228c4e275
+  metadata.gz: 34a1e3ca52554902ba67056b1359f82ae6d1a5e92bd0cf5dd5b2862b22822a1c
+  data.tar.gz: 175bd9c7866726b5c466cbaaee1bca001b3ebe5f3915e058f3ed5f5bdbb25c5f
 SHA512:
-  metadata.gz: 0d2be0b3b8b10a208a46fbb4e09579a14812f31e75322d888a15e6d65a4d360ecf5c90a9697946123868df6c005fd7c16401a91850ecf7d6a610dfda35954d19
-  data.tar.gz: a9aa782d9ddf3e3685c5582c0a0bf474f2a8c5ecc56c8db3a91c930f79ecb1a016cba57e1bd44108a11aa7acad2c407a883e9a3f685de825220f94eee9978610
+  metadata.gz: f6157fb6cc89687064bd9dbce6ff6d88f5988f5fe889e9afe202542d78056574d4e430ed30dff22abbb86f41bd6d9be2774d4d6a15c8014af383eb956aae0e18
+  data.tar.gz: c11dd7a785043177b0eb95e2aa112fffcb81d2abbd9d925d33d7f64d2e2b8f2235c4138530dfd0d5ff65a61fe4446ac89ed8dd87fb6e3266de00605d1660e9e8

data/README.md

@@ -1,25 +1,32 @@
-# OpsGenie Logstash Plugin
+# Flexciton Logstash Output OpsGenie Plugin
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
-### Install and Run OpsGenie Output Plugin in Logstash
+This version is forked from: https://github.com/opsgenie/logstash-output-opsgenie
+All kudos goes to the original authors.
 
-OpsGenie Logstash Output plugin is available in [RubyGems.org](https://rubygems.org/gems/logstash-output-opsgenie)
+`flexciton-logstash-output-opsgenie` improvements:
+- Add error handling on network errors. Previously the pipeline in `Logstash` would simply crash and cause `Logstash` to go down or stop processing logs completely. Now it will retry certain errors or log a warning and silence the exception.
+- Fix all tests. Tests were broken since 2017 changes to adjust to new Opsgenie API. Now they pass.
+
+### Install and Run Flexciton Logstash Output OpsGenie in Logstash
+
+Flexciton Logstash Output OpsGenie plugin is available in [RubyGems.org](https://rubygems.org/gems/flexciton-logstash-output-opsgenie)
 
 - `Logstash 5.4+`
 ```sh
-bin/logstash-plugin install logstash-output-opsgenie
+bin/logstash-plugin install flexciton-logstash-output-opsgenie
 ```
 - `Other Versions`
 ```sh
-bin/plugin install logstash-output-opsgenie
+bin/plugin install flexciton-logstash-output-opsgenie
 ```
 
 - OpsGenie has an integration with Logstash. To use the plugin you need to add a [Logstash Integration](https://app.opsgenie.com/integration?add=Logstash) in OpsGenie and obtain the API Key.
 
-- You may use plugins like [Mutate](https://www.elastic.co/guide/en/logstash/current/plugins-filters-mutate.html) to populate the fields which will be used in [logstash-output-opsgenie](https://github.com/opsgenie/logstash-output-opsgenie).
+- You may use plugins like [Mutate](https://www.elastic.co/guide/en/logstash/current/plugins-filters-mutate.html) to populate the fields which will be used in [flexciton-logstash-output-opsgenie](https://github.com/flexciton/logstash-output-opsgenie).
 ```filter {
   mutate{
     add_field => {
@@ -43,11 +50,14 @@ bin/plugin install logstash-output-opsgenie
 }
 ```
 
-- Add the following configuration to your configuration file and populate "apiKey" field with your Logstash Integration API Key
+- Add the following configuration to your configuration file and populate `apiKey` field with your Logstash Integration API Key
+
+NOTE: despite the integration document in Atlassian shows that api key should be wrapped in quotes (`"apiKey"`) - this is not the case. Use `apiKey` as shown below please.
+
 ```sh
 output {
 	opsgenie {
-		"apiKey" => "logstash_integration_api_key"
+		apiKey => "logstash_integration_api_key"
 	}
 }
 ```

data/lib/logstash/outputs/opsgenie.rb

@@ -7,10 +7,11 @@ require "net/http"
 require "net/https"
 
 
-HTTP_EXCEPTIONS = [
+CATCHABLE_EXCEPTIONS = [
   Errno::EINVAL,
   Net::HTTPBadResponse,
   Net::HTTPHeaderSyntaxError,
+  JSON::ParserError,
 ]
 
 RETRYABLE_HTTP_EXCEPTIONS = [
@@ -204,7 +205,11 @@ class LogStash::Outputs::OpsGenie < LogStash::Outputs::Base
         )
         request.body = params.to_json
         response = http.request(request)
-      rescue *HTTP_EXCEPTIONS => e
+
+        body = response.body
+        body = JSON.parse(body)
+        @logger.warn("Executed [#{uri}]. Response:[#{body}]")
+      rescue *CATCHABLE_EXCEPTIONS => e
         @logger.warn("Silencing exception in logstash opsgenie outputs: [#{e.class}: #{e.message}]")
         return
       rescue *RETRYABLE_HTTP_EXCEPTIONS => e
@@ -221,9 +226,6 @@ class LogStash::Outputs::OpsGenie < LogStash::Outputs::Base
         end
       end
 
-      body = response.body
-      body = JSON.parse(body)
-      @logger.warn("Executed [#{uri}]. Response:[#{body}]")
     end
   end # def executePost
 
@@ -231,7 +233,7 @@ class LogStash::Outputs::OpsGenie < LogStash::Outputs::Base
   def receive(event)
     return unless output?(event)
 
-    @logger.info("processing #{event}")
+    @logger.info("processing event: #{event}")
     opsGenieAction = event.get(@actionAttribute) if event.get(@actionAttribute)
     if opsGenieAction then
       params = {}
@@ -286,9 +288,9 @@ class LogStash::Outputs::OpsGenie < LogStash::Outputs::Base
 
   private
   def exponentialBackoff(retryCount)
-    nap = (2**retryCount - 1) / 2
-    @logger.info("sleeping for #{'%.2f' % nap} seconds")
-    sleep nap
+    seconds_to_sleep = (2**retryCount - 1) / 2
+    @logger.info("sleeping for #{'%.2f' % seconds_to_sleep} seconds")
+    sleep seconds_to_sleep
   end
 
 end # class LogStash::Outputs::OpsGenie

data/logstash-output-opsgenie.gemspec

@@ -1,12 +1,11 @@
 Gem::Specification.new do |s|
   s.name = 'flexciton-logstash-output-opsgenie'
-  s.version         = '1.0.0'
-  s.licenses = ["Apache License (2.0)"]
-  s.summary = "This output Creates, Closes, Acknowledges alerts and Adds Note to alerts in OpsGenie."
-  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"
-  s.authors = ["Elastic"]
-  s.email = "info@elastic.co"
-  s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.version = '2.0.0'
+  s.licenses = ["Apache-2.0"]
+  s.summary = "Flexciton Logstash Output Opsgenie plugin allows creation, closing, acknowledging and adding notes to alerts in OpsGenie."
+  s.description = "Install this gem on your Logstash instance with: $LS_HOME/bin/logstash-plugin install flexciton-logstash-output-opsgenie. Includes retry and silencing mechanism for network errors."
+  s.authors = ["Flexciton Ltd, Tomasz Kluczkowski"]
+  s.homepage = "https://github.com/flexciton/logstash-output-opsgenie"
   s.require_paths = ["lib"]
 
   # Files

data/spec/outputs/opsgenie_spec.rb

@@ -10,43 +10,91 @@ describe LogStash::Outputs::OpsGenie do
 
   describe "receive message" do
 
-    it "when opsgenieAction is not specified" do
+    it "warns when opsgenieAction is not specified" do
       expect(logger).to receive(:warn).with("No opsgenie action defined").once
-      subject.receive({"message" => "test_alert","@version" => "1","@timestamp" => "2015-09-22T11:20:00.250Z"})
+
+      event_data = {"message" => "test_alert","@version" => "1","@timestamp" => "2015-09-22T11:20:00.250Z"}
+      subject.receive(LogStash::Event.new(event_data))
     end
 
-    it "when opsgenieAction is not valid" do
+    it "warns when opsgenieAction is not valid" do
       action = "invalid"
       expect(logger).to receive(:warn).with("Action #{action} does not match any available action, discarding..").once
-      subject.receive({"message" => "test_alert","@version" => "1","@timestamp" => "2015-09-22T11:20:00.250Z", "opsgenieAction" => action})
+
+      event_data = {
+        "@timestamp" => "2015-09-22T11:20:00.250Z",
+        "message" => "test_alert",
+        "@version" => "1",
+        "opsgenieAction" => action
+      }
+      subject.receive(LogStash::Event.new(event_data))
     end
 
-    it "when opsGenieAction is 'create'" do
-      event = {"message" => "test_alert", "@version" => "1", "@timestamp" => "2015-09-22T11:20:00.250Z", "opsgenieAction" => "create"}
-      expect(logger).to receive(:info).with("processing #{event}").once
-      expect(logger).to receive(:info).with("Executing url #{subject.opsGenieBaseUrl}#{subject.createActionUrl}").once
-      subject.receive(event)
+    it "logs event when opsGenieAction is 'create'" do
+      event_data = {
+        "@timestamp" => "2015-09-22T11:20:00.250Z",
+        "host" => "my-mac",
+        "message" => "test_alert",
+        "@version" => "1",
+        "opsgenieAction" => "create"
+      }
+      expect(logger).to receive(:info).with(
+        "processing event: #{event_data['@timestamp']} #{event_data['host']} #{event_data['message']}"
+      ).once
+      expect(logger).to receive(:info).with("Executing url #{subject.opsGenieBaseUrl}").once
+
+      subject.receive(LogStash::Event.new(event_data))
     end
 
-    it "when opsGenieAction is 'close'" do
-      event = {"message" => "test_alert", "@version" => "1", "@timestamp" => "2015-09-22T11:20:00.250Z", "opsgenieAction" => "close"}
-      expect(logger).to receive(:info).with("processing #{event}").once
-      expect(logger).to receive(:info).with("Executing url #{subject.opsGenieBaseUrl}#{subject.closeActionUrl}").once
-      subject.receive(event)
+    it "logs event when opsGenieAction is 'close'" do
+      event_data = {
+        "@timestamp" => "2015-09-22T11:20:00.250Z",
+        "host" => "my-mac",
+        "message" => "test_alert",
+        "@version" => "1",
+        "opsgenieAction" => "close"
+      }
+      expect(logger).to receive(:info).with(
+        "processing event: #{event_data['@timestamp']} #{event_data['host']} #{event_data['message']}"
+      ).once
+      expect(logger).to receive(:info).with(
+        "Executing url #{subject.opsGenieBaseUrl}#{subject.closeActionPath}?identifierType=#{subject.identifierType}"
+      ).once
+      subject.receive(LogStash::Event.new(event_data))
     end
 
-    it "when opsGenieAction is 'acknowledge'" do
-      event = {"message" => "test_alert", "@version" => "1", "@timestamp" => "2015-09-22T11:20:00.250Z", "opsgenieAction" => "acknowledge"}
-      expect(logger).to receive(:info).with("processing #{event}").once
-      expect(logger).to receive(:info).with("Executing url #{subject.opsGenieBaseUrl}#{subject.acknowledgeActionUrl}").once
-      subject.receive(event)
+    it "logs event when opsGenieAction is 'acknowledge'" do
+      event_data = {
+        "@timestamp" => "2015-09-22T11:20:00.250Z",
+        "host" => "my-mac",
+        "message" => "test_alert",
+        "@version" => "1",
+        "opsgenieAction" => "acknowledge"
+      }
+      expect(logger).to receive(:info).with(
+        "processing event: #{event_data['@timestamp']} #{event_data['host']} #{event_data['message']}"
+      ).once
+      expect(logger).to receive(:info).with(
+        "Executing url #{subject.opsGenieBaseUrl}#{subject.acknowledgeActionPath}?identifierType=#{subject.identifierType}"
+      ).once
+      subject.receive(LogStash::Event.new(event_data))
     end
 
-    it "when opsGenieAction is 'note'" do
-      event = {"message" => "test_alert", "@version" => "1", "@timestamp" => "2015-09-22T11:20:00.250Z", "opsgenieAction" => "note"}
-      expect(logger).to receive(:info).with("processing #{event}").once
-      expect(logger).to receive(:info).with("Executing url #{subject.opsGenieBaseUrl}#{subject.noteActionUrl}").once
-      subject.receive(event)
+    it "logs event when opsGenieAction is 'note'" do
+      event_data = {
+        "@timestamp" => "2015-09-22T11:20:00.250Z",
+        "host" => "my-mac",
+        "message" => "test_alert",
+        "@version" => "1",
+        "opsgenieAction" => "note"
+      }
+      expect(logger).to receive(:info).with(
+        "processing event: #{event_data['@timestamp']} #{event_data['host']} #{event_data['message']}"
+      ).once
+      expect(logger).to receive(:info).with(
+        "Executing url #{subject.opsGenieBaseUrl}#{subject.noteActionPath}?identifierType=#{subject.identifierType}"
+      ).once
+      subject.receive(LogStash::Event.new(event_data))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexciton-logstash-output-opsgenie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
-- Elastic
+- Flexciton Ltd, Tomasz Kluczkowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-01 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -58,10 +58,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-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
-email: info@elastic.co
+description: 'Install this gem on your Logstash instance with: $LS_HOME/bin/logstash-plugin
+  install flexciton-logstash-output-opsgenie. Includes retry and silencing mechanism
+  for network errors.'
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -74,9 +74,9 @@ files:
 - lib/logstash/outputs/opsgenie.rb
 - logstash-output-opsgenie.gemspec
 - spec/outputs/opsgenie_spec.rb
-homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+homepage: https://github.com/flexciton/logstash-output-opsgenie
 licenses:
-- Apache License (2.0)
+- Apache-2.0
 metadata:
   logstash_plugin: 'true'
   logstash_group: output
@@ -95,10 +95,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: This output Creates, Closes, Acknowledges alerts and Adds Note to alerts
-  in OpsGenie.
+summary: Flexciton Logstash Output Opsgenie plugin allows creation, closing, acknowledging
+  and adding notes to alerts in OpsGenie.
 test_files:
 - spec/outputs/opsgenie_spec.rb