logstash-output-jira 3.0.1 → 3.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +10 -1
  3. data/docs/index.asciidoc +195 -0
  4. data/logstash-output-jira.gemspec +2 -2
  5. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8c0e7c45719a36787003f5a0e5a29462c996ddb1
4
- data.tar.gz: 9b0acff84d55071794b5df180ed49203f33a68da
3
+ metadata.gz: 9e71e7587884edf8fcb0229330ef494f40970fc8
4
+ data.tar.gz: 4b3fbcb734caf86e2313a72801b161c39f44bf01
5
5
  SHA512:
6
- metadata.gz: 67ba886638ffad691ca67e4b314b800ff476fe9f7bfdcbe0c73a6347e54bbae85c1515c857beb3018acf883febfaeb02d4e9af47f9595219018de799c1b0094e
7
- data.tar.gz: 2b827f695d694c943530f708cc9b1bf2a9a054c67db75e4db98334cda5ab72cb0ec81094ea8f646f8f18615e3be40fc43d497b46a1a6fc6c13eb0881fadeef4c
6
+ metadata.gz: f5ea012c9b3aaf5f98dceb5efcc074404a57b0e293eff9faef0e96902f7a94f07e41d21a54df02c33c05d9973b0deb2868a004280784a44c5e7663075baab694
7
+ data.tar.gz: ed8513cb3b309a3beb1d868f374609008c37e57940fba6414a31ed77d54a40e6eb84a8d7233278df911e28f05030f6d5ed3bca51b5095c8999d8adceb4450089
data/Gemfile CHANGED
@@ -1,2 +1,11 @@
1
1
  source 'https://rubygems.org'
2
- gemspec
2
+
3
+ gemspec
4
+
5
+ logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
6
+ use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
7
+
8
+ if Dir.exist?(logstash_path) && use_logstash_source
9
+ gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
10
+ gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
11
+ end
data/docs/index.asciidoc ADDED
@@ -0,0 +1,195 @@
1
+ :plugin: jira
2
+ :type: output
3
+
4
+ ///////////////////////////////////////////
5
+ START - GENERATED VARIABLES, DO NOT EDIT!
6
+ ///////////////////////////////////////////
7
+ :version: %VERSION%
8
+ :release_date: %RELEASE_DATE%
9
+ :changelog_url: %CHANGELOG_URL%
10
+ :include_path: ../../../../logstash/docs/include
11
+ ///////////////////////////////////////////
12
+ END - GENERATED VARIABLES, DO NOT EDIT!
13
+ ///////////////////////////////////////////
14
+
15
+ [id="plugins-{type}-{plugin}"]
16
+
17
+ === Jira output plugin
18
+
19
+ include::{include_path}/plugin_header.asciidoc[]
20
+
21
+ ==== Description
22
+
23
+ This output allows you to use Logstash to parse and structure
24
+ your logs and ship structured event data to JIRA.
25
+
26
+ Structured event data will be added to the JIRA issue as 'Description' field value.
27
+
28
+ Example JSON-encoded event:
29
+
30
+ [source,yaml]
31
+ -----------------------------------------------------------------------------
32
+ {
33
+ "message": "Hello JIRA!",
34
+ "@version": "1",
35
+ "@timestamp": "2015-06-04T10:23:30.279Z",
36
+ "type": "syslog",
37
+ "host": "192.168.1.42",
38
+ "syslog_pri": "11",
39
+ "syslog_timestamp": "Jun 4 14:23:30",
40
+ "syslog_host": "myhost",
41
+ "program": "root",
42
+ "syslog_severity_code": 3,
43
+ "syslog_facility_code": 1,
44
+ "syslog_facility": "user-level",
45
+ "syslog_severity": "error"
46
+ }
47
+ -----------------------------------------------------------------------------
48
+
49
+ Example JIRA issue created the event above:
50
+
51
+ [source,shell]
52
+ -----------------------------------------------------------------------------
53
+ Type: Task
54
+ Priority: 2 - Major
55
+ Status: TO DO
56
+ Resolution: Unresolved
57
+ Summary: [logstash] Hello JIRA!
58
+ Description:
59
+ ---
60
+ message: Hello JIRA!
61
+ '@version': '1'
62
+ '@timestamp': 2015-06-04 10:23:30.279000000 Z
63
+ type: syslog
64
+ host: 192.168.1.42
65
+ syslog_pri: '11'
66
+ syslog_timestamp: Jun 4 14:23:30
67
+ syslog_host: myhost
68
+ program: root
69
+ syslog_severity_code: 3
70
+ syslog_facility_code: 1
71
+ syslog_facility: user-level
72
+ syslog_severity: error
73
+ -----------------------------------------------------------------------------
74
+
75
+ To use this output you'll need to ensure that your JIRA instance allows REST calls.
76
+
77
+ This output uses `jiralicious` as the bridge to JIRA
78
+ By Martin Cleaver, Blended Perspectives
79
+ with a lot of help from 'electrical' in #logstash.
80
+
81
+ Origin <https://groups.google.com/forum/#!msg/logstash-users/exgrB4iQ-mw/R34apku5nXsJ>
82
+ and <https://botbot.me/freenode/logstash/msg/4169496/>
83
+ via <https://gist.github.com/electrical/4660061e8fff11cdcf37#file-jira-rb>.
84
+
85
+
86
+ [id="plugins-{type}s-{plugin}-options"]
87
+ ==== Jira Output Configuration Options
88
+
89
+ This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
90
+
91
+ [cols="<,<,<",options="header",]
92
+ |=======================================================================
93
+ |Setting |Input type|Required
94
+ | <<plugins-{type}s-{plugin}-assignee>> |<<string,string>>|No
95
+ | <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
96
+ | <<plugins-{type}s-{plugin}-issuetypeid>> |<<string,string>>|Yes
97
+ | <<plugins-{type}s-{plugin}-password>> |<<string,string>>|Yes
98
+ | <<plugins-{type}s-{plugin}-priority>> |<<string,string>>|Yes
99
+ | <<plugins-{type}s-{plugin}-projectid>> |<<string,string>>|Yes
100
+ | <<plugins-{type}s-{plugin}-reporter>> |<<string,string>>|No
101
+ | <<plugins-{type}s-{plugin}-summary>> |<<string,string>>|Yes
102
+ | <<plugins-{type}s-{plugin}-username>> |<<string,string>>|Yes
103
+ |=======================================================================
104
+
105
+ Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
106
+ output plugins.
107
+
108
+ &nbsp;
109
+
110
+ [id="plugins-{type}s-{plugin}-assignee"]
111
+ ===== `assignee`
112
+
113
+ * Value type is <<string,string>>
114
+ * There is no default value for this setting.
115
+
116
+ JIRA Reporter
117
+
118
+ [id="plugins-{type}s-{plugin}-host"]
119
+ ===== `host`
120
+
121
+ * Value type is <<string,string>>
122
+ * There is no default value for this setting.
123
+
124
+ The hostname to send logs to. This should target your JIRA server
125
+ and has to have the REST interface enabled.
126
+
127
+ [id="plugins-{type}s-{plugin}-issuetypeid"]
128
+ ===== `issuetypeid`
129
+
130
+ * This is a required setting.
131
+ * Value type is <<string,string>>
132
+ * There is no default value for this setting.
133
+
134
+ JIRA Issuetype number
135
+
136
+ [id="plugins-{type}s-{plugin}-password"]
137
+ ===== `password`
138
+
139
+ * This is a required setting.
140
+ * Value type is <<string,string>>
141
+ * There is no default value for this setting.
142
+
143
+
144
+
145
+ [id="plugins-{type}s-{plugin}-priority"]
146
+ ===== `priority`
147
+
148
+ * This is a required setting.
149
+ * Value type is <<string,string>>
150
+ * There is no default value for this setting.
151
+
152
+ JIRA Priority
153
+
154
+ [id="plugins-{type}s-{plugin}-projectid"]
155
+ ===== `projectid`
156
+
157
+ * This is a required setting.
158
+ * Value type is <<string,string>>
159
+ * There is no default value for this setting.
160
+
161
+ Javalicious has no proxy support
162
+ JIRA Project number
163
+
164
+ [id="plugins-{type}s-{plugin}-reporter"]
165
+ ===== `reporter`
166
+
167
+ * Value type is <<string,string>>
168
+ * There is no default value for this setting.
169
+
170
+ JIRA Reporter
171
+
172
+ [id="plugins-{type}s-{plugin}-summary"]
173
+ ===== `summary`
174
+
175
+ * This is a required setting.
176
+ * Value type is <<string,string>>
177
+ * There is no default value for this setting.
178
+
179
+ JIRA Summary
180
+
181
+ Truncated and appended with '...' if longer than 255 characters.
182
+
183
+ [id="plugins-{type}s-{plugin}-username"]
184
+ ===== `username`
185
+
186
+ * This is a required setting.
187
+ * Value type is <<string,string>>
188
+ * There is no default value for this setting.
189
+
190
+
191
+
192
+
193
+
194
+ [id="plugins-{type}s-{plugin}-common-options"]
195
+ include::{include_path}/{type}.asciidoc[]
data/logstash-output-jira.gemspec CHANGED
@@ -1,6 +1,6 @@
1
1
  Gem::Specification.new do |s|
2
2
  s.name = 'logstash-output-jira'
3
- s.version = '3.0.1'
3
+ s.version = '3.0.2'
4
4
  s.licenses = ['Apache License (2.0)']
5
5
  s.summary = "Create jira tickets based on events"
6
6
  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|
10
10
  s.require_paths = ["lib"]
11
11
 
12
12
  # Files
13
- s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
13
+ s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
14
14
 
15
15
  # Tests
16
16
  s.test_files = s.files.grep(%r{^(test|spec|features)/})
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-output-jira
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1
4
+ version: 3.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-02-15 00:00:00.000000000 Z
11
+ date: 2017-06-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
70
70
  - LICENSE
71
71
  - NOTICE.TXT
72
72
  - README.md
73
+ - docs/index.asciidoc
73
74
  - lib/logstash/outputs/jira.rb
74
75
  - logstash-output-jira.gemspec
75
76
  - spec/outputs/jira_spec.rb