538-datadog-integration (#1321)

agora-analytics/analyze/video-voice-sdk/datadog-integration.mdx → agora-analytics/analyze/datadog-integration.mdx

@@ -1,13 +1,13 @@
 ---
 title: 'Integrate Analytics with Datadog'
-sidebar_position: 6
+sidebar_position: 3
 platform_selector: false
 description: >
   Configure Agora Analytics to push data directly to your Datadog dashboard.
 ---
 
-import DOC from '@docs/shared/agora-analytics/_datadog-integration.mdx';
+import Datadog from '@docs/shared/agora-analytics/_datadog-integration.mdx';
 
 export const toc = [{}]
 
-<DOC PRODUCT="Agora Analytics" CLIENT="app" PATH="agora-analytics" />
+<Datadog />

agora-analytics/overview/product-overview.mdx

@@ -48,7 +48,7 @@ description: >
 
 >
 
-<Vg k="AA" /> tracks and analyzes the usage, quality, and performance of real-time voice and video live streams. Designed as a companion to <Vg k="COMPANY" />'s <Vg k="AUDIO" />, <Vg k="VIDEO" />, <Vg k="BS" />, and <Vg k="ILS" />, it helps locate quality issues, identify root causes, and resolve problems to enhance the end-user experience. Monitor sessions in real-time with Call Inspector or use RESTful APIs to analyze usage trends and performance.
+<Vg k="AA" /> tracks and analyzes the usage, quality, and performance of real-time voice and video live streams and other <Vg k="COMPANY" /> products. Designed as a companion to <Vg k="COMPANY" />'s <Vg k="AUDIO" />, <Vg k="VIDEO" />, <Vg k="BS" />, <Vg k="ILS" />, and <Vg k="CHAT" /> it helps locate quality issues, identify root causes, and resolve problems to enhance the end-user experience. Monitor sessions in real-time with Call Inspector or use RESTful APIs to analyze usage trends and performance.
 
 Extend <Vg k="AA" /> with the Datadog integration to bring Agora Analytics data into your Datadog account. Visualize and monitor metrics, set up custom alerts, and manage Agora data alongside other system metrics for a unified view of performance and quality.
 

shared/agora-analytics/_datadog-integration.mdx

@@ -1,58 +1,102 @@
-import * as data from '@site/data/variables.js';
-
-[Datadog](https://docs.datadoghq.com/) is an observability service for cloud-scale applications, providing monitoring of servers, databases, tools, and services, through a SaaS-based data analytics platform. It enables you to visualize and monitor metrics, setup custom alerts, create dashboards and more. To analyze <Vg k="COMPANY" /> data with your other integrations, you can push <Vg k="AA" /> usage, quality, and performance data directly to your Datadog account.
+[Datadog](https://docs.datadoghq.com/) is an observability service for cloud-scale applications, that provides monitoring of servers, databases, tools, and services, through a SaaS-based data analytics platform. It enables you to visualize and monitor metrics, setup custom alerts, and create dashboards. To analyze <Vg k="COMPANY" /> products data with your other integrations, you can push <Vg k="AA" /> usage, quality, and performance statistics directly to your Datadog account.
 
 This page shows you how to setup DataDog integration with <Vg k="AA" />.
 
 ## Enable and configure Datadog
 
-To push  <Vg k="AA" /> information to Datadog:
+To enable  <Vg k="AA" /> integration with Datadog:
 
-1.  In <Vg k="CONSOLE" />, subscribe to a **Premium** or **Enterprise** [pricing plan](https://console.agora.io/aa/pricing).
+1. In <Vg k="CONSOLE" />, subscribe to the **Premium** or **Enterprise** [pricing plan](https://console.agora.io/aa/pricing).
 
-2.  In [<Vpd k="NAME"/>](https://analytics-lab.agora.io/), click **Integration > Datadog**.
+1.  In [<Vpd k="NAME"/>](https://analytics-lab.agora.io/), navigate to **Integration > Datadog**.
+
+    ![](/images/analytics/datadog-integration-step-1.png)
 
-3. Press **Apply**.
+1. Press **Apply** to initiate a request to enable Datadog. The <Vg k="COMPANY" /> support team will contact you once the feature is enabled.
 
     ![](/images/analytics/apply-datadog-package.png)
-    This initiates Datadog enablement. [<Vg k="COMPANY" /> support](mailto:[email protected]) will reach out to you once the feature is enabled.
 
-    You can only use Datadog with <Vg k="AA" /> when the Datadog Integration is enabled in your Datadog package.
+    <Admonition type="info">
+    You can use Datadog with <Vg k="AA" /> only if Datadog integration is included in your Datadog package.
+    </Admonition>
 
-4. Update the Datadog configuration:
+1. On the configuration page, select the **Metrics** you want to monitor with Datadog.
 
-    ![](/images/analytics/datadog-configuration.png)
+    ![](/images/analytics/datadog-integration-step-2.png)
 
-    **Note**: It can take up to five minutes before data push is resumed or stopped after you change status.
+1. Enter your Datadog API key and press **Save**.  An API key is required to submit metrics and events to Datadog. 
+
+    ![](/images/analytics/datadog-integration-step-3.png)
 
-You can now use Datadog to analyse your use of  <Vg k="COMPANY" /> products.
+1. When configuration is successful, the **Configuration Status** updates to **Online**.
 
-## Reference
+    The following information is displayed on the configuration page: 
+
+        - **Updated at**: Last data push in your local timezone.
+        - **Updated by**: Last user to enable or disable the feature.
+        - **Expiration date**: Effective time remaining before the package expires.
+
+    ![](/images/analytics/datadog-integration-step-4.png)
 
-You can configure the following parameter groups for Datadog
+    <Admonition type="info">
+    It can take up to five minutes before data push is resumed or stopped after you change the status.
+    </Admonition>
 
--  **General information**
+You are now ready to use Datadog to analyze use of your <Vg k="COMPANY" /> products.
 
-    - **Configuration status**: Displays whether Datadog integration is in use currently.
+## Add Analytics to your Datadog dashboard
 
-    - **Updated at**: Last data push in your local timezone.
-    - **Updated by**: Last user to enable/disable the feature.
-    - **Expiration date**: Effective time remaining before the package expires.
+To display <Vpd k="NAME" /> metrics on your Datadog dashboard:
 
-- **API Configuration and data selection**
+1. Log in to your Datadog account. Navigate to the **Integrations** page and search for "Agora." Agora Analytics Integration appears in your search results.
+
+    ![](/images/analytics/datadog-integration-step-5.png)
 
-    - **API key**: In order that data is pushed to the right address, you have to share your Datadog API key with <Vg k="COMPANY"/>,
+1. Select **Agora Analytics** and add it to your Datadog dashboard.
 
-    - **Data content**: Select the data to export to Datadog from:
+    ![](/images/analytics/datadog-integration-step-6.png)
+
+1. Open the Datadog dash board. You see statistics from Agora Analytics displayed on your Datadog dashboard.
+
+    ![](/images/analytics/datadog-integration-step-7.png)
+
+## Reference
 
-        | Metric name                                    | Description                                                                                                                                                           |
-        |------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-        | agora.rtc.app_id.online_user                   | Number of online users aggregated by appid, calculated every minute.                                                                                                  |
-        | agora.rtc.app_id.online_channel                | Number of online channels aggregated by appid, calculated every minute.                                                                                               |
-        | agora.rtc.app_id.join_success_rate             | Join success rate aggregated by appid, calculated every minute.                                                                                                       |
-        | agora.rtc.app_id.join_success_in_5s_rate       | Join success rate within 5 seconds aggregated by appid, calculated every minute.                                                                                      |
-        | agora.rtc.app_id.join_attempt                  | Number of join attempts aggregated by appid, calculated every minute.                                                                                                 |
-        | agora.rtc.app_id.join_success_count            | Number of join success aggregated by appid, calculated every minute.                                                                                                  |
-        | agora.rtc.app_id.audio_freeze_rate             | Audio freeze rate aggregated by appid, calculated every minute.                                                                                                       |
-        | agora.rtc.app_id.video_freeze_rate             | Video freeze rate aggregated by appid, calculated every minute.                                                                                                       |
-        | agora.rtc.app_id.network_delay_rate            | Network delay rate aggregated by appid, calculated every minute.                                                                                                      |
+See the <Vpd k="NAME" /> [Integration page on Datadog](https://docs.datadoghq.com/integrations/agora_analytics/).
+
+
+### RTC metrics
+
+<Vpd k="NAME" /> provides the following RTC metrics to Datadog:
+
+| Metric name | Description|
+|:--------------|:--------------|
+| `agora.rtc.app_id.online_user` (count)   | Number of online users aggregated by appid, calculated every minute.   |
+| `agora.rtc.app_id.online_channel` (count) | Number of online channels aggregated by appid, calculated every minute.|
+| `agora.rtc.app_id.join_success_rate` (rate)  | Join success rate aggregated by appid, calculated every minute.   |
+| `agora.rtc.app_id.join_success_in_5s_rate` (rate) | Join success rate within 5 seconds aggregated by appid, calculated every minute. |
+| `agora.rtc.app_id.join_attempt` (count)  | Number of join attempts aggregated by appid, calculated every minute.  |
+| `agora.rtc.app_id.join_success_count` (count) | Number of join success aggregated by appid, calculated every minute.   |
+| `agora.rtc.app_id.audio_freeze_rate` (rate)  | Audio freeze rate aggregated by appid, calculated every minute.   |
+| `agora.rtc.app_id.video_freeze_rate` (rate)  | Video freeze rate aggregated by appid, calculated every minute.   |
+| `agora.rtc.app_id.network_delay_rate` (rate) | Network delay rate aggregated by appid, calculated every minute.  |
+
+### Chat metrics
+
+<Vpd k="NAME" /> provides the following Chat metrics to Datadog:
+
+| Metric name     | Description   |
+|:----------------|:--------------|
+| `agora.chat.group.total` (count)  | Total chat groups. |
+| `agora.chat.group.new` (count)    | Daily new chat groups.  |
+| `agora.chat.group.disbanded` (count)   | Daily disbanded chat groups. |
+| `agora.chat.group.active` (count) | Daily active chat groups.    |
+| `agora.chat.room.total` (count)   | Total chat rooms.  |
+| `agora.chat.room.new` (count)| Daily new chat rooms.   |
+| `agora.chat.room.disbanded` (count)    | Daily disbanded chat rooms.  |
+| `agora.chat.room.active` (count)  | Daily active chat rooms.|
+| `agora.chat.room.pcu` (count)| Daily chat room peak concurrent users. |
+| `agora.chat.user.total` (count)   | Total registered users. |
+| `agora.chat.user.dnu` (count)| Daily new users.   |
+| `agora.chat.user.dau` (count)| Daily active users.|
+| `agora.chat.user.maxdau` (count)  | Monthly max daily active users.   |