Resource Type: sensu_handler

Defined in:

lib/puppet/type/sensu_handler.rb

Providers:

sensuctl
sensu_api

Summary

Manages Sensu handlers

Overview

Autorequires:

• ‘Package`

• ‘Service`

• ‘Sensuctl_configure`

• ‘Sensu_api_validator`

• ‘Sensu_user`

• ‘sensu_namespace` - Puppet will autorequire `sensu_namespace` resource defined in `namespace` property.

• ‘sensu_filter` - Puppet will autorequire `sensu_filter` resources defined in `filters` property.

• ‘sensu_mutator` - Puppet will autorequire `sensu_mutator` resource defined for `mutator` property.

• ‘sensu_handler` - Puppet will autorequire `sensu_handler` resources defined for `handlers` property.

• ‘sensu_asset` - Puppet will autorequire `sensu_asset` resources defined in `runtime_assets` property.

Examples:

Create a handler

sensu_handler { 'test':
  ensure  => 'present',
  type    => 'pipe',
  command => 'notify.rb'
}

Create a handler with namespace ‘dev` in the name

sensu_handler { 'test in dev':
  ensure  => 'present',
  type    => 'pipe',
  command => 'notify.rb'
}

Properties

• annotations

  Arbitrary, non-identifying metadata to include with event data.

• command

  The handler command to be executed.

  Supported values:

  • /.*/
  • absent
• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• env_vars

  An array of environment variables to use with command execution.

  Supported values:

  • /.*/
  • absent
• filters

  An array of Sensu event filters (names) to use when filtering events for the handler.

  Supported values:

  • /.*/
  • absent
• handlers

  An array of Sensu event handlers (names) to use for events using the handler set.

  Supported values:

  • /.*/
  • absent
• labels

  Custom attributes to include with event data, which can be queried like regular attributes.

• mutator

  The Sensu event mutator (name) to use to mutate event data for the handler.

  Supported values:

  • /.*/
  • absent
• namespace (defaults to: default)

  The Sensu RBAC namespace that this handler belongs to.

• runtime_assets

  An array of Sensu assets (names), required at runtime for the execution of the command

  Supported values:

  • /.*/
  • absent
• secrets

  Array of the name/secret pairs to use with command execution. Example: [{‘name’ => ‘ANSIBLE_HOST’, ‘secret’ => ‘sensu-ansible-host’ }]

• socket

  The socket definition scope, used to configure the TCP/UDP handler socket.

  Valid keys:

  • host - Required - The socket host address (IP or hostname) to connect to.

  • port - Required - The socket port to connect to.

• timeout

  The handler execution duration timeout in seconds (hard stop)

  Supported values:

  • /^[0-9]+$/
  • absent
• type

  The handler type.

  Supported values:

  • pipe
  • tcp
  • udp
  • set

Parameters

• name (namevar)

  The name of the handler. The name supports composite names that can define the namespace. An example composite name to define resource named ‘test` in namespace `dev`: `test in dev`

• provider

  The specific backend to use for this ‘sensu_handler` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• resource_name

  The name of the handler.