hipchatedit

  • Version: 4.0.2
  • Released on: 2016-07-14
  • Changelog
Note

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-hipchat.

This output allows you to write events to HipChat.

Make sure your API token have the appropriate permissions and support sending messages.

 

Synopsisedit

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"

enable_metric

boolean

No

true

format

string

No

"%{message}"

from

string

No

"logstash"

host

string

No

id

string

No

message_format

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

No

"html"

room_id

string

Yes

token

string

Yes

trigger_notify

boolean

No

false

workers

<<,>>

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), support fieldref

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

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, you can use fieldref

hostedit

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

HipChat host to use

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

``` output { stdout { id ⇒ "ABC" } } ```

If you don’t explicitely set this variable Logstash will generate a unique name.

message_formatedit

  • Value can be any of: html, text
  • Default value is "html"

Specify Message Format

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, support fieldref

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.

workersedit

  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne