lib/logstash/outputs/jira.rb in logstash-output-jira-3.0.0 vs lib/logstash/outputs/jira.rb in logstash-output-jira-3.0.1
- old
+ new
@@ -8,10 +8,12 @@
#
# 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",
@@ -23,13 +25,16 @@
# "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!
@@ -46,25 +51,26 @@
# 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>.
-
+#
class LogStash::Outputs::Jira < LogStash::Outputs::Base
config_name "jira"
# The hostname to send logs to. This should target your JIRA server
- # and has to have the REST interface enabled
+ # and has to have the REST interface enabled.
config :host, :validate => :string
config :username, :validate => :string, :required => true
config :password, :validate => :string, :required => true