hipchat

Milestone: 1

This output allows you to write events to HipChat.

Synopsis

This is what it might look like in your config file:
output {
  hipchat {
    codec => ... # codec (optional), default: "plain"
    color => ... # string (optional), default: "yellow"
    format => ... # string (optional), default: "%{message}"
    from => ... # string (optional), default: "logstash"
    room_id => ... # string (required)
    token => ... # string (required)
    trigger_notify => ... # boolean (optional), default: false
    workers => ... # number (optional), default: 1
  }
}

Details

codec

  • 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

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

exclude_tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

format

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

Message format to send, event tokens are usable here.

from

  • Value type is string
  • Default value is "logstash"

The name the message will appear be sent from.

room_id (required setting)

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

The ID or name of the room.

tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

token (required setting)

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

The HipChat authentication token.

trigger_notify

  • Value type is boolean
  • Default value is false

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

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

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


This is documentation from lib/logstash/outputs/hipchat.rb