About the Datadog category

o.plokha · May 16, 2024, 7:33am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Datadog API Reference

Connector package documentation

1. Setting up HTTP Client Datadog

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Datadog HTTP Client as PlatForm and click next step
Fill in the Base URI and API key.
You can optionally enable Application Key that is required for some Datadog End Points.
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from Datadog

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Datadog Subscriber” as the subscriber.
Select the method you want to subscribe to from Datadog.
Select the entity you want to subscribe to from Datadog.
Add any request parameters needed to subscribe to the entity.
Select the Datadog HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Datadog.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Datadog documentation on building this connector, so you can easily use the connector based on Datadog API Reference.

Entity

The entity you want to subscribe to Datadog. Please refer to the entities from Datadog API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Datadog API Reference.

Please look at the example below on how to fill path field when we want retrieve details of an incident by subscribing “Incidents - Get the details of an incident” entity.

From the end point, we can see that we need to set the incident id as parameters. That is why we set the “incident_id” inside the path key in the Request Parameters.

Alumio will then make a request to Datadog with the URL https://api.datadoghq.com/api/v2/incidents/123

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

HTTP Client

The HTTP Client configuration you will use to access Datadog.

3. Publishing Entity to Datadog

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Datadog Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Datadog entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method and HTTP Delete method on submitting data to Datadog.

Entity

We support publishing to most Datadog endpoints.
Please refer to Datadog API Reference page.

For example, we want to delete an eorder. Please select “Delete” as the Method and “Roles - Delete role”.

From the end point, we can see that we need to set role id as parameters. That is why we set the “role_id” inside the path key in the data.

Alumio will send an API request to Datadog with URL https://api.datadoghq.com/api/v2/roles/123

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.