Defined Type: logstash::output::hipchat

Defined in:
manifests/output/hipchat.pp

Overview

Define: logstash::output::hipchat

This output allows you to write events to HipChat.

Parameters

color

Background color for message. HipChat currently supports one of “yellow”, “red”, “green”, “purple”, “gray”, or “random”. (default: yellow) Value type is string Default value: “yellow” This variable is optional

exclude_tags

Only handle events without any of these tags. Note this check is additional to type and tags. Value type is array Default value: [] This variable is optional

fields

Only handle events with all of these fields. Optional. Value type is array Default value: [] This variable is optional

format

Message format to send, event tokens are usable here. Value type is string Default value: “%@message” This variable is optional

from

The name the message will appear be sent from. Value type is string Default value: “logstash” This variable is optional

room_id

The ID or name of the room. Value type is string Default value: None This variable is required

tags

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional. Value type is array Default value: [] This variable is optional

token

The HipChat authentication token. Value type is string Default value: None This variable is required

trigger_notify

Whether or not this message should trigger a notification for people in the room. Value type is boolean Default value: false This variable is optional

type

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. Value type is string Default value: “” This variable is optional

instances

Array of instance names to which this define is. Value type is array Default value: [ ‘array’ ] This variable is optional

Extra information

This define is created based on LogStash version 1.1.12
Extra information about this output can be found at:
http://logstash.net/docs/1.1.12/outputs/hipchat

Need help? http://logstash.net/docs/1.1.12/learn

Authors

Parameters:

  • room_id (Any)
  • token (Any)
  • color (Any) (defaults to: '')
  • format (Any) (defaults to: '')
  • from (Any) (defaults to: '')
  • fields (Any) (defaults to: '')
  • tags (Any) (defaults to: '')
  • exclude_tags (Any) (defaults to: '')
  • trigger_notify (Any) (defaults to: '')
  • type (Any) (defaults to: '')
  • instances (Any) (defaults to: [ 'agent' ]) 


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'manifests/output/hipchat.pp', line 93

define logstash::output::hipchat (
  $room_id,
  $token,
  $color          = '',
  $format         = '',
  $from           = '',
  $fields         = '',
  $tags           = '',
  $exclude_tags   = '',
  $trigger_notify = '',
  $type           = '',
  $instances      = [ 'agent' ]
) {

  require logstash::params

  File {
    owner => $logstash::logstash_user,
    group => $logstash::logstash_group
  }

  if $logstash::multi_instance == true {

    $confdirstart = prefix($instances, "${logstash::configdir}/")
    $conffiles    = suffix($confdirstart, "/config/output_hipchat_${name}")
    $services     = prefix($instances, 'logstash-')
    $filesdir     = "${logstash::configdir}/files/output/hipchat/${name}"

  } else {

    $conffiles = "${logstash::configdir}/conf.d/output_hipchat_${name}"
    $services  = 'logstash'
    $filesdir  = "${logstash::configdir}/files/output/hipchat/${name}"

  }

  #### Validate parameters

  validate_array($instances)

  if ($exclude_tags != '') {
    validate_array($exclude_tags)
    $arr_exclude_tags = join($exclude_tags, '\', \'')
    $opt_exclude_tags = "  exclude_tags => ['${arr_exclude_tags}']\n"
  }

  if ($tags != '') {
    validate_array($tags)
    $arr_tags = join($tags, '\', \'')
    $opt_tags = "  tags => ['${arr_tags}']\n"
  }

  if ($fields != '') {
    validate_array($fields)
    $arr_fields = join($fields, '\', \'')
    $opt_fields = "  fields => ['${arr_fields}']\n"
  }

  if ($trigger_notify != '') {
    validate_bool($trigger_notify)
    $opt_trigger_notify = "  trigger_notify => ${trigger_notify}\n"
  }

  if ($room_id != '') {
    validate_string($room_id)
    $opt_room_id = "  room_id => \"${room_id}\"\n"
  }

  if ($from != '') {
    validate_string($from)
    $opt_from = "  from => \"${from}\"\n"
  }

  if ($token != '') {
    validate_string($token)
    $opt_token = "  token => \"${token}\"\n"
  }

  if ($format != '') {
    validate_string($format)
    $opt_format = "  format => \"${format}\"\n"
  }

  if ($type != '') {
    validate_string($type)
    $opt_type = "  type => \"${type}\"\n"
  }

  if ($color != '') {
    validate_string($color)
    $opt_color = "  color => \"${color}\"\n"
  }

  #### Write config file

  file { $conffiles:
    ensure  => present,
    content => "output {\n hipchat {\n${opt_color}${opt_exclude_tags}${opt_fields}${opt_format}${opt_from}${opt_room_id}${opt_tags}${opt_token}${opt_trigger_notify}${opt_type} }\n}\n",
    mode    => '0440',
    notify  => Service[$services],
    require => Class['logstash::package', 'logstash::config']
  }
}