community.general.datadog_event module – Posts events to Datadog service

Note

This module is part of the community.general collection (version 9.4.0).

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 

Allows to post events to Datadog (www.datadoghq.com) service.
Uses http://docs.datadoghq.com/api/#events API.

Parameters 

Parameter	Comments
aggregation_key string	An arbitrary string to use for aggregation.
alert_type string	Type of alert. Choices: `"error"` `"warning"` `"info"` ← (default) `"success"`
api_host string added in community.general 3.3.0	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	The priority of the event. Choices: `"normal"` ← (default) `"low"`
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	If `false`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Choices: `false` `true` ← (default)

Attributes 

Attribute	Support	Description
check_mode	Support: none	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

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)

Collection links