New in version 2.0.
- urllib3
- requests
- time
parameter | required | default | choices | comments |
---|---|---|---|---|
api_key |
yes | Circonus API key | ||
category |
yes | Annotation Category | ||
description |
yes | Description of annotation | ||
duration |
no | Duration in seconds of annotation, defaults to 0 | ||
start |
no | Unix timestamp of event start, defaults to now | ||
stop |
no | Unix timestamp of event end, defaults to now + duration | ||
title |
yes | Title of annotation |
# 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
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.