logstash-output-pagerduty 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d14974f0526ad0234d1f3c5b5c2418465e36e01b
-  data.tar.gz: 49901c3cbde49abc8379e54e7011685a78dd1c5f
+SHA256:
+  metadata.gz: 7498f228ec973d97c7346f02b71d5062f4c47baaef4a96660603623e48912971
+  data.tar.gz: c9acdb75562c68b3755589a93b43e4b642dacdbc791aecebb85389ee4fbbed30
 SHA512:
-  metadata.gz: 09c2f1b1133db0453b6af9079fb05d7efb2634270f823c5ae01076b975c76d8d1a4aab36ca38731707be34a47572663ed16f51dba35c0637b98897030aa7c899
-  data.tar.gz: 3bbefa94da0299471b5afc81f02737a718128b8af53e59d067f95c7a5eae6dbd2b61640ab8651df13280965e2003febed109a47755ef101a58a24fb1546ff846
+  metadata.gz: 26adf42ab8756d2d91abc5848ebd08ffe5473d292761fca1fa300ecbea658626d1e40ead93d1052f9ada9804d74db12706c9cac5780a3f5148af7eb7736e47fb
+  data.tar.gz: b33c2bac97d7c129b251327b6a2a251a7cb18f5a6d0f185adfc1b1fd22cca3704dc478b553be17da8af4fe81c0b8b49df93a309c28d91730275a17d0b88b1068

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,105 @@
+:plugin: pagerduty
+:type: output
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Pagerduty output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+The PagerDuty output will send notifications based on pre-configured services
+and escalation policies. Logstash can send "trigger", "acknowledge" and "resolve"
+event types. In addition, you may configure custom descriptions and event details.
+The only required field is the PagerDuty "Service API Key", which can be found on
+the service's web page on pagerduty.com. In the default case, the description and
+event details will be populated by Logstash, using `message`, `timestamp` and `host` data.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Pagerduty Output Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-description>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-details>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-event_type>> |<<string,string>>, one of `["trigger", "acknowledge", "resolve"]`|No
+| <<plugins-{type}s-{plugin}-incident_key>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-pdurl>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-service_key>> |<<string,string>>|Yes
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-description"]
+===== `description` 
+
+  * Value type is <<string,string>>
+  * Default value is `"Logstash event for %{host}"`
+
+Custom description
+
+[id="plugins-{type}s-{plugin}-details"]
+===== `details` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{"timestamp"=>"%{@timestamp}", "message"=>"%{message}"}`
+
+The event details. These might be data from the Logstash event fields you wish to include.
+Tags are automatically included if detected so there is no need to explicitly add them here.
+
+[id="plugins-{type}s-{plugin}-event_type"]
+===== `event_type` 
+
+  * Value can be any of: `trigger`, `acknowledge`, `resolve`
+  * Default value is `"trigger"`
+
+Event type
+
+[id="plugins-{type}s-{plugin}-incident_key"]
+===== `incident_key` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logstash/%{host}/%{type}"`
+
+The service key to use. You'll need to set this up in PagerDuty beforehand.
+
+[id="plugins-{type}s-{plugin}-pdurl"]
+===== `pdurl` 
+
+  * Value type is <<string,string>>
+  * Default value is `"https://events.pagerduty.com/generic/2010-04-15/create_event.json"`
+
+PagerDuty API URL. You shouldn't need to change this, but is included to allow for flexibility
+should PagerDuty iterate the API and Logstash hasn't been updated yet.
+
+[id="plugins-{type}s-{plugin}-service_key"]
+===== `service_key` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The PagerDuty Service API Key
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-pagerduty.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-pagerduty'
-  s.version         = '3.0.3'
+  s.version         = '3.0.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "The PagerDuty output will send notifications based on pre-configured services and escalation policies."
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-pagerduty
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +72,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.21.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
+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
 executables: []
 extensions: []
@@ -84,6 +86,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/pagerduty.rb
 - logstash-output-pagerduty.gemspec
 - spec/outputs/pagerduty_spec.rb
@@ -110,10 +113,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key:
 specification_version: 4
-summary: The PagerDuty output will send notifications based on pre-configured services and escalation policies.
+summary: The PagerDuty output will send notifications based on pre-configured services
+  and escalation policies.
 test_files:
 - spec/outputs/pagerduty_spec.rb
 - spec/spec_helper.rb