logstash-output-opsgenienm 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 222f15826dccac154652a9e879669eba0535adfaf15205125b628ee47b7ed4d8
+  data.tar.gz: 45a4239dfbf280bcc8593ffbdb0e15ee9039637f55d23010b2aa3f9c7d058ef7
+SHA512:
+  metadata.gz: 5fb7f7c846a81a91677fdd25846b8ecc14992511ff7db3ad4b740ef7900f68bc7684add7054a025f7abe11c45fe39259973a4831bc33d82854403ec1cc37a836
+  data.tar.gz: 59740fc4d0b8eaf809ee535dcab73d14e2cc7f91e638b12bb9dbfb9a0494bfd7a080aa79c7e7bd009433bbbe859f8ffdd26dc5c8d28f3d70a5640b7060721dc7

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,28 @@
+# OpsGenie Logstash No Mutate Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash). It's
+base on OpsGenie original plugin. The only difference is that you do not have
+to modify your events to add OpsGenie specific fields to them.
+
+### Install and Run OpsGenie Output Plugin in Logstash
+
+OpsGenie Logstash Output plugin is available in
+[RubyGems.org](https://rubygems.org/gems/logstash-output-opsgenienm)
+
+- Install plugin
+```sh
+bin/plugin install logstash-output-opsgenienm
+```
+
+- OpsGenie has Logstash Integration. 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.
+- Add the following configuration to your configuration file
+
+```sh
+output {
+	opsgenie {
+		"api_key" => "logstash_integration_api_key"
+	}
+}
+```

data/lib/logstash/outputs/opsgenie.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+require 'logstash/outputs/base'
+require 'logstash/namespace'
+require 'json'
+require 'uri'
+require 'net/http'
+require 'net/https'
+
+# For more information about the api requests and their contents,
+# please refer to Alert API("https://www.opsgenie.com/docs/web-api/alert-api") support doc.
+
+class LogStash::Outputs::OpsGenie < LogStash::Outputs::Base
+
+  config_name 'opsgenie'
+
+  # OpsGenie Logstash Integration API Key
+  config :api_key, :validate => :string, :required => true
+
+  # OpsGenie API action
+  config :opsgenie_action, :validate => ["create", "close", "acknowledge", "note"], :default => "create"
+
+  # Host of opsgenie api, normally you should not need to change this field.
+  config :opsgenie_base_url, :validate => :string, :required => false, :default => 'https://api.opsgenie.com'
+
+  # Url will be used to create alerts in OpsGenie
+  config :create_action_url, :validate => :string, :required => false, :default => '/v1/json/alert'
+
+  # Url will be used to close alerts in OpsGenie
+  config :close_action_url, :validate => :string, :required => false, :default => '/v1/json/alert/close'
+
+  # Url will be used to acknowledge alerts in OpsGenie
+  config :acknowledge_action_url, :validate => :string, :required => false, :default => '/v1/json/alert/acknowledge'
+
+  # Url will be used to add notes to alerts in OpsGenie
+  config :note_action_url, :validate => :string, :required => false, :default => '/v1/json/alert/note'
+
+  # OpsGenie alert id
+  config :alert_id, :validate => :string, :required => false
+
+  # Alias of the alert that actions will be executed.
+  config :alert_alias, :validate => :string, :required => false
+
+  # Alert text.
+  config :message, :validate => :string, :required => true
+
+  # List of team names which will be responsible for the alert.
+  config :teams, :validate => :string, :required => false
+
+  # Detailed description of the alert.
+  config :description, :validate => :string, :required => false
+
+  # Optional user, group, schedule or escalation names to calculate which users will receive the notifications of the alert.
+  config :recipients, :validate => :string, :required => false
+
+  # Comma separated list of actions that can be executed on the alert.
+  config :actions, :validate => :string, :required => false
+
+  # Source of alert.
+  config :source, :validate => :string, :required => false
+
+  # Comma separated list of labels attached to the alert.
+  config :tags, :validate => :string, :required => false
+
+  # Set of user defined alert properties.
+  config :details, :validate => :hash, :default => {"description" => "%{description}"}
+
+  public
+  def register
+    opsgenie_uri = URI.parse(@opsgenie_base_url)
+    @client = Net::HTTP.new(opsgenie_uri.host, opsgenie_uri.port)
+    if opsgenie_uri.scheme == 'https'
+      @client.use_ssl = true
+      @client.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+  end # def register
+
+  public
+  def receive(event)
+    alert = {
+      :apiKey => @api_key
+    }
+    case @opsgenie_action
+    when 'create'
+      action_path = @create_action_url
+      alert[:message] = event.sprintf(@message)
+      alert[:teams] = @teams if @teams
+      alert[:actions] = @actions if @actions
+      alert[:description] = event.sprintf(@description) if @description
+      alert[:recipients] = @recipients if @recipients
+      alert[:tags] = @tags if @tags
+      alert[:details] = {}
+      @details.each do |key, value|
+        alert[:details]["#{key}"] = event.sprintf(value)
+      end
+    when 'close'
+      action_path = @close_action_url
+    when 'acknowledge'
+      action_path = @acknowledge_action_url
+    when 'note'
+      action_path = @note_action_url
+    end
+
+    alert['alias'] = event.sprintf(@alert_alias) if @alert_alias
+    alert['id'] = event.sprintf(@alert_id) if @alert_id
+
+    begin
+      request = Net::HTTP::Post.new(action_path)
+      request.body = LogStash::Json.dump(alert)
+      @logger.debug('OpsGenie Request', :request => request.inspect)
+      response = @client.request(request)
+      @logger.debug('OpsGenie Response', :response => response.body)
+    rescue Exception => e
+      @logger.error('OpsGenie Unhandled exception', :og_error => e.backtrace)
+    end
+  end # def receive
+end # class LogStash::Outputs::OpsGenie

data/logstash-output-opsgenienm.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-opsgenienm'
+  s.version         = '1.0.1'
+  s.licenses = ["Apache-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/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.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/opsgenie_spec.rb

@@ -0,0 +1,11 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/opsgenie"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::OpsGenie do
+
+  subject {LogStash::Outputs::OpsGenie.new( "api_key" => "my_api_key" )}
+  let(:logger) { subject.logger}
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-opsgenienm
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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/plugin install gemname. This gem is not
+  a stand-alone program
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/outputs/opsgenie.rb
+- logstash-output-opsgenienm.gemspec
+- spec/outputs/opsgenie_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.11
+signing_key:
+specification_version: 4
+summary: This output Creates, Closes, Acknowledges alerts and Adds Note to alerts
+  in OpsGenie.
+test_files:
+- spec/outputs/opsgenie_spec.rb