Datadog Events

The Datadog Events stream connector allows you to send data from Centreon to Datadog instances.

Before starting

If you want to retrieve all the data for the events, use the Datadog Events stream connector. If you want to retrieve only metrics, use the Datadog Metrics stream connector.

• In most cases, you will want to send data from the central server. It is also possible to send it from a remote server or a poller (e.g. if you want to avoid the central server being a SPOF, or if you are an MSP and you install the stream connector on a poller or a remote server within your customer's infrastructure).

• By default, the Datadog Events stream connector sends data from host_status and service_status Broker events. The event format is shown here.

• These events are sent each time a host or a service is checked. Various parameters let you filter out events.

Installation

Perform the installation on the server that will send data to Datadog (central server, remote server, poller).

1. Login as root using your favorite SSH client.

2. Run the following command:

Alma / RHEL / Oracle Linux 8

dnf install centreon-stream-connector-datadog

Alma / RHEL / Oracle Linux 9

dnf install centreon-stream-connector-datadog

Debian 12

apt install centreon-stream-connector-datadog

Configuring your Datadog server

You may need to configure your Datadog server so that it can receive data from Centreon. Please refer to Datadog's documentation. Make sure Datadog is able to receive data sent by Centreon: flows must not be blocked by Datadog's configuration or by a security device.

The correct sourcetype for the stream connector is "_json". Other useful information may be for example "source": "http:my_index", "index": "my_index", "host": "Central". You can also add this information to your stream connector's configuration if you need to.

Configuring the stream connector in Centreon

1. On your central server, go to Configuration > Pollers > Broker configuration.
2. Click on central-broker-master (or the appropriate broker configuration if it is a poller or a remote server that will send events).
3. On the Output tab, select Generic - Stream connector from the list and then click Add. A new output appears in the list.
4. Fill in the fields as follows:

Field	Value
Name	Datadog events
Path	/usr/share/centreon-broker/lua/datadog-events-apiv2.lua
Filter category	Neb

5. To enable Centreon to connect to your Datadog equipment, fill in the following mandatory parameters. The fields for the first entry are already present. Click on the +Add a new entry link located below the Filter category table to add another one.

Type	Name	Value explanation	Value exemple
string	api_key	the datadog api key	xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

6. Fill in any optional parameters you want (using the +Add a new entry link):

Type	Name	Value explanation	default value
string	logfile	The file in which logs are written	/var/log/centreon-broker/datadog-events.log
number	log_level	Logging level from 1 (errors) to 3 (debug)	1

7. Use the stream connector's optional parameters to filter or adapt the data you want Centreon to send to Datadog.

8. Deploy the configuration.

9. Restart centengine on all pollers:

   systemctl restart centengine

Datadog should now receive data from Centreon. To test if it is working, see Curl commands: testing the stream connector.

Filtering or adapting the data you want to send to Datadog

All stream connectors have a set of optional parameters, that allow you to filter the data you will send to your Datadog equipment, to reformat the data, to define a proxy...

Each optional parameter has a default value, that is indicated in the corresponding documentation.

• To override the default value of a parameter, click on the +Add a new entry link located below the Filter category table to add a custom parameter. For example, if you want to only send to Datadog the events handled by a poller named "poller-1", enter:

  type = string
  name = accepted_pollers
  value = poller-1

• For the Datadog Events stream connector, the following values always override the default values, you do not need to define them in the interface.

Some of them are overridden by this stream connector.

Type	Name	Default value for the stream connector
string	datadog_centreon_url	http://yourcentreonaddress.local
string	datadog_event_endpoint	/api/v1/events
string	http_server_url	https://api.datadoghq.com
string	accepted_categories	neb
string	accepted_elements	host_status,service_status

Event bulking

This stream connector is compatible with event bulking. Meaning that it is able to send more that one event in each call to the Datadog REST API.

To use this feature you must add the following parameter in your stream connector configuration.

Type	Name	Value
number	max_buffer_size	more than one

Event format

This stream connector will send event with the following format.

service_status event

{
  "title": "CRITICAL my_host my_service",
  "text": "my service is not working",
  "aggregation_key": "service_27_12",
  "alert_type": "error",
  "host": "my_host",
  "date_happened": 1630590530
}

host_status event

{
  "title": "CRITICAL my_host",
  "text": "my host is not working",
  "aggregation_key": "host_27",
  "alert_type": "error",
  "host": "my_host",
  "date_happened": 1630590530
}

Custom event format

This stream connector allows you to change the format of the event to suit your needs. Only the event part of the json is customisable. It also allows you to handle event types that are not handled by default such as ba_status events.

In order to use this feature you need to configure a json event format file and add a new stream connector parameter.

Type	Name	Value
string	format_file	/etc/centreon-broker/datadog-events-format.json

The event format configuration file must be readable by the centreon-broker user.

To learn more about custom event formats and templating files, visit this page.

Curl commands: testing the stream connector

Sending events

If you want to test that events are sent to Datadog correctly:

1. Log in to the server that you configured to send events to Datadog (your central server, a remote server or a poller).
2. Run the following command:

curl -X POST -H "content-type: application/json" -H "DD-API-KEY: <api_key>" <http_server_url><datadog_event_endpoint>' -d '{"title":"CRITICAL my_host my_service","text":"my service is not working","aggregation_key":"service_27_12","alert_type":"error","host":"my_host","date_happened":1630590530}'

You must replace all the <xxxx> inside the above command with the correct value. http_server_url may become https://api.datadoghq.com.

3. Check that the event has been received by Datadog.