sensu.sensu_go.event (0.9.0) — module

Install collection

Install with ansible-galaxy collection install sensu.sensu_go:==0.9.0

Add to requirements.yml

  collections:
    - name: sensu.sensu_go
      version: 0.9.0

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create event
  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

Inputs

    
auth:
    description:
    - Authentication parameters. Can define each of them with ENV as well.
    suboptions:
      namespace:
        default: default
        description:
        - RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE
          environment variable will be checked.
        type: str
      password:
        default: P@ssw0rd!
        description:
        - The Sensu user's password. If this is not set the value of the SENSU_PASSWORD
          environment variable will be checked.
        type: str
      url:
        default: http://localhost:8080
        description:
        - Location of the Sensu backend API. If this is not set the value of the SENSU_URL
          environment variable will be checked.
        type: str
      user:
        default: admin
        description:
        - 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.
        type: str
    type: dict

check:
    description:
    - Name of the check associated with this event. It must exist before event creation.
    required: true
    type: str

entity:
    description:
    - Name of the entity associated with this event. It must exist before event creation.
    required: true
    type: str

timestamp:
    description:
    - UNIX time at which the event occurred.
    type: int

check_attributes:
    description:
    - Additional check parameters. Find out more at U(https://docs.sensu.io/sensu-go/latest/reference/events/#check-attributes)
    suboptions:
      duration:
        description: Command execution time in seconds.
        type: float
      executed:
        description: Time that the check request was executed.
        type: int
      history:
        description: Check status history for the last 21 check executions.
        type: list
      issued:
        description: Time that the check request was issued in seconds since the Unix
          epoch.
        type: int
      last_ok:
        description: The last time that the check returned an OK status (0) in seconds
          since the Unix epoch.
        type: int
      output:
        description: The output from the execution of the check command.
        type: str
      state:
        choices:
        - passing
        - failing
        - flapping
        description: The state of the check.
        type: str
      status:
        choices:
        - ok
        - warning
        - critical
        - unknown
        description: Exit status code produced by the check.
        type: str
      total_state_change:
        description: The total state change percentage for the check's history.
        type: int
    type: dict

metric_attributes:
    description:
    - Metric attributes. Find out more at U(https://docs.sensu.io/sensu-go/latest/reference/events/#metric-attributes)
    suboptions:
      handlers:
        description:
        - An array of Sensu handlers to use for events created by the check. Each array
          item must be a string.
        elements: str
        type: list
      points:
        description: Metric data points including a name, timestamp, value, and tags.
        elements: dict
        type: list
    type: dict

Outputs

object:
  description: object representing Sensu event
  returned: always
  type: dict