IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« graphtastic http »
Elastic Docs ›Logstash Reference [5.2] ›Output plugins

hipchat

edit

hipchat

edit
  • Version: 4.0.2
  • Released on: 2016-07-14
  • Changelog

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

This output allows you to write events to HipChat.

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

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

hipchat {
    room_id => ...
    token => ...
}

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

color

string

No

"yellow"

enable_metric

boolean

No

true

format

string

No

"%{message}"

from

string

No

"logstash"

host

string

No

id

string

No

message_format

string, one of ["html", "text"]

No

"html"

room_id

string

Yes

token

string

Yes

trigger_notify

boolean

No

false

workers

<<,>>

No

1

Details

edit

 

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.

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

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.

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

id

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

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.

workers

edit
  • Value type is string
  • Default value is 1
« graphtastic http »