redmine

edit
  • Version: 3.0.0
  • Released on: 2016-09-10
  • Changelog
  • Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-redmine.

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

edit

This plugin supports the following configuration options:

Required configuration options:

redmine {
    priority_id => ...
    project_id => ...
    status_id => ...
    token => ...
    tracker_id => ...
    url => ...
}

Available configuration options:

Setting Input type Required Default value

assigned_to_id

number

No

nil

categorie_id

number

No

nil

codec

codec

No

"plain"

description

string

No

"%{message}"

enable_metric

boolean

No

true

fixed_version_id

number

No

nil

id

string

No

parent_issue_id

number

No

nil

priority_id

number

Yes

project_id

number

Yes

ssl

boolean

No

false

status_id

number

Yes

subject

string

No

"%{host}"

token

string

Yes

tracker_id

number

Yes

url

string

Yes

workers

<<,>>

No

1

Details

edit

 

assigned_to_id

edit
  • Value type is number
  • Default value is nil

redmine issue assigned_to not required for post_issue

categorie_id

edit
  • Value type is number
  • Default value is nil

not required for post_issue

codec

edit
  • 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

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

redmine issue description required

enable_metric

edit
  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

fixed_version_id

edit
  • Value type is number
  • Default value is nil

redmine issue fixed_version_id

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

parent_issue_id

edit
  • Value type is number
  • Default value is nil

redmine issue parent_issue_id not required for post_issue

priority_id

edit
  • This is a required setting.
  • Value type is number
  • There is no default value for this setting.

redmine issue priority_id required

project_id

edit
  • This is a required setting.
  • Value type is number
  • There is no default value for this setting.

redmine issue projet_id required

ssl

edit
  • Value type is boolean
  • Default value is false

status_id

edit
  • This is a required setting.
  • Value type is number
  • There is no default value for this setting.

redmine issue status_id required

subject

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

redmine issue subject required

token

edit
  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

redmine token user used for authentication

tracker_id

edit
  • This is a required setting.
  • Value type is number
  • There is no default value for this setting.

redmine issue tracker_id required

url

edit
  • This is a 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

edit
  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne