EDU-576: Datadog integration #2422
Open
+60
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
franrob-projects
temporarily deployed
to
ably-docs-edu-576-docs--f4vh5l
franrob-projects
force-pushed
the
EDU-576-Docs-for-datadog-integration
branch
from
0520c09 to
01c9958
Compare
franrob-projects
temporarily deployed
to
ably-docs-edu-576-docs--f4vh5l
franrob-projects
temporarily deployed
to
ably-docs-edu-576-docs--f4vh5l
franrob-projects
force-pushed
the
EDU-576-Docs-for-datadog-integration
branch
from
cff2dd9 to
62da7a0
Compare
franrob-projects
temporarily deployed
to
ably-docs-edu-576-docs--f4vh5l
franrob-projects
temporarily deployed
to
ably-docs-edu-576-docs--f4vh5l
franrob-projects
force-pushed
the
EDU-576-Docs-for-datadog-integration
branch
from
5bb31d5 to
f496832
Compare
franrob-projects
temporarily deployed
to
ably-docs-edu-576-docs--f4vh5l
m-hulbert
requested changes
Mar 13, 2025
There was a problem hiding this comment.
The content mostly looks good here. I've made a few suggestions for improved readability and I think we should be more explicit about the metrics.
Also:
/docs/into links now please- can we add this into the nav and add appropriate links (overview and pricing pages)
content/datadog.textile
Outdated
| meta_keywords: "Datadog, integrations, metrics, monitoring, analytics, enterprise" | ||
| --- | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| The Ably "Datadog":https://docs.datadoghq.com/integrations/ably/ integration enables you to monitor your application's statistics metrics, such as "messages":/docs/messages, "channels":/docs/channels, and "connections":/docs/connect, within Datadog. |
content/datadog.textile
Outdated
Comment on lines
9
to
21
| 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. | ||
|
|
||
| |_. Feature |_. Datadog-lite |_. Full Datadog (Enterprise) | | ||
| | Messages | ✅ | ✅ | | ||
| | Connections | ✅ | ✅ | | ||
| | Channels | ✅ | ✅ | | ||
| | Bandwidth | ✅ | ✅ | | ||
| | Message size | ✅ | ✅ | | ||
| | Message direction breakdown (Inbound vs. Outbound) | ❌ | ✅ | | ||
| | Per-Channel metrics | ❌ | ✅ | | ||
| | Usage analytics & trends | ❌ | ✅ | | ||
| | Custom dashboards & alerts | ❌ | ✅ | | ||
| | Advanced logging & debugging | ❌ | ✅ | |
There was a problem hiding this comment.
Suggested change
| 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. | |
| |_. Feature |_. Datadog-lite |_. Full Datadog (Enterprise) | | |
| | Messages | ✅ | ✅ | | |
| | Connections | ✅ | ✅ | | |
| | Channels | ✅ | ✅ | | |
| | Bandwidth | ✅ | ✅ | | |
| | Message size | ✅ | ✅ | | |
| | Message direction breakdown (Inbound vs. Outbound) | ❌ | ✅ | | |
| | Per-Channel metrics | ❌ | ✅ | | |
| | Usage analytics & trends | ❌ | ✅ | | |
| | Custom dashboards & alerts | ❌ | ✅ | | |
| | Advanced logging & debugging | ❌ | ✅ | | |
| If you're on the Ably "Pro package":/docs/pricing/pro, you can set up a Datadog-lite integration. This streams a subset of the metrics that available with the full integration to Datadog. | |
| If you're a "Standard package":/docs/pricing/standard user, you can request a 30-day trial to evaluate Datadog-lite. | |
| |_. Feature |_. Datadog-lite |_. Full Datadog (Enterprise) | | |
| | Messages | ✅ | ✅ | | |
| | Connections | ✅ | ✅ | | |
| | Channels | ✅ | ✅ | | |
| | Bandwidth | ✅ | ✅ | | |
| | Message size | ✅ | ✅ | | |
| | Message direction breakdown (Inbound vs. Outbound) | ❌ | ✅ | | |
| | Per-Channel metrics | ❌ | ✅ | | |
| | Usage analytics & trends | ❌ | ✅ | | |
| | Custom dashboards & alerts | ❌ | ✅ | | |
| | Advanced logging & debugging | ❌ | ✅ | |
I'd suggest moving this to the end under a 'Datadog Lite' heading. You can then link the mentions of Datadog Lite (and Datadog) from the pricing pages too.
Also I'm not sure this table is strictly correct in terms of what is available with the Lite offering. If you take a look at REA-2119 this has the list of metrics available which may be more beneficial to document.
content/datadog.textile
Outdated
| | Advanced logging & debugging | ❌ | ✅ | | ||
|
|
||
|
|
||
| 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/. |
There was a problem hiding this comment.
I'm not sure this paragraph says much 🙂
content/datadog.textile
Outdated
|
|
||
| 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/. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Should this be under a 'Configure' or 'Setup' section?
There was a problem hiding this comment.
I'd also suggest that would be a better place to mention that it needs to be requested to use.
content/datadog.textile
Outdated
|
|
||
| h2. Set up the Ably Datadog integration | ||
|
|
||
| Initiate the integration from the Datadog: |
There was a problem hiding this comment.
Suggested change
| Initiate the integration from the Datadog: | |
| Initiate the integration from Datadog: |
content/datadog.textile
Outdated
|
|
||
| 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. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
I think we should link out to the metrics that are available (they're documented in stats) rather than referencing the meta channel.
Maybe something like:
The full list of which "statistics metrics":/docs/metadata-stats/stats#metrics are sent to Datadog are the same as those available from querying an application's statistics programmatically. These are streamed every 60 seconds to Datadog and include an App and Account ID to easily filter by.
content/datadog.textile
Outdated
|
|
||
| If your connection remains in this state, your setup may have been interrupted. | ||
|
|
||
| For example, this can occur when a message is published while the connection is in a suspended state. |
There was a problem hiding this comment.
This seems unrelated to Datadog?
content/datadog.textile
Outdated
|
|
||
| h3. Troubleshoot | ||
|
|
||
| If the provided information does not resolve your issue, contact Ably "support":https://ably.com/support. When contacting, include details such as your app ID, and any relevant logs to help troubleshoot. |
There was a problem hiding this comment.
This sort of message would normally go after the troubleshooting sections, but I'm not sure if it's relevant to include.
content/datadog.textile
Outdated
| @@ -0,0 +1,83 @@ | |||
| --- | |||
| title: Ably Datadog integration | |||
There was a problem hiding this comment.
Maybe just 'Datadog integration' or 'Datadog'?
franrob-projects
temporarily deployed
to
ably-docs-edu-576-docs--idgjl1
franrob-projects
force-pushed
the
EDU-576-Docs-for-datadog-integration
branch
from
113ebc0 to
4265efb
Compare
franrob-projects
temporarily deployed
to
ably-docs-edu-576-docs--idgjl1
franrob-projects
temporarily deployed
to
ably-docs-edu-576-docs--idgjl1
franrob-projects
force-pushed
the
EDU-576-Docs-for-datadog-integration
branch
from
afab6ca to
43fdf8c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces documentation for the Ably Datadog integration, covering:
EDU-576