Resource Type: sensu_entity

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

Summary

Manages Sensu entities

Overview

Autorequires:

  • ‘Package`

  • ‘Service`

  • ‘Sensuctl_configure`

  • ‘Sensu_api_validator`

  • ‘Sensu_user`

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

  • ‘sensu_handler` - Puppet will autorequie `sensu_handler` resource defined in `deregistration.handler` property.

Examples:

Create an entity

sensu_entity { 'test':
  ensure       => 'present',
  entity_class => 'proxy',
}

Create an entity with namespace ‘dev` in the name

sensu_entity { 'test in dev':
  ensure       => 'present',
  entity_class => 'proxy',
}

Properties

  • annotations

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

  • deregister (defaults to: false)

    If the entity should be removed when it stops sending keepalive messages.

    Supported values:
    • true
    • false
  • deregistration

    A map containing a handler name, for use when an entity is deregistered.

    Valid keys:

    • handler - Opional - The name of the handler to be called when an entity is deregistered.

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • entity_class

    The entity type

  • labels

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

  • last_seen

    Timestamp the entity was last seen, in epoch time.

  • namespace (defaults to: default)

    The Sensu RBAC namespace that this entity belongs to.

  • redact

    List of items to redact from log messages.

  • subscriptions

    A list of subscription names for the entity

  • system

    System information about the entity, such as operating system and platform.

Parameters

  • name (namevar)

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

  • resource_name

    The name of the entity.