circonus_annotation
Create an annotation in Circonus
Collection: community.general
Full Name: community.general.circonus_annotation
Synopsis
Create an annotation in Circonus
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| api_key | str | yes | Circonus API key. | |
| category | str | yes | Annotation Category. | |
| description | str | yes | Description of annotation. | |
| duration | int | 0 | Duration in seconds of annotation. | |
| start | int | Unix timestamp of event start. If not specified, it defaults to “now”. | ||
| stop | int | Unix timestamp of event end. If not specified, it defaults to “now” + O(duration). | ||
| title | str | yes | Title of annotation. |
Example
yaml
- 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: 1395940006
stop: 1395954407