:plugin: jira
:type: output
:default_codec: plain

///////////////////////////////////////////
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}s-{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[]

:default_codec!: