|
| 1 | +--- |
| 2 | +title: Datadog |
| 3 | +meta_description: "Connect Ably and Datadog to monitor messages, channels, and connections in realtime, integrating your Ably statistics with your existing Datadog setup." |
| 4 | +meta_keywords: "Datadog, integrations, statistics, metrics, monitoring, analytics, enterprise" |
| 5 | +--- |
| 6 | + |
| 7 | +The Ably "Datadog":https://docs.datadoghq.com/integrations/ably/ integration enables you to monitor your application's statistics. Every 60 seconds, Ably streams a comprehensive set of "statistics":/docs/metadata-stats/stats#metrics to the Datadog API. |
| 8 | + |
| 9 | +h2(#setup). Setup the Datadog integration |
| 10 | + |
| 11 | +To connect Ably with Datadog, you must "request":https://ably.com/support access to the integration. Once granted, you can 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. |
| 12 | + |
| 13 | +Once the integration is active, Datadog provides a specific Ably "dashboard":https://docs.datadoghq.com/integrations/ably/, enabling you to monitor key metrics without extra setup. |
| 14 | + |
| 15 | +The following steps setup the Datadog integration: |
| 16 | + |
| 17 | +# In Datadog, go to *Integrations*, find the *Ably* tile, and click *Install Integration*. |
| 18 | +# Click *Connect Accounts* to start the authorization process. Datadog redirects you to Ably. |
| 19 | +# Log in to your *Ably* account. |
| 20 | +# Select your application from the *Your Apps* page. |
| 21 | +# Navigate to *Integrations*, and select *Connect to Datadog*. |
| 22 | +# Datadog authorization page, authorize Ably using *OAuth* to grant access. The required authorization scope is: @api_keys_write@. |
| 23 | +# After completing authorization, you will be redirected to the *Ably dashboard*, and the process is complete. |
| 24 | + |
| 25 | +h2(#remove). Remove access |
| 26 | + |
| 27 | +Removing access disconnects Ably from Datadog, stopping data transmission and revoking authorization. Follow the steps remove the Ably and Datadog integration using either platform. |
| 28 | + |
| 29 | +h3(#in-ably). Remove access using Ably |
| 30 | + |
| 31 | +* Open your application's integration settings. |
| 32 | +* Click *Remove* next to the Datadog integration. |
| 33 | +* Ably revokes OAuth credentials and stops metric transmission. |
| 34 | + |
| 35 | +h3(#in-datadog). Remove access using Datadog |
| 36 | + |
| 37 | +* Remove associated Ably API keys via *Integrations* or *API Keys*. |
| 38 | +* Adjust scopes or entirely revoke OAuth tokens if necessary. |
| 39 | + |
| 40 | +h2(#lite). Datadog lite |
| 41 | + |
| 42 | +Datadog Lite is a lightweight version of the full Datadog integration that sends a reduced set of "statistics":/docs/metadata-stats/stats#metrics to the Datadog API, available for "enterprise":/docs/pricing/enterprise customers. This integration is designed for use cases where full statistics are not required, such as when you only need to monitor a limited number channels or connections. |
| 43 | + |
| 44 | +The following statistics are streamed from Ably to Datadog: |
| 45 | + |
| 46 | +|_. Metric |_. Description | |
| 47 | +| @messages.all.messages@ | Total number of messages (excluding presence and state messages). | |
| 48 | +| @messages.all.presence@ | Total number of presence messages. | |
| 49 | +| @messages.inbound.all.all@ | Total number of inbound messages received by Ably from clients. | |
| 50 | +| @messages.outbound.all.all@ | Total number of outbound messages sent from Ably to clients. | |
| 51 | +| @connections.all.peak@ | Peak number of simultaneous realtime connections. | |
| 52 | +| @channels.peak@ | Peak number of active channels. | |
| 53 | +| @push.channelMessages@ | Total number of channel messages that included a push payload. | |
| 54 | +| @messages.persisted.messages@ | Total number of persisted messages (excluding presence and state messages). | |
| 55 | +| @messages.persisted.presence@ | Total number of persisted presence messages. | |
| 56 | + |
| 57 | + |
0 commit comments