diff --git a/agora_analytics/CHANGELOG.md b/agora_analytics/CHANGELOG.md index b867db509..b0bf7c21d 100644 --- a/agora_analytics/CHANGELOG.md +++ b/agora_analytics/CHANGELOG.md @@ -5,3 +5,7 @@ ***Added***: * Initial Agora Integration + +## 1.0.1 / 2024-10-15 + +* Update Dashboard Agora Analytics with new widgets for chat metrics \ No newline at end of file diff --git a/agora_analytics/README.md b/agora_analytics/README.md index 20fe53a2c..661617399 100644 --- a/agora_analytics/README.md +++ b/agora_analytics/README.md @@ -2,7 +2,7 @@ ## Overview -Agora Analytics tracks and interprets real-time voice and video usage, quality, and performance. Analytics is an extension for Agora's Voice Calling, Video Calling, and Interactive Live Streaming that helps to locate quality issues, find root causes, and fix issues to improve the end-user experience. +Agora Analytics tracks and interprets chat, real-time voice and video usage, quality, and performance. Analytics is an extension for Agora's Voice Calling, Video Calling, Interactive Live Streaming and Agora's Chat that helps to locate quality issues, find root causes, and fix issues to improve the end-user experience. This integration sends metrics including usage, quality, and performance data directly to your Datadog account. @@ -14,7 +14,7 @@ See the Agora Analytics integration [documentation][1] for details on configurin ### Metrics -Agora Analytics emits metrics to Datadog. +Agora Analytics emits metrics to Datadog, aggregated by appid and calculated every minute. See [metadata.csv][3] for a list of metrics provided by this check. ### Events @@ -29,4 +29,5 @@ Agora Analytics does not include any service checks. Need help? Contact [Agora Support][2]. [1]: https://docs.agora.io/en/agora-analytics/analyze/video-voice-sdk/datadog-integration -[2]: mailto:support@agora.io \ No newline at end of file +[2]: mailto:support@agora.io +[3]: https://github.com/DataDog/integrations-extras/blob/master/agora_analytics/metadata.csv diff --git a/agora_analytics/assets/dashboards/agora_analytics_overview.json b/agora_analytics/assets/dashboards/agora_analytics_overview.json index 94b4bb3dc..24af96403 100644 --- a/agora_analytics/assets/dashboards/agora_analytics_overview.json +++ b/agora_analytics/assets/dashboards/agora_analytics_overview.json @@ -1,404 +1,1326 @@ { - "title": "Agora Analytics", - "description": "Agora Analytics\n\nThis dashboard monitors ongoing Agora RTC usage, quality, and performance, allowing you to see whether your RTC service require attention.\n\nFor more details, please visit https://docs.agora.io/en/agora-analytics/analyze/video-voice-sdk/datadog-integration", - "widgets": [ - { - "id": 4552268843133742, - "definition": { - "title": "Online User Count", - "title_size": "16", - "title_align": "left", - "type": "query_value", - "requests": [ - { - "response_format": "scalar", - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.online_user{*}", - "aggregator": "last" - } - ], - "conditional_formats": [ - { - "comparator": ">=", - "palette": "white_on_green", - "value": 10000 - }, - { "comparator": "<", "palette": "white_on_red", "value": 10000 } - ], - "formulas": [{ "formula": "query1" }] - } - ], - "autoscale": true, - "precision": 2, - "timeseries_background": { "type": "area" } - }, - "layout": { "x": 0, "y": 0, "width": 2, "height": 2 } - }, - { - "id": 2729842319365608, - "definition": { - "title": "Online Channel Count", - "title_size": "16", - "title_align": "left", - "type": "query_value", - "requests": [ - { - "response_format": "scalar", - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.online_channel{*}", - "aggregator": "last" - } - ], - "conditional_formats": [ - { - "comparator": ">=", - "palette": "white_on_green", - "value": 1500 - }, - { "comparator": "<", "palette": "white_on_red", "value": 1500 } - ], - "formulas": [{ "formula": "query1" }] - } - ], - "autoscale": true, - "precision": 2, - "timeseries_background": { "type": "area" } - }, - "layout": { "x": 2, "y": 0, "width": 2, "height": 2 } - }, - { - "id": 1300084570186116, - "definition": { - "title": "Online User Count", - "title_size": "16", - "title_align": "left", - "show_legend": true, - "legend_layout": "auto", - "legend_columns": ["avg", "min", "max", "value", "sum"], - "type": "timeseries", - "requests": [ - { - "formulas": [{ "formula": "query1" }], - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.online_user{*} by {product_type}" - } - ], - "response_format": "timeseries", - "style": { - "palette": "dog_classic", - "line_type": "solid", - "line_width": "normal" + "title": "Agora Analytics", + "description": "Agora Analytics\nThis dashboard monitors ongoing usage, quality, and performance for Agora RTC and Agora Chat, allowing you to see whether your service require attention.\n\nFor more details, please visit https://docs.agora.io/en/agora-analytics/analyze/video-voice-sdk/datadog-integration. ", + "widgets": [ + { + "id": 1668232137465056, + "definition": { + "title": "About", + "background_color": "vivid_purple", + "show_title": true, + "type": "group", + "layout_type": "ordered", + "widgets": [ + { + "id": 195427609631296, + "definition": { + "type": "image", + "url": "https://raw.githubusercontent.com/DataDog/integrations-extras/2a0c40343d32d5c37d3916047d043ee5bb602a13/agora_analytics/assets/logos/agora_logo.svg", + "sizing": "cover", + "margin": "sm", + "has_background": true, + "has_border": true, + "vertical_align": "center", + "horizontal_align": "center" + }, + "layout": { + "x": 0, + "y": 0, + "width": 3, + "height": 2 + } + }, + { + "id": 419156946734526, + "definition": { + "type": "note", + "content": "Agora Analytics tracks and interprets the usage, quality, and performance of real-time voice and video. Analytics is an extension for Agora’s Voice Calling, Video Calling, Broadcast Streaming and Interactive Live Streaming that helps to locate quality issues, find root causes, and fix issues to improve the end user experience. \n\n\n\n", + "background_color": "white", + "font_size": "14", + "text_align": "left", + "vertical_align": "top", + "show_tick": false, + "tick_pos": "50%", + "tick_edge": "left", + "has_padding": true + }, + "layout": { + "x": 3, + "y": 0, + "width": 4, + "height": 2 + } + }, + { + "id": 2353035361405512, + "definition": { + "type": "note", + "content": "This dashboard monitors ongoing usage, quality, and performance for Agora RTC and Agora Chat, allowing you to see whether your service require attention.\n\nFor more details, please visit [Agora Datadog Integration](https://docs.agora.io/en/agora-analytics/analyze/video-voice-sdk/datadog-integration) and [Agora Chat](https://docs.agora.io/en/agora-analytics/analyze/chat-sdk/data-insights). ", + "background_color": "white", + "font_size": "14", + "text_align": "left", + "vertical_align": "top", + "show_tick": false, + "tick_pos": "50%", + "tick_edge": "left", + "has_padding": true + }, + "layout": { + "x": 7, + "y": 0, + "width": 5, + "height": 2 + } + } + ] }, - "display_type": "line" - } - ] - }, - "layout": { "x": 4, "y": 0, "width": 3, "height": 2 } - }, - { - "id": 6094328616410448, - "definition": { - "title": "Online Channel Count", - "title_size": "16", - "title_align": "left", - "show_legend": true, - "legend_layout": "auto", - "legend_columns": ["avg", "min", "max", "value", "sum"], - "type": "timeseries", - "requests": [ - { - "formulas": [{ "formula": "query1" }], - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.online_channel{*} by {product_type}" - } - ], - "response_format": "timeseries", - "style": { - "palette": "dog_classic", - "line_type": "solid", - "line_width": "normal" + "layout": { + "x": 0, + "y": 0, + "width": 12, + "height": 3 + } + }, + { + "id": 1006390466547454, + "definition": { + "title": "RTC", + "background_color": "vivid_green", + "show_title": true, + "type": "group", + "layout_type": "ordered", + "widgets": [ + { + "id": 4552268843133742, + "definition": { + "title": "Online User Count", + "title_size": "16", + "title_align": "left", + "type": "query_value", + "requests": [ + { + "response_format": "scalar", + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.online_user{*}", + "aggregator": "last" + } + ], + "conditional_formats": [ + { + "comparator": ">=", + "palette": "white_on_green", + "value": 10000 + }, + { + "comparator": "<", + "palette": "white_on_red", + "value": 10000 + } + ], + "formulas": [ + { + "formula": "query1" + } + ] + } + ], + "autoscale": true, + "precision": 2, + "timeseries_background": { + "type": "area" + } + }, + "layout": { + "x": 0, + "y": 0, + "width": 2, + "height": 2 + } + }, + { + "id": 2729842319365608, + "definition": { + "title": "Online Channel Count", + "title_size": "16", + "title_align": "left", + "type": "query_value", + "requests": [ + { + "response_format": "scalar", + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.online_channel{*}", + "aggregator": "last" + } + ], + "conditional_formats": [ + { + "comparator": ">=", + "palette": "white_on_green", + "value": 1500 + }, + { + "comparator": "<", + "palette": "white_on_red", + "value": 1500 + } + ], + "formulas": [ + { + "formula": "query1" + } + ] + } + ], + "autoscale": true, + "precision": 2, + "timeseries_background": { + "type": "area" + } + }, + "layout": { + "x": 2, + "y": 0, + "width": 2, + "height": 2 + } + }, + { + "id": 1300084570186116, + "definition": { + "title": "Online User Count", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.online_user{*} by {product_type}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 4, + "y": 0, + "width": 3, + "height": 2 + } + }, + { + "id": 6094328616410448, + "definition": { + "title": "Online Channel Count", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.online_channel{*} by {product_type}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 7, + "y": 0, + "width": 3, + "height": 2 + } + }, + { + "id": 2261693519168000, + "definition": { + "title": "Audio Freeze Rate", + "title_size": "16", + "title_align": "left", + "type": "query_value", + "requests": [ + { + "response_format": "scalar", + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.audio_freeze_rate{*}", + "aggregator": "last" + } + ], + "conditional_formats": [ + { + "comparator": "<=", + "palette": "white_on_green", + "value": 3 + }, + { + "comparator": ">", + "palette": "white_on_red", + "value": 3 + } + ], + "formulas": [ + { + "formula": "query1 * 100" + } + ] + } + ], + "autoscale": true, + "custom_unit": "%", + "precision": 2, + "timeseries_background": { + "type": "area" + } + }, + "layout": { + "x": 0, + "y": 2, + "width": 2, + "height": 2 + } + }, + { + "id": 4926581209337736, + "definition": { + "title": "Video Freeze Rate", + "title_size": "16", + "title_align": "left", + "type": "query_value", + "requests": [ + { + "response_format": "scalar", + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.video_freeze_rate{*}", + "aggregator": "last" + } + ], + "conditional_formats": [ + { + "comparator": "<=", + "palette": "white_on_green", + "value": 5 + }, + { + "comparator": ">", + "palette": "white_on_red", + "value": 5 + } + ], + "formulas": [ + { + "formula": "query1 * 100" + } + ] + } + ], + "autoscale": true, + "custom_unit": "%", + "precision": 2, + "timeseries_background": { + "type": "area" + } + }, + "layout": { + "x": 2, + "y": 2, + "width": 2, + "height": 2 + } + }, + { + "id": 6605137293154274, + "definition": { + "title": "Audio Freeze Rate", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.audio_freeze_rate{*} by {product_type}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 4, + "y": 2, + "width": 3, + "height": 2 + } + }, + { + "id": 43450529811804, + "definition": { + "title": "Video Freeze Rate", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.video_freeze_rate{*} by {product_type}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 7, + "y": 2, + "width": 3, + "height": 2 + } + }, + { + "id": 3318206441333366, + "definition": { + "title": "Join Success Rate In 5s", + "title_size": "16", + "title_align": "left", + "type": "query_value", + "requests": [ + { + "response_format": "scalar", + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.join_success_in_5s_rate{*}", + "aggregator": "last" + } + ], + "conditional_formats": [ + { + "comparator": ">=", + "palette": "white_on_green", + "value": 95 + }, + { + "comparator": "<", + "palette": "white_on_red", + "value": 95 + } + ], + "formulas": [ + { + "formula": "query1 * 100" + } + ] + } + ], + "autoscale": true, + "custom_unit": "%", + "precision": 2, + "timeseries_background": { + "yaxis": { + "include_zero": true + }, + "type": "area" + } + }, + "layout": { + "x": 0, + "y": 4, + "width": 2, + "height": 2 + } + }, + { + "id": 247709660961100, + "definition": { + "title": "Network Delay Rate", + "title_size": "16", + "title_align": "left", + "type": "query_value", + "requests": [ + { + "response_format": "scalar", + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.network_delay_rate{*}", + "aggregator": "last" + } + ], + "conditional_formats": [ + { + "comparator": "<=", + "palette": "white_on_green", + "value": 5 + }, + { + "comparator": ">", + "palette": "white_on_red", + "value": 5 + } + ], + "formulas": [ + { + "formula": "query1 * 100" + } + ] + } + ], + "autoscale": true, + "custom_unit": "%", + "precision": 2, + "timeseries_background": { + "type": "area" + } + }, + "layout": { + "x": 2, + "y": 4, + "width": 2, + "height": 2 + } + }, + { + "id": 2653352595362874, + "definition": { + "title": "Join Success Rate In 5s", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.join_success_in_5s_rate{*} by {product_type}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 4, + "y": 4, + "width": 3, + "height": 2 + } + }, + { + "id": 3936298129096284, + "definition": { + "title": "Network Delay Rate", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.rtc.app_id.network_delay_rate{*} by {product_type}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 7, + "y": 4, + "width": 3, + "height": 2 + } + } + ] }, - "display_type": "line" - } - ] - }, - "layout": { "x": 7, "y": 0, "width": 3, "height": 2 } - }, - { - "id": 2261693519168000, - "definition": { - "title": "Audio Freeze Rate", - "title_size": "16", - "title_align": "left", - "type": "query_value", - "requests": [ - { - "response_format": "scalar", - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.audio_freeze_rate{*}", - "aggregator": "last" - } - ], - "conditional_formats": [ - { "comparator": "<=", "palette": "white_on_green", "value": 3 }, - { "comparator": ">", "palette": "white_on_red", "value": 3 } - ], - "formulas": [{ "formula": "query1 * 100" }] - } - ], - "autoscale": true, - "custom_unit": "%", - "precision": 2, - "timeseries_background": { "type": "area" } - }, - "layout": { "x": 0, "y": 2, "width": 2, "height": 2 } - }, - { - "id": 4926581209337736, - "definition": { - "title": "Video Freeze Rate", - "title_size": "16", - "title_align": "left", - "time": {}, - "type": "query_value", - "requests": [ - { - "response_format": "scalar", - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.video_freeze_rate{*}", - "aggregator": "last" - } - ], - "conditional_formats": [ - { "comparator": "<=", "palette": "white_on_green", "value": 5 }, - { "comparator": ">", "palette": "white_on_red", "value": 5 } - ], - "formulas": [{ "formula": "query1 * 100" }] - } - ], - "autoscale": true, - "custom_unit": "%", - "precision": 2, - "timeseries_background": { "type": "area" } - }, - "layout": { "x": 2, "y": 2, "width": 2, "height": 2 } - }, - { - "id": 6605137293154274, - "definition": { - "title": "Audio Freeze Rate", - "title_size": "16", - "title_align": "left", - "show_legend": true, - "legend_layout": "auto", - "legend_columns": ["avg", "min", "max", "value", "sum"], - "type": "timeseries", - "requests": [ - { - "formulas": [{ "formula": "query1" }], - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.audio_freeze_rate{*} by {product_type}" - } - ], - "response_format": "timeseries", - "style": { - "palette": "dog_classic", - "line_type": "solid", - "line_width": "normal" + "layout": { + "x": 0, + "y": 3, + "width": 12, + "height": 7 + } + }, + { + "id": 7626381183369142, + "definition": { + "title": "CHAT", + "background_color": "blue", + "show_title": true, + "type": "group", + "layout_type": "ordered", + "widgets": [ + { + "id": 6488040002914870, + "definition": { + "title": " Total registered users", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.user.total{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "warm", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 0, + "width": 3, + "height": 2 + } + }, + { + "id": 7434830625229436, + "definition": { + "title": "Daily new users", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.user.dnu{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "warm", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 3, + "y": 0, + "width": 3, + "height": 2 + } + }, + { + "id": 3424173299276887, + "definition": { + "title": "Daily active users (DAU)", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.user.dau{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "warm", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 0, + "width": 3, + "height": 2 + } + }, + { + "id": 7627253634443609, + "definition": { + "title": "Monthly Max. DAU", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.user.maxdau{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "warm", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 9, + "y": 0, + "width": 3, + "height": 2 + } + }, + { + "id": 3962018198262566, + "definition": { + "title": "Total chat groups", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.group.total{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 2, + "width": 3, + "height": 2 + } + }, + { + "id": 4827929207840767, + "definition": { + "title": "Daily new groups", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.group.new{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 3, + "y": 2, + "width": 3, + "height": 2 + } + }, + { + "id": 6357102049070194, + "definition": { + "title": "Daily disbanded chat groups", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.group.disbanded{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 2, + "width": 3, + "height": 2 + } + }, + { + "id": 7666148346432892, + "definition": { + "title": "Daily active chat groups", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.group.active{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 9, + "y": 2, + "width": 3, + "height": 2 + } + }, + { + "id": 7213149121253642, + "definition": { + "title": "Total chat rooms", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.room.total{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "semantic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 4, + "width": 3, + "height": 2 + } + }, + { + "id": 2825392373031060, + "definition": { + "title": "Daily new chat rooms", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.room.new{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "semantic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 3, + "y": 4, + "width": 3, + "height": 2 + } + }, + { + "id": 7908830787787313, + "definition": { + "title": "Daily disbanded chat rooms", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.room.disbanded{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "semantic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 4, + "width": 3, + "height": 2 + } + }, + { + "id": 679521044881724, + "definition": { + "title": " Daily active chat rooms", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.room.active{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "semantic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 9, + "y": 4, + "width": 3, + "height": 2 + } + }, + { + "id": 8253037817072860, + "definition": { + "title": "Daily chat room PCU", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "name": "query1", + "data_source": "metrics", + "query": "avg:agora.chat.room.pcu{*} by {app_id}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "semantic", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 6, + "width": 3, + "height": 2 + } + } + ] }, - "display_type": "line" - } - ] - }, - "layout": { "x": 4, "y": 2, "width": 3, "height": 2 } - }, - { - "id": 43450529811804, - "definition": { - "title": "Video Freeze Rate", - "title_size": "16", - "title_align": "left", - "show_legend": true, - "legend_layout": "auto", - "legend_columns": ["avg", "min", "max", "value", "sum"], - "type": "timeseries", - "requests": [ - { - "formulas": [{ "formula": "query1" }], - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.video_freeze_rate{*} by {product_type}" - } - ], - "response_format": "timeseries", - "style": { - "palette": "dog_classic", - "line_type": "solid", - "line_width": "normal" - }, - "display_type": "line" - } - ] - }, - "layout": { "x": 7, "y": 2, "width": 3, "height": 2 } - }, - { - "id": 3318206441333366, - "definition": { - "title": "Join Success Rate In 5s", - "title_size": "16", - "title_align": "left", - "type": "query_value", - "requests": [ - { - "response_format": "scalar", - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.join_success_in_5s_rate{*}", - "aggregator": "last" - } - ], - "conditional_formats": [ - { "comparator": ">=", "palette": "white_on_green", "value": 95 }, - { "comparator": "<", "palette": "white_on_red", "value": 95 } - ], - "formulas": [{ "formula": "query1 * 100" }] - } - ], - "autoscale": true, - "custom_unit": "%", - "precision": 2, - "timeseries_background": { - "yaxis": { "include_zero": true }, - "type": "area" + "layout": { + "x": 0, + "y": 10, + "width": 12, + "height": 9, + "is_column_break": true + } } - }, - "layout": { "x": 0, "y": 4, "width": 2, "height": 2 } - }, - { - "id": 247709660961100, - "definition": { - "title": "Network Delay Rate", - "title_size": "16", - "title_align": "left", - "type": "query_value", - "requests": [ - { - "response_format": "scalar", - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.network_delay_rate{*}", - "aggregator": "last" - } - ], - "conditional_formats": [ - { "comparator": "<=", "palette": "white_on_green", "value": 5 }, - { "comparator": ">", "palette": "white_on_red", "value": 5 } - ], - "formulas": [{ "formula": "query1 * 100" }] - } - ], - "autoscale": true, - "custom_unit": "%", - "precision": 2, - "timeseries_background": { "type": "area" } - }, - "layout": { "x": 2, "y": 4, "width": 2, "height": 2 } - }, - { - "id": 2653352595362874, - "definition": { - "title": "Join Success Rate In 5s", - "title_size": "16", - "title_align": "left", - "show_legend": true, - "legend_layout": "auto", - "legend_columns": ["avg", "min", "max", "value", "sum"], - "type": "timeseries", - "requests": [ - { - "formulas": [{ "formula": "query1" }], - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.join_success_in_5s_rate{*} by {product_type}" - } - ], - "response_format": "timeseries", - "style": { - "palette": "dog_classic", - "line_type": "solid", - "line_width": "normal" - }, - "display_type": "line" - } - ] - }, - "layout": { "x": 4, "y": 4, "width": 3, "height": 2 } - }, - { - "id": 3936298129096284, - "definition": { - "title": "Network Delay Rate", - "title_size": "16", - "title_align": "left", - "show_legend": true, - "legend_layout": "auto", - "legend_columns": ["avg", "min", "max", "value", "sum"], - "type": "timeseries", - "requests": [ - { - "formulas": [{ "formula": "query1" }], - "queries": [ - { - "name": "query1", - "data_source": "metrics", - "query": "avg:agora.rtc.app_id.network_delay_rate{*} by {product_type}" - } - ], - "response_format": "timeseries", - "style": { - "palette": "dog_classic", - "line_type": "solid", - "line_width": "normal" - }, - "display_type": "line" - } - ] - }, - "layout": { "x": 7, "y": 4, "width": 3, "height": 2 } - } - ], - "template_variables": [], - "layout_type": "ordered", - "notify_list": [], - "reflow_type": "fixed" -} + ], + "template_variables": [], + "layout_type": "ordered", + "notify_list": [], + "reflow_type": "fixed" +} \ No newline at end of file diff --git a/agora_analytics/images/agora_analytics_dashboard.png b/agora_analytics/images/agora_analytics_dashboard.png index 0d6b3545a..05914a398 100644 Binary files a/agora_analytics/images/agora_analytics_dashboard.png and b/agora_analytics/images/agora_analytics_dashboard.png differ diff --git a/agora_analytics/metadata.csv b/agora_analytics/metadata.csv index 6868bf2be..13b285dd3 100644 --- a/agora_analytics/metadata.csv +++ b/agora_analytics/metadata.csv @@ -1,10 +1,23 @@ metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric -agora.rtc.app_id.online_user,count,60,,,,0,agora_analytics,online_user, -agora.rtc.app_id.online_channel,count,60,,,,0,agora_analytics,online_channel, -agora.rtc.app_id.audio_freeze_rate,rate,60,,,,-1,agora_analytics,audio_freeze_rate, -agora.rtc.app_id.video_freeze_rate,rate,60,,,,-1,agora_analytics,video_freeze_rate, -agora.rtc.app_id.network_delay_rate,rate,60,,,,-1,agora_analytics,network_delay_rate, -agora.rtc.app_id.join_attempt,count,60,,,,0,agora_analytics,join_attempt, -agora.rtc.app_id.join_success_count,count,60,,,,0,agora_analytics,join_success_count, -agora.rtc.app_id.join_success_rate,rate,60,,,,-1,agora_analytics,join_success_rate, -agora.rtc.app_id.join_success_in_5s_rate,rate,60,,,,-1,agora_analytics,join_success_in_5s_rate, \ No newline at end of file +agora.rtc.app_id.online_user,count,60,,,Number of online users.,0,agora_analytics,online_user, +agora.rtc.app_id.online_channel,count,60,,,Number of online channels.,0,agora_analytics,online_channel, +agora.rtc.app_id.audio_freeze_rate,rate,60,,,Audio freeze rate.,-1,agora_analytics,audio_freeze_rate, +agora.rtc.app_id.video_freeze_rate,rate,60,,,Video freeze rate.,-1,agora_analytics,video_freeze_rate, +agora.rtc.app_id.network_delay_rate,rate,60,,,Network delay rate.,-1,agora_analytics,network_delay_rate, +agora.rtc.app_id.join_attempt,count,60,,,Number of join attempts.,0,agora_analytics,join_attempt, +agora.rtc.app_id.join_success_count,count,60,,,Number of join successes.,0,agora_analytics,join_success_count, +agora.rtc.app_id.join_success_rate,rate,60,,,Join success rate.,-1,agora_analytics,join_success_rate, +agora.rtc.app_id.join_success_in_5s_rate,rate,60,,,Join success rate within 5 seconds.,-1,agora_analytics,join_success_in_5s_rate, +agora.chat.group.total,count,60,,,Total chat groups.,0,agora_analytics,total_group, +agora.chat.group.new,count,60,,,Daily new chat groups.,0,agora_analytics,new_group, +agora.chat.group.disbanded,count,60,,,Daily disbanded chat groups.,0,agora_analytics,disbanded_group, +agora.chat.group.active,count,60,,,Daily active chat groups.,0,agora_analytics,active_group, +agora.chat.room.total,count,60,,,Total chat rooms.,0,agora_analytics,total_group, +agora.chat.room.new,count,60,,,Daily new chat rooms.,0,agora_analytics,new_room, +agora.chat.room.disbanded,count,60,,,Daily disbanded chat rooms.,0,agora_analytics,disbanded_room, +agora.chat.room.active,count,60,,,Daily active chat rooms.,0,agora_analytics,active_room, +agora.chat.room.pcu,count,60,,,Daily chat room peak current users.,0,agora_analytics,room_pcu, +agora.chat.user.total,count,60,,,Total registered users.,0,agora_analytics,total_user, +agora.chat.user.dnu,count,60,,,Daily new users.,0,agora_analytics,dnu_user, +agora.chat.user.dau,count,60,,,Daily active users.,0,agora_analytics,dau_user, +agora.chat.user.maxdau,count,60,,,Monthly max daily active users.,0,agora_analytics,max_dau_user, \ No newline at end of file