W3cubDocs

/Ansible

community.general.datadog_event – Posts events to Datadog service

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.datadog_event.

Synopsis

Parameters

Parameter Choices/Defaults Comments
aggregation_key
string
An arbitrary string to use for aggregation.
alert_type
string
    Choices:
  • error
  • warning
  • info ←
  • success
Type of alert.
api_host
string
added in 3.3.0 of community.general
DataDog API endpoint URL.
api_key
string / required
Your DataDog API key.
app_key
string / required
Your DataDog app key.
date_happened
integer
POSIX timestamp of the event.
Default value is now.
host
string
Host name to associate with the event.
If not specified, it defaults to the remote system's hostname.
priority
string
    Choices:
  • normal ←
  • low
The priority of the event.
tags
list / elements=string
Comma separated list of tags to apply to the event.
text
string / required
The body of the event.
title
string / required
The event title.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: Post an event with low priority
  community.general.datadog_event:
    title: Testing from ansible
    text: Test
    priority: low
    api_key: 9775a026f1ca7d1c6c5af9d94d9595a4
    app_key: j4JyCYfefWHhgFgiZUqRm63AXHNZQyPGBfJtAzmN

- name: Post an event with several tags
  community.general.datadog_event:
    title: Testing from ansible
    text: Test
    api_key: 9775a026f1ca7d1c6c5af9d94d9595a4
    app_key: j4JyCYfefWHhgFgiZUqRm63AXHNZQyPGBfJtAzmN
    tags: 'aa,bb,#host:{{ inventory_hostname }}'

- name: Post an event with several tags to another endpoint
  community.general.datadog_event:
    title: Testing from ansible
    text: Test
    api_key: 9775a026f1ca7d1c6c5af9d94d9595a4
    app_key: j4JyCYfefWHhgFgiZUqRm63AXHNZQyPGBfJtAzmN
    api_host: 'https://example.datadoghq.eu'
    tags:
      - aa
      - b
      - '#host:{{ inventory_hostname }}'

Authors

  • Artūras arturaz Šlajus (@arturaz)
  • Naoya Nakazawa (@n0ts)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/datadog_event_module.html