community.general.circonus_annotation (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Create an annotation event with a given category, title and description. Optionally start, end or durations can be provided

Requirements

• requests (either >= 2.0.0 for Python 3, or >= 1.0.0 for Python 2)

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a simple annotation event with a source, defaults to start and end time of now
  community.general.circonus_annotation:
    api_key: XXXXXXXXXXXXXXXXX
    title: App Config Change
    description: This is a detailed description of the config change
    category: This category groups like annotations

Scanned by Steampunk Spotter

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

- name: Create an annotation with a duration of 5 minutes and a default start time of now
  community.general.circonus_annotation:
    api_key: XXXXXXXXXXXXXXXXX
    title: App Config Change
    description: This is a detailed description of the config change
    category: This category groups like annotations
    duration: 300

Scanned by Steampunk Spotter

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

- name: Create an annotation with a start_time and end_time
  community.general.circonus_annotation:
    api_key: XXXXXXXXXXXXXXXXX
    title: App Config Change
    description: This is a detailed description of the config change
    category: This category groups like annotations
    start_time: 1395940006
    end_time: 1395954407

Inputs

    
stop:
    description:
    - Unix timestamp of event end
    - If not specified, it defaults to "now" + O(duration).
    type: int

start:
    description:
    - Unix timestamp of event start
    - If not specified, it defaults to "now".
    type: int

title:
    description:
    - Title of annotation
    required: true
    type: str

api_key:
    description:
    - Circonus API key
    required: true
    type: str

category:
    description:
    - Annotation Category
    required: true
    type: str

duration:
    default: 0
    description:
    - Duration in seconds of annotation
    type: int

description:
    description:
    - Description of annotation
    required: true
    type: str

Outputs

annotation:
  contains:
    _cid:
      description: annotation identifier
      returned: success
      sample: /annotation/100000
      type: str
    _created:
      description: creation timestamp
      returned: success
      sample: 1502236928
      type: int
    _last_modified:
      description: last modification timestamp
      returned: success
      sample: 1502236928
      type: int
    _last_modified_by:
      description: last modified by
      returned: success
      sample: /user/1000
      type: str
    category:
      description: category of the created annotation
      returned: success
      sample: alerts
      type: str
    description:
      description: description of the created annotation
      returned: success
      sample: Host is down.
      type: str
    rel_metrics:
      description: Array of metrics related to this annotation, each metrics is a
        string.
      returned: success
      sample:
      - 54321_kbps
      type: list
    start:
      description: timestamp, since annotation applies
      returned: success
      sample: Host is down.
      type: int
    stop:
      description: timestamp, since annotation ends
      returned: success
      sample: Host is down.
      type: str
    title:
      description: title of the created annotation
      returned: success
      sample: WARNING
      type: str
  description: details about the created annotation
  returned: success
  type: complex