community.general.librato_annotation (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a simple annotation event with a source
  community.general.librato_annotation:
    user: user@example.com
    api_key: XXXXXXXXXXXXXXXXX
    title: App Config Change
    source: foo.bar
    description: This is a detailed description of the config change

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create an annotation that includes a link
  community.general.librato_annotation:
    user: user@example.com
    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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create an annotation with a start_time and end_time
  community.general.librato_annotation:
    user: user@example.com
    api_key: XXXXXXXXXXXXXXXXXX
    name: maintenance
    title: Maintenance window
    description: This is a detailed description of maintenance
    start_time: 1395940006
    end_time: 1395954406

Inputs

    
name:
    description:
    - The annotation stream name
    - If the annotation stream does not exist, it will be created automatically
    required: false
    type: str

user:
    description:
    - Librato account username
    required: true
    type: str

links:
    description:
    - See examples
    elements: dict
    type: list

title:
    description:
    - 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
    required: true
    type: str

source:
    description:
    - A string which describes the originating source of an annotation when that annotation
      is tracked across multiple members of a population
    required: false
    type: str

api_key:
    description:
    - Librato account api key
    required: true
    type: str

end_time:
    description:
    - 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
    required: false
    type: int

start_time:
    description:
    - The unix timestamp indicating the time at which the event referenced by this annotation
      started
    required: false
    type: int

description:
    description:
    - 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!
    required: false
    type: str