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

hipchat

edit

hipchat

edit

This is a community-maintained plugin!

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"

format

string

No

"%{message}"

from

string

No

"logstash"

host

string

No

message_format

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

No

"html"

room_id

string

Yes

token

string

Yes

trigger_notify

boolean

No

false

workers

number

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

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.

workers

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

« graphite http »