Hipchat output plugin v4.0.3edit

  • Plugin version: v4.0.3
  • Released on: 2017-06-23
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting Helpedit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Descriptionedit

This output allows you to write events to HipChat.

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

Hipchat Output Configuration Optionsedit

This plugin supports the following configuration options plus the Common Options described later.

Setting Input type Required

color

string

No

format

string

No

from

string

No

host

string

No

message_format

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

No

room_id

string

Yes

token

string

Yes

trigger_notify

boolean

No

Also see Common Options for a list of options supported by all output plugins.

 

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

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

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.

Common Optionsedit

The following configuration options are supported by all output plugins:

Setting Input type Required

codec

codec

No

enable_metric

boolean

No

id

string

No

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.

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.

idedit

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 hipchat outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  hipchat {
    id => "my_plugin_id"
  }
}