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

hipchatedit

This is a community-maintained plugin!

This output allows you to write events to HipChat.

 

Synopsisedit

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"

room_id

string

Yes

token

string

Yes

trigger_notify

boolean

No

false

workers

number

No

1

Detailsedit

 

codecedit

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

coloredit

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

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Optional.

formatedit

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

Message format to send, event tokens are usable here.

fromedit

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

The name the message will appear be sent from.

room_idedit

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

The ID or name of the room.

tags (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Optional.

tokenedit

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

The HipChat authentication token.

trigger_notifyedit

  • Value type is boolean
  • Default value is false

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

type (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • 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.

workersedit

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