New in version 1.6.
Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| api_key | yes | Librato account api key |
||
| description | no |
The description contains extra meta-data about a particular annotation
The description should contain specifics on the individual annotation e.g. Deployed 9b562b2 shipped new feature foo!
|
||
| end_time | no |
The unix timestamp indicating the the time at which the event referenced by this annotation ended
For events that have a duration, this is a useful way to annotate the duration of the event
|
||
| links | yes | See examples |
||
| name | no |
The annotation stream name
If the annotation stream does not exist, it will be created automatically
|
||
| source | no | A string which describes the originating source of an annotation when that annotation is tracked across multiple members of a population |
||
| start_time | no | The unix timestamp indicating the the time at which the event referenced by this annotation started |
||
| title | yes |
The title of an annotation is a string and may contain spaces
The title should be a short, high-level summary of the annotation e.g. v45 Deployment
|
||
| user | yes | Librato account username |
# Create a simple annotation event with a source
- librato_annotation:
user: [email protected]
api_key: XXXXXXXXXXXXXXXXX
title: 'App Config Change'
source: 'foo.bar'
description: 'This is a detailed description of the config change'
# Create an annotation that includes a link
- librato_annotation:
user: [email protected]
api_key: XXXXXXXXXXXXXXXXXX
name: 'code.deploy'
title: 'app code deploy'
description: 'this is a detailed description of a deployment'
links:
- { rel: 'example', href: 'http://www.example.com/deploy' }
# Create an annotation with a start_time and end_time
- librato_annotation:
user: [email protected]
api_key: XXXXXXXXXXXXXXXXXX
name: 'maintenance'
title: 'Maintenance window'
description: 'This is a detailed description of maintenance'
start_time: 1395940006
end_time: 1395954406
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.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/librato_annotation_module.html