IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Graphtastic output plugin Http output plugin »

› ›

Hipchat output plugin

edit

Hipchat output plugin

edit

Plugin version: v4.0.3
Released on: 2017-06-23
Changelog

Getting Help

edit

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.

Description

edit

This output allows you to write events to HipChat.

Make sure your API token have the appropriate permissions and support sending messages.

Hipchat Output Configuration Options

edit

This plugin supports the following configuration options plus the Common Options described later.

Setting	Input type	Required
`color`	string	No
`format`	string	No
`from`	string	No
`host`	string	No
`message_format`	string, one of `["html", "text"]`	No
`room_id`	string	Yes
`token`	string	Yes
`trigger_notify`	boolean	No

Also see Common Options for a list of options supported by all output plugins.

`color`

edit

Value type is string
Default value is "yellow"

Background color for message. HipChat currently supports one of "yellow", "red", "green", "purple", "gray", or "random". (default: yellow), support fieldref

`format`

edit

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

Message format to send, event tokens are usable here.

`from`

edit

Value type is string
Default value is "logstash"

The name the message will appear be sent from, you can use fieldref

`host`

edit

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

HipChat host to use

`message_format`

edit

Value can be any of: html, text
Default value is "html"

Specify Message Format

`room_id`

edit

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

The ID or name of the room, support fieldref

`token`

edit

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

The HipChat authentication token.

`trigger_notify`

edit

Value type is boolean
Default value is false

Whether or not this message should trigger a notification for people in the room.

Common Options

edit

The following configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`workers`	number	No

`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.

`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.

`id`

edit

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 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

`workers`

edit

Value type is string
Default value is 1

« Graphtastic output plugin Http output plugin »