event – Manage Sensu events

Send a synthetic event to Sensu.

For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/reference/events/.

New in version 1.0.0.

Requirements

The below requirements are needed on the host that executes this module:

  • python >= 2.7

Examples

- name: Create an event
  sensu.sensu_go.event:
    auth:
      url: http://localhost:8080
    entity: awesome_entity
    check: awesome_check
    check_attributes:
      duration: 1.945
      executed: 1522100915
      history:
        - executed: 1552505193
          status: 1
      issued: 1552506034
      last_ok: 1552506033
      output: '10'
      state: 'passing'
      status: 'ok'
      total_state_change: 0
    metric_attributes:
      handlers:
        - handler1
        - handler2
      points:
        - name: "sensu-go-sandbox.curl_timings.time_total"
          tags:
            - name: "response_time_in_ms"
              value: 101
          timestamp: 1552506033
          value: 0.005
        - name: "sensu-go-sandbox.curl_timings.time_namelookup"
          tags:
            - name: "namelookup_time_in_ms"
              value: 57
          timestamp: 1552506033
          value: 0.004

Notes

Note

Metric events bypass the store and are sent off to the event pipeline and corresponding event handlers. Read more about this at https://docs.sensu.io/sensu-go/latest/reference/events/#metric-only-events.

See Also

See also

Parameters

auth (optional)

Authentication parameters. Can define each of them with ENV as well.

type: dict
api_key (optional)

The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked.

This replaces auth.user and auth.password parameters.

For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.

type: str
ca_path (optional)

Path to the CA bundle that should be used to validate the backend certificate.

If this parameter is not set, module will use the CA bundle that python is using.

It is also possible to set this parameter via the SENSU_CA_PATH environment variable.

type: path
password (optional)

The Sensu user’s password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked.

This parameter is ignored if the auth.api_key parameter is set.

type: str
default: P@ssw0rd!
url (optional)

Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.

type: str
default: http://localhost:8080
user (optional)

The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked.

This parameter is ignored if the auth.api_key parameter is set.

type: str
default: admin
verify (optional)

Flag that controls the certificate validation.

If you are using self-signed certificates, you can set this parameter to false.

ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter.

It is also possible to set this parameter via the SENSU_VERIFY environment variable.

type: bool
default: True
check (required)

Name of the check associated with this event. It must exist before event creation.

type: str
check_attributes (optional)

Additional check parameters. Find out more at https://docs.sensu.io/sensu-go/latest/reference/events/#check-attributes.

type: dict
duration (optional)

Command execution time in seconds.

type: float
executed (optional)

Time that the check request was executed.

type: int
history (optional)

Check status history for the last 21 check executions.

type: list
issued (optional)

Time that the check request was issued in seconds since the Unix epoch.

type: int
last_ok (optional)

The last time that the check returned an OK status (0) in seconds since the Unix epoch.

type: int
output (optional)

The output from the execution of the check command.

type: str
state (optional)

The state of the check.

type: str
choices: passing, failing, flapping
status (optional)

Exit status code produced by the check.

type: str
choices: ok, warning, critical, unknown
total_state_change (optional)

The total state change percentage for the check’s history.

type: int
entity (required)

Name of the entity associated with this event. It must exist before event creation.

type: str
metric_attributes (optional)

Metric attributes. Find out more at https://docs.sensu.io/sensu-go/latest/reference/events/#metric-attributes.

type: dict
handlers (optional)

An array of Sensu handlers to use for events created by the check. Each array item must be a string.

type: list
points (optional)

Metric data points including a name, timestamp, value, and tags.

type: list
namespace (optional)

RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used.

type: str
default: default
timestamp (optional)

UNIX time at which the event occurred.

type: int

Return Values

object

Object representing Sensu event (deprecated).

sample:

check:
  check_hooks: null
  command: check-cpu.sh -w 75 -c 90
  duration: 1.07055808
  env_vars: null
  executed: 1552594757
  handlers: []
  high_flap_threshold: 0
  history:
  - executed: 1552594757
    status: 0
  interval: 60
  metadata:
    name: check-cpu
    namespace: default
  occurrences: 1
  occurrences_watermark: 1
  output: CPU OK - Usage:3.96
  subscriptions:
  - linux
  timeout: 0
  total_state_change: 0
  ttl: 0
entity:
  deregister: false
  deregistration: {}
  entity_class: agent
  last_seen: 1552594641
  metadata:
    name: sensu-centos
    namespace: default
id: 3a5948f3-6ffd-4ea2-a41e-334f4a72ca2f
metadata:
  namespace: default
sequence: 1
timestamp: 1552594758