IRC

ENTERPRISE: Built-in integrations are available for Sensu Enterprise users only.

Overview

Send notifications to an Internet Relay Chat (IRC) channel for events.

Configuration

Example(s)

The following is an example global configuration for the irc enterprise event handler (integration).

{
  "irc": {
    "uri": "irc://nick:pass@example.com:6697/#ops",
    "ssl": true,
    "nickserv_password": "NICKSERV_PASSWORD",
    "channel_password": "CHANNEL_PASSWORD",
    "join": false,
    "timeout": 10
  }
}

Integration Specification

irc attributes

The following attributes are configured within the {"irc": {} } configuration scope.

url
description The IRC URI; including the nick, password, address, port, and channel.
required true
type String
example 
"uri": "irc://nick:pass@example.com:6697/#ops"
ssl
description If SSL encryption is used for the IRC connection.
required false
type Boolean
default false
example 
"ssl": true
channel_password
description The IRC channel password (if required).
required false
type String
example 
"channel_password": "secret"
nickserv_password
description Identify with NickServ (if required).
required false
type String
example 
"nickserv_password": "secret"
join
description If the handler must join the IRC channel before messaging.
required false
type Boolean
default false
example 
"join": true
filters
description An array of Sensu event filters (names) to use when filtering events for the handler. Each array item must be a string. Specified filters are merged with default values.
required false
type Array
default 
["handle_when", "check_dependencies"]
example 
"filters": ["recurrence", "production"]
severities
description An array of check result severities the handler will handle. NOTE: event resolution bypasses this filtering.
required false
type Array
allowed values ok, warning, critical, unknown
default 
["warning", "critical", "unknown"]
example 
 "severities": ["critical", "unknown"]
timeout
description The handler execution duration timeout in seconds (hard stop).
required false
type Integer
default 10
example 
"timeout": 30