redmine

Milestone: 1

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

The redmine output is used to create a ticket via the API redmine.

It send a POST request in a JSON format and use TOKEN authentication

– Exemple of use –

output { redmine { url => “http://redmineserver.tld” token => ‘token’ project_id => 200 tracker_id => 1 status_id => 3 priority_id => 2 subject => “Error … detected” } }

Synopsis

This is what it might look like in your config file:
output {
  redmine {
    assigned_to_id => ... # number (optional), default: nil
    categorie_id => ... # number (optional), default: nil
    codec => ... # codec (optional), default: "plain"
    description => ... # string (optional), default: "%{message}"
    fixed_version_id => ... # number (optional), default: nil
    parent_issue_id => ... # number (optional), default: nil
    priority_id => ... # number (required)
    project_id => ... # number (required)
    ssl => ... # boolean (optional), default: false
    status_id => ... # number (required)
    subject => ... # string (optional), default: "%{host}"
    token => ... # string (required)
    tracker_id => ... # number (required)
    url => ... # string (required)
    workers => ... # number (optional), default: 1
  }
}

Details

assigned_to_id

  • Value type is number
  • Default value is nil

redmine issue assigned_to not required for post_issue

categorie_id

  • Value type is number
  • Default value is nil

not required for post_issue

codec

  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

description

  • Value type is string
  • Default value is "%{message}"

redmine issue description required

exclude_tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

fixed_version_id

  • Value type is number
  • Default value is nil

redmine issue fixed_version_id

parent_issue_id

  • Value type is number
  • Default value is nil

redmine issue parent_issue_id not required for post_issue

priority_id (required setting)

  • Value type is number
  • There is no default value for this setting.

redmine issue priority_id required

project_id (required setting)

  • Value type is number
  • There is no default value for this setting.

redmine issue projet_id required

ssl

  • Value type is boolean
  • Default value is false

status_id (required setting)

  • Value type is number
  • There is no default value for this setting.

redmine issue status_id required

subject

  • Value type is string
  • Default value is "%{host}"

redmine issue subject required

tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

token (required setting)

  • Value type is string
  • There is no default value for this setting.

redmine token user used for authentication

tracker_id (required setting)

  • Value type is number
  • There is no default value for this setting.

redmine issue tracker_id required

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

url (required setting)

  • Value type is string
  • There is no default value for this setting.

host of redmine app value format : ‘http://urlofredmine.tld’ - Not add ‘/issues’ at end

workers

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.


This is documentation from lib/logstash/outputs/redmine.rb