Skip to content

Commit 0520c09

Browse files
fixup! EDU-576: Datadog integration
1 parent 1f59785 commit 0520c09

File tree

1 file changed

+27
-35
lines changed

1 file changed

+27
-35
lines changed

content/datadog.textile

Lines changed: 27 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,41 @@ meta_description: "Connect Ably and Datadog to monitor messages, channels, and c
44
meta_keywords: "Datadog, integrations, metrics, monitoring, analytics, enterprise"
55
---
66

7-
The Ably Datadog integration allows enterprise users to monitor real-time application metrics like messages, channels, and connections within Datadog. Data streams every 60 seconds make tracking key performance indicators easier in one place.
7+
The Ably "Datadog":https://docs.datadoghq.com/integrations/ably/ integration allows "enterprise":/pricing/enterprise users to monitor realtime application metrics like "messages":/messages, "channels":/channels, and connections within Datadog. Data streams every 60 seconds make tracking key performance indicators easier in one place. If you require access, contact "support":https://ably.com/support to enable the integration feature via your "dashboard":https://ably.com/accounts/any.
88

9-
This integration is available only to Ably enterprise customers. If you need access, contact your Ably representative. Once set up, Ably sends realtime statistics, including messages, channel counts, and connection usage, to Datadog every 60 seconds, helping you keep track of your application's performance.
9+
If you're on the Ably "Pro plan":/pricing/pro, you can enable a limited Datadog-lite integration. "Standard plan":/pricing/standard users may request a 30-day trial to evaluate Datadog-lite before upgrading. This version includes a smaller set of metrics but still provides visibility into your Ably usage. If you need detailed analytics, per-channel breakdowns, custom dashboards, or advanced logging, upgrade to the full Datadog integration available on the Enterprise plan.
1010

11-
Ably includes App ID and Account ID tags with each metric to help with data organization. These ID tags enable you to filter, group, and analyze information efficiently, making it more manageable to spot trends and diagnose issues in your Datadog dashboard.
11+
|_. Feature |_. Datadog-lite |_. Full Datadog (Enterprise) |
12+
| Messages | ✅ | ✅ |
13+
| Connections | ✅ | ✅ |
14+
| Channels | ✅ | ✅ |
15+
| Bandwidth | ✅ | ✅ |
16+
| Message size | ✅ | ✅ |
17+
| Message direction breakdown (Inbound vs. Outbound) | ❌ | ✅ |
18+
| Per-Channel metrics | ❌ | ✅ |
19+
| Usage analytics & trends | ❌ | ✅ |
20+
| Custom dashboards & alerts | ❌ | ✅ |
21+
| Advanced logging & debugging | ❌ | ✅ |
1222

13-
To connect Ably and Datadog, you must authorize the integration through Datadog's OAuth flow. This process requires the api_keys_write scope, allowing Ably to push data to your Datadog account. Once the integration is active, Datadog provides a default Ably dashboard so that you can monitor key metrics without extra setup.
1423

15-
Ably follows a structured workflow to ensure secure authorization and reliable data transmission. After authorization, it stores the Datadog access_token and refresh_token (encrypted). It also saves the Datadog site URL (such as https://api.datadoghq.eu) to manage token refreshes.
24+
Ably includes @AppID@ and @AccountID@ tags with each metric to help with data organization. These ID tags enable you to filter, group, and analyze information efficiently, making it more manageable to spot trends and diagnose issues in your Datadog "dashboard":https://docs.datadoghq.com/dashboards/.
1625

17-
Every 60 seconds, Ably pushes metrics to the Datadog API using the generated API key. Metrics come from channels like [meta]stats.minute and include App ID and Account ID tags. Datadog then displays these metrics in the Ably dashboard, giving you a clear view of messages, channels, and connections.
26+
To connect Ably and Datadog, you must authorize the integration through Datadog's "OAuth":https://docs.datadoghq.com/developers/integrations/oauth_for_integrations/ flow. This process requires the @api_keys_write@ scope, allowing Ably to push data to your Datadog account. Once the integration is active, Datadog provides a default Ably "dashboard":https://docs.datadoghq.com/integrations/ably/ so that you can monitor key metrics without extra setup.
1827

19-
You can also manage the integration through Ably's Control API or Terraform. If OAuth isn't an option, you may need to use a manually generated Datadog API token.
20-
21-
To use this integration, you must have an Ably Enterprise Account. Your Datadog Account also needs permission to install integrations and generate API keys. These requirements ensure the integration runs smoothly and provide full visibility into your Ably application metrics.
28+
Every 60 seconds, Ably streams "statistics":https://ably.com/docs/metadata-stats/stats to the Datadog API using the generated API key. Metrics come from channels like @[meta]stats.minute@ and include App ID and Account ID tags. Datadog then displays these metrics in the Ably dashboard, giving you a clear view of messages, channels, and connections.
2229

2330
h2. Set up the Ably Datadog integration
2431

25-
Initiate the integration from the Datadog Integrations menu or the Ably dashboard:
26-
27-
h3. Set up in Datadog
28-
29-
* Go to *Integrations* > *All Integrations*.
30-
* Find the *Ably* tile and select *Install Integration*.
31-
* Click *Connect Accounts* to proceed. Datadog redirects you to Ably.
32-
33-
h4. Authorize Ably in Datadog
34-
35-
* When prompted, grant Ably OAuth access with the @api_keys_write@ scope.
36-
* After authorization, Datadog redirects you back to Ably.
37-
38-
h3. Setup in Ably
39-
40-
* Log in to your Ably account.
41-
* Select your application from *Your apps*.
42-
* Go to the *Integrations* menu and select *Connect to Datadog* (if not already connected during redirection).
43-
* Confirm the integration. A success banner will appear with an option to *See the Dashboard* in Datadog.
44-
45-
h4. Verify in Datadog
32+
Initiate the integration from the Datadog:
4633

47-
* Click *See Dashboard* to access Datadog.
48-
* After about a minute, data from Ably should start flowing into Datadog and populate your default Ably dashboard.
49-
* _Note_: Ably pushes statistics to Datadog every 60 seconds, so data may take a moment to appear.
34+
# In Datadog, go to *Integrations*, find the *Ably* tile, and click *Install Integration*.
35+
# Click *Connect Accounts* to start the authorization process. Datadog redirects you to Ably.
36+
# Log in to your *Ably* account.
37+
# Select your application from the *Your Apps* page.
38+
# In the Ably dashboard, navigate to *Integrations* and select *Connect to Datadog*.
39+
# When prompted in Datadog, authorize Ably using *OAuth* to grant access. Required authorization scope:
40+
* @api_keys_write@
41+
# After completing authorization, return to the Ably dashboard. A confirmation banner appears, along with a *See Dashboard* button that takes you to your Datadog dashboard list.
5042

5143
h3. Troubleshoot
5244

@@ -58,15 +50,15 @@ If your connection remains in this state, your setup may have been interrupted.
5850

5951
For example, this can occur when a message is published while the connection is in a suspended state.
6052

61-
*Resolution*: Reauthorize the integration or contact Ably Support for assistance.
53+
*Resolution*: Reauthorize the integration.
6254

6355
h4. Connection failed
6456

6557
If the connection fails, it may be due to incorrect network settings or insufficient OAuth permissions in Datadog.
6658

6759
For example, this can happen if the OAuth scope api_keys_write was not granted during authorization or if network restrictions block communication between Ably and Datadog.
6860

69-
*Resolution*: Verify your network settings and ensure the required OAuth permissions are granted in Datadog. If issues persist, contact Ably Support for assistance.
61+
*Resolution*: Verify your network settings and ensure the required OAuth permissions are granted in Datadog.
7062

7163
h4. Duplicate API key
7264

0 commit comments

Comments
 (0)