Integrate Datadog Monitoring
Overview
You can integrate Datadog to monitor file transfer activities and device status changes.
Once configured, events are sent to Datadog whenever selected events occur, such as Transfer Started, Transfer Completed, Device Connected, and Device Disconnected, allowing you to monitor them through Datadog.
The overall process consists of the following steps:
① Generate Datadog Credentials (Keys) → ② Configure the Integration in the Product
Prerequisites
Before you begin, verify the following requirements.
| Item | Description |
|---|---|
| Datadog Account | A Datadog account with permission to access Organization Settings and generate API Keys and Application Keys is required. |
| Datadog Site | Verify the Datadog Site your organization uses (for example, US1 or EU). The selected Site must match the organization where the keys were generated. |
| Network | The environment where the product is installed must allow outbound HTTPS communication (port 443) to the Datadog API endpoint for the selected Site (for example, api.datadoghq.com). |
Generate Datadog Credentials and Verify the Site
To send monitoring data to Datadog, you need an API Key, an Application Key, and the Datadog Site used by your organization.
Step 1. Generate an API Key
In Datadog, click your avatar in the lower-left corner, then navigate to Organization Settings → API Keys.
Click + New Key, enter a name, generate the key, and copy the displayed API Key.
Step 2. Generate an Application Key
Navigate to Organization Settings → Application Keys.
Click + New Key, enter a name, generate the key, and copy the displayed Application Key.
The Application Key inherits the permissions of the user who created it. You can optionally restrict access by configuring the appropriate scopes.
Treat both the API Key and Application Key as passwords. Do not expose them in public repositories or external documentation. If either key is compromised, delete it and generate a new one.
Step 3. Verify the Datadog Site
Verify the Datadog Site by checking your browser's address while logged in.
For example:
app.datadoghq.com→ US1us3.datadoghq.com→ US3us5.datadoghq.com→ US5datadoghq.eu→ EUap1.datadoghq.com→ AP1
The selected Datadog Site in the product must match the Site where the API credentials were created.
Verification
✔ The API Key has been generated.
✔ The Application Key has been generated.
✔ The Datadog Site has been verified.
Configure Datadog Integration
Enter the generated credentials and select the Datadog Site.
When you open the Monitoring configuration page, the following screen is displayed.
Step 1. Enter the API Key
Enter the API Key copied in the "Generate Datadog Credentials and Verify the Site" section into the API Key field.
Step 2. Enter the Application Key
Enter the Application Key copied in the "Generate Datadog Credentials and Verify the Site" section into the Application Key field.
Step 3. Select the Datadog Site
Select your Datadog Site from the Datadog Site drop-down list.
The selected Site must match the Site where the API credentials were generated.
Step 4. Select Events
Select the events you want to monitor in Events.
Multiple events can be selected. Only the selected events are sent to Datadog.
| Event | Trigger |
|---|---|
| Transfer Started | When a Transfer begins. |
| Transfer Completed | When a Transfer completes successfully. |
| Transfer Paused | When a Transfer is paused. |
| Transfer Recovered | When a Transfer automatically resumes after an interruption or failure. |
| Device Connected | When a device connects. |
| Device Disconnected | When a device disconnects. |
Step 5. Save the Configuration
After completing the configuration, click Add to save the integration.
Verification
✔ The API Key and Application Key have been entered.
✔ The Datadog Site has been selected.
✔ The monitoring events have been selected.
Verify the Integration
Verify that the integration is operating correctly.
Step 1. Generate a Test Event
Start a Transfer or trigger one of the selected monitoring events.
Step 2. Verify in Datadog
Open the Event Stream or a Dashboard in Datadog and verify that the event has been received.
Verification
✔ The event has been received by Datadog.
✔ The generated event has been delivered successfully.
Configuration Complete
After the configuration is saved, the integration becomes active.
From this point forward, whenever one of the selected events occurs, the corresponding event is automatically sent to Datadog.
Troubleshooting
If events do not appear in Datadog, verify the following.
| Issue | Verification |
|---|---|
| Events do not appear | Verify that the API Key, Application Key, and Datadog Site are correct and do not contain leading or trailing spaces. |
| Authentication error occurs | Verify that the API Key and Application Key are valid and have not been deleted or regenerated. |
| Site mismatch | Verify that the selected Datadog Site matches the Site where the credentials were generated. (For example, credentials created for a US organization cannot be used with an EU Site.) |
| Insufficient Application Key permissions | Verify that the Application Key has the required permissions (scopes). |
| Integration fails in a restricted network | Verify that outbound HTTPS communication (port 443) to the API endpoint of the selected Datadog Site is allowed through the firewall or proxy. |