community.general.librato_annotation – create an annotation in librato
community.general.librato_annotation – create an annotation in librato
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.librato_annotation
.
Synopsis
- Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key string / required |
Librato account api key | |
description string |
The description contains extra metadata about a particular annotation The description should contain specifics on the individual annotation e.g. Deployed 9b562b2 shipped new feature foo! | |
end_time integer |
The unix timestamp indicating 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 list / elements=string |
See examples | |
name string |
The annotation stream name If the annotation stream does not exist, it will be created automatically | |
source string |
A string which describes the originating source of an annotation when that annotation is tracked across multiple members of a population | |
start_time integer |
The unix timestamp indicating the time at which the event referenced by this annotation started | |
title string / required |
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 string / required |
Librato account username |
Examples
- name: Create a simple annotation event with a source
community.general.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
- name: Create an annotation that includes a link
community.general.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
- name: Create an annotation with a start_time and end_time
community.general.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
Authors
- Seth Edwards (@Sedward)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/librato_annotation_module.html