Reference » Output plugins » hipchat
«  http     irc  »

hipchat

boundary
csv
circonus
cloudwatch
datadog
datadog_metrics
elasticsearch
email
exec
file
graphtastic
ganglia
graphite
google_bigquery
google_cloud_storage
gelf
http
hipchat
irc
influxdb
jira
juggernaut
kafka
loggly
librato
lumberjack
mongodb
metriccatcher
nagios
nagios_nsca
null
opentsdb
pagerduty
pipe
rackspace
riak
riemann
redis
redmine
rabbitmq
solr_http
sns
syslog
stomp
statsd
stdout
sqs
s3
tcp
udp
websocket
xmpp
zabbix
zeromq

This output allows you to write events to HipChat.

 

Synopsis

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

Setting Input typeRequiredDefault 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

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

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

  • 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. Note that if you specify a type, the event must also match that type. Optional.

token

  • This is a 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 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.

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.

«  http     irc  »