Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EDU-576: Datadog integration #2422

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/integrations/index.textile
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The following pre-built Webhooks can be configured:
* "Zapier":/docs/integrations/webhooks/zapier
* "Cloudflare Workers":/docs/integrations/webhooks/cloudflare
* "IFTTT":/docs/integrations/webhooks/ifttt
* "Datadog":/docs/integrations/webhooks/datadog

h2(#continuous). Outbound streaming

Expand Down
54 changes: 54 additions & 0 deletions content/integrations/streaming/datadog.textile
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Datadog
meta_description: "Connect Ably and Datadog to monitor messages, channels, and connections in realtime, integrating your Ably statistics with your existing Datadog setup."
meta_keywords: "Datadog, integrations, statistics, metrics, monitoring, analytics, enterprise"
---

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 using the a generated API key, which is derived from "metadata subscriptions.":/metadata-stats/metadata/subscribe

h2(#setup). Setup the Datadog integration

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.

Once the integration is active, Datadog provides a specific Ably "dashboard":https://docs.datadoghq.com/integrations/ably/, allowing you to monitor key metrics without extra setup.

The following steps setup the Datadog integration:

# In Datadog, go to *Integrations*, find the *Ably* tile, and click *Install Integration*.
# Click *Connect Accounts* to start the authorization process. Datadog redirects you to Ably.
# Log in to your *Ably* account.
# Select your application from the *Your Apps* page.
# Navigate to *Integrations*, and select *Connect to Datadog*.
# Datadog authorization page, authorize Ably using *OAuth* to grant access. The required authorization scope is: @api_keys_write@.
# After completing authorization, you will be redirected to the *Ably dashboard*, and the process is complete.

h2(#remove). Remove access

Removing access disconnects Ably from Datadog, stopping data transmission and revoking authorization. Follow the steps remove the Ably and Datadog integration using either platform.

h3(#in-ably). Remove access using Ably

* Open your application's integration settings.
* Click *Remove* next to the Datadog integration.
* Ably revokes OAuth credentials and stops metric transmission.

h3(#in-datadog). Remove access using Datadog

* Remove associated Ably API keys via *Integrations* or *API Keys*.
* Adjust scopes or entirely revoke OAuth tokens if necessary.

h2(#lite). Datadog lite

Ably streams a limited set of "statistics":/docs/metadata-stats/stats#metrics to the Datadog API. Datadog-lite minimizes data usage, making it a cost-effective alternative for use cases that don't need full statistics.

The following statistics are streamed from Ably to Datadog:

* @messages.all.messages@
* @messages.all.presence@
* @messages.inbound.all.all@
* @messages.outbound.all.all@
* @connections.all.peak@
* @channels.peak@
* @push.channelMessages@
* @messages.persisted.messages@
* @messages.persisted.presence@
2 changes: 1 addition & 1 deletion content/pricing/enterprise.textile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Enterprise packages can include features such as:
- Custom CNAMEs := use your own custom domain, or a subdomain of Ably for your application or service.
- SAML and SCIM := authenticate with Ably using your own Identity Provider (IdP) and automatically provision users within your Ably account.
- Active traffic management := Ably can monitor the health of your own endpoints and proactively take steps to isolate, or move, traffic to ensure business continuity.
- DataDog := send metrics from Ably into your DataDog account.
- DataDog := send metrics from Ably into your "DataDog":/docs/integrations/streaming/datadog account.
- PrivateLink := enable traffic from your users and servers into Ably without using the public internet via "AWS PrivateLink":https://aws.amazon.com/privatelink/.
- Private clusters := guaranteed capacity and isolation from all other Ably users.

Expand Down
4 changes: 4 additions & 0 deletions src/data/nav/platform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@ export default {
name: 'Pulsar',
link: '/docs/integrations/streaming/pulsar',
},
{
name: 'DataDog',
link: '/docs/integrations/streaming/datadog',
},
],
},
{
Expand Down