circonus_annotation - create an annotation in circonus

• Synopsis
• Requirements (on host that executes module)
• Options
• Examples
• This is an Extras Module

Synopsis

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

Requirements (on host that executes module)

• urllib3
• requests
• time

Options

Examples

# 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 is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.