Resource Type: sensu_mutator

Defined in:
lib/puppet/type/sensu_mutator.rb
Providers:
sensuctl
sensu_api

Summary

Manages Sensu mutators

Overview

Autorequires:

  • Package[sensu-go-cli]
  • Service[sensu-backend]
  • Sensuctl_configure[puppet]
  • Sensu_api_validator[sensu]
  • Sensu_user[admin]
  • sensu_namespace - Puppet will autorequire sensu_namespace resource defined in namespace property.
  • sensu_asset - Puppet will autorequire sensu_asset resources defined in runtime_assets property.

Examples:

Create a mutator

sensu_mutator { 'example':
  ensure  => 'present',
  command => 'example-mutator.rb',
}

Create a mutator with namespace dev in the name

sensu_mutator { 'example in dev':
  ensure  => 'present',
  command => 'example-mutator.rb',
}

Properties

  • annotations

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

  • command

    The mutator command to be executed.

  • 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
  • labels

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

  • namespace (defaults to: default)

    The Sensu RBAC namespace that this mutator 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' }]

  • timeout

    The mutator execution duration timeout in seconds (hard stop)

    Supported values:
    • /^[0-9]+$/
    • absent

Parameters

  • name (namevar)

    The name of the mutator. 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_mutator resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

  • resource_name

    The name of the mutator.