logstash-output-jira 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c0e7c45719a36787003f5a0e5a29462c996ddb1
-  data.tar.gz: 9b0acff84d55071794b5df180ed49203f33a68da
+  metadata.gz: 9e71e7587884edf8fcb0229330ef494f40970fc8
+  data.tar.gz: 4b3fbcb734caf86e2313a72801b161c39f44bf01
 SHA512:
-  metadata.gz: 67ba886638ffad691ca67e4b314b800ff476fe9f7bfdcbe0c73a6347e54bbae85c1515c857beb3018acf883febfaeb02d4e9af47f9595219018de799c1b0094e
-  data.tar.gz: 2b827f695d694c943530f708cc9b1bf2a9a054c67db75e4db98334cda5ab72cb0ec81094ea8f646f8f18615e3be40fc43d497b46a1a6fc6c13eb0881fadeef4c
+  metadata.gz: f5ea012c9b3aaf5f98dceb5efcc074404a57b0e293eff9faef0e96902f7a94f07e41d21a54df02c33c05d9973b0deb2868a004280784a44c5e7663075baab694
+  data.tar.gz: ed8513cb3b309a3beb1d868f374609008c37e57940fba6414a31ed77d54a40e6eb84a8d7233278df911e28f05030f6d5ed3bca51b5095c8999d8adceb4450089

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-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,195 @@
+:plugin: jira
+: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}"]
+
+=== Jira output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This output allows you to use Logstash to parse and structure
+your logs and ship structured event data to JIRA.
+
+Structured event data will be added to the JIRA issue as 'Description' field value.
+
+Example JSON-encoded event:
+
+[source,yaml]
+-----------------------------------------------------------------------------
+    {
+      "message": "Hello JIRA!",
+      "@version": "1",
+      "@timestamp": "2015-06-04T10:23:30.279Z",
+      "type": "syslog",
+      "host": "192.168.1.42",
+      "syslog_pri": "11",
+      "syslog_timestamp": "Jun  4 14:23:30",
+      "syslog_host": "myhost",
+      "program": "root",
+      "syslog_severity_code": 3,
+      "syslog_facility_code": 1,
+      "syslog_facility": "user-level",
+      "syslog_severity": "error"
+    }
+-----------------------------------------------------------------------------
+
+Example JIRA issue created the event above:
+
+[source,shell]
+-----------------------------------------------------------------------------
+    Type:        Task
+    Priority:    2 - Major
+    Status:      TO DO
+    Resolution:  Unresolved
+    Summary:     [logstash] Hello JIRA!
+    Description:
+        ---
+        message: Hello JIRA!
+        '@version': '1'
+        '@timestamp': 2015-06-04 10:23:30.279000000 Z
+        type: syslog
+        host: 192.168.1.42
+        syslog_pri: '11'
+        syslog_timestamp: Jun 4 14:23:30
+        syslog_host: myhost
+        program: root
+        syslog_severity_code: 3
+        syslog_facility_code: 1
+        syslog_facility: user-level
+        syslog_severity: error
+-----------------------------------------------------------------------------
+
+To use this output you'll need to ensure that your JIRA instance allows REST calls.
+
+This output uses `jiralicious` as the bridge to JIRA
+By Martin Cleaver, Blended Perspectives
+with a lot of help from 'electrical' in #logstash.
+
+Origin <https://groups.google.com/forum/#!msg/logstash-users/exgrB4iQ-mw/R34apku5nXsJ>
+and <https://botbot.me/freenode/logstash/msg/4169496/>
+via <https://gist.github.com/electrical/4660061e8fff11cdcf37#file-jira-rb>.
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Jira 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}-assignee>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-issuetypeid>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-password>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-priority>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-projectid>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-reporter>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-summary>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-username>> |<<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}-assignee"]
+===== `assignee` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+JIRA Reporter
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The hostname to send logs to. This should target your JIRA server 
+and has to have the REST interface enabled.
+
+[id="plugins-{type}s-{plugin}-issuetypeid"]
+===== `issuetypeid` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+JIRA Issuetype number
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+
+
+[id="plugins-{type}s-{plugin}-priority"]
+===== `priority` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+JIRA Priority
+
+[id="plugins-{type}s-{plugin}-projectid"]
+===== `projectid` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Javalicious has no proxy support
+JIRA Project number
+
+[id="plugins-{type}s-{plugin}-reporter"]
+===== `reporter` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+JIRA Reporter
+
+[id="plugins-{type}s-{plugin}-summary"]
+===== `summary` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+JIRA Summary
+
+Truncated and appended with '...' if longer than 255 characters.
+
+[id="plugins-{type}s-{plugin}-username"]
+===== `username` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-jira.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-jira'
-  s.version         = '3.0.1'
+  s.version         = '3.0.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Create jira tickets based on events"
   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"
@@ -10,7 +10,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-jira
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-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
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/jira.rb
 - logstash-output-jira.gemspec
 - spec/outputs/jira_spec.rb