community.general.circonus_annotation module – Create an annotation in Circonus
Note
This module is part of the community.general collection (version 10.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.circonus_annotation
.
Synopsis
Create an annotation event with a given category, title and description. Optionally start, end or durations can be provided.
Requirements
The below requirements are needed on the host that executes this module.
requests (either >= 2.0.0 for Python 3, or >= 1.0.0 for Python 2)
Parameters
Parameter |
Comments |
---|---|
Circonus API key. |
|
Annotation Category. |
|
Description of annotation. |
|
Duration in seconds of annotation. Default: |
|
Unix timestamp of event start. If not specified, it defaults to “now”. |
|
Unix timestamp of event end. If not specified, it defaults to “now” + |
|
Title of annotation. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- 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
- 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
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details about the created annotation. Returned: success |
|
Annotation identifier. Returned: success Sample: |
|
Creation timestamp. Returned: success Sample: |
|
Last modification timestamp. Returned: success Sample: |
|
Last modified by. Returned: success Sample: |
|
Category of the created annotation. Returned: success Sample: |
|
Description of the created annotation. Returned: success Sample: |
|
Array of metrics related to this annotation, each metrics is a string. Returned: success Sample: |
|
Timestamp, since annotation applies. Returned: success Sample: |
|
Timestamp, since annotation ends. Returned: success Sample: |
|
Title of the created annotation. Returned: success Sample: |