community / community.general / 0.1.1 / module / circonus_annotation create an annotation in circonus Authors: Nick Harring (@NickatEpic) preview | supported by communitycommunity.general.circonus_annotation (0.1.1) — module
Install with ansible-galaxy collection install community.general:==0.1.1
collections: - name: community.general version: 0.1.1
Create an annotation event with a given category, title and description. Optionally start, end or durations can be provided
# Create a simple annotation event with a source, defaults to start and end time of now - 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
# Create an annotation with a duration of 5 minutes and a default start time of now - 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
# Create an annotation with a start_time and end_time - 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
stop: default: I(now) + I(duration) description: - Unix timestamp of event end start: default: I(now) description: - Unix timestamp of event start title: description: - Title of annotation required: true api_key: description: - Circonus API key required: true category: description: - Annotation Category required: true duration: default: 0 description: - Duration in seconds of annotation description: description: - Description of annotation required: true
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