hipchat
edithipchat
editThis is a community-maintained plugin!
This output allows you to write events to HipChat.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
hipchat { room_id => ... token => ... }
Available configuration options:
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)
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.
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.
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.
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.
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.
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.