Redmine output plugin
- Plugin version: v3.0.4
- Released on: 2018-04-06
- Changelog
For other versions, see the Versioned plugin docs.
For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-redmine
. See Working with plugins for more details.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
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"
}
}
This plugin supports the following configuration options plus the Common options described later.
Setting | Input type | Required |
---|---|---|
assigned_to_id |
number | No |
categorie_id |
number | No |
description |
string | No |
fixed_version_id |
number | No |
parent_issue_id |
number | No |
priority_id |
number | Yes |
project_id |
number | Yes |
ssl |
boolean | No |
status_id |
number | Yes |
subject |
string | No |
token |
string | Yes |
tracker_id |
number | Yes |
url |
string | Yes |
Also see Common options for a list of options supported by all output plugins.
- Value type is number
- Default value is
nil
redmine issue assigned_to not required for post_issue
- Value type is number
- Default value is
nil
not required for post_issue
- Value type is string
- Default value is
"%{{message}}"
redmine issue description required
- Value type is number
- Default value is
nil
redmine issue fixed_version_id
- Value type is number
- Default value is
nil
redmine issue parent_issue_id not required for post_issue
- This is a required setting.
- Value type is number
- There is no default value for this setting.
redmine issue priority_id required
- This is a required setting.
- Value type is number
- There is no default value for this setting.
redmine issue projet_id required
- Value type is boolean
- Default value is
false
- This is a required setting.
- Value type is number
- There is no default value for this setting.
redmine issue status_id required
- Value type is string
- Default value is
%{{host}}
redmine issue subject required
- This is a required setting.
- Value type is string
- There is no default value for this setting.
redmine token user used for authentication
- This is a required setting.
- Value type is number
- There is no default value for this setting.
redmine issue tracker_id required
- 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
These configuration options are supported by all output plugins:
- 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.
- 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.
- Value type is string
- There is no default value for this setting.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 redmine outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output {
redmine {
id => "my_plugin_id"
}
}
Variable substitution in the id
field only supports environment variables and does not support the use of values from the secret store.