Merge pull request #104 from embrace-io/sleira/EMBR-5719-data-destina…

…tions-documentation [EMBR-5719] Data destinations documentation
embrace-io · Dec 4, 2024 · 899a369 · 899a369
2 parents 20c0f2d + f2cd39a
commit 899a369
Show file tree

Hide file tree

Showing 11 changed files with 39 additions and 24 deletions.
diff --git a/docs/custom-metrics-api/custom-metrics-grafana.md b/docs/custom-metrics-api/custom-metrics-grafana.md
@@ -4,7 +4,7 @@ description: Access your Custom Metrics via your Grafana dashboards
 sidebar_position: 2
 ---
 
-# Embrace Custom Metrics 
+# Custom Metrics 
 
 Custom Metrics that you create in Embrace are available for use in Grafana.
 

diff --git a/docs/custom-metrics-api/getting-started.md b/docs/custom-metrics-api/getting-started.md
@@ -4,7 +4,7 @@ description: Create custom metrics in Embrace Dashboard
 sidebar_position: 4
 ---
 
-# Embrace Custom Metrics
+# Custom Metrics
 
 Embrace captures your mobile data, and aggregates it into time series data. This data is useful for monitoring the
 health

diff --git a/docs/custom-metrics-api/index.md b/docs/custom-metrics-api/index.md
@@ -4,7 +4,7 @@ description: Learn about the Embrace Custom Metrics API to manage custom metrics
 sidebar_position: 0
 ---
 
-# Embrace Custom Metrics API
+# Custom Metrics API
 
 The Embrace Custom Metrics API allows you to manage (create, get and delete) the custom metrics of your organization.
 

diff --git a/docs/custom-metrics-api/supported_metrics.md b/docs/custom-metrics-api/supported_metrics.md
@@ -4,7 +4,7 @@ description: Learn about the metrics supported by the Custom Metrics API
 sidebar_position: 1
 ---
 
-# Custom Metrics API Supported Metrics
+# Supported Metrics
 
 Global filters  and global group bys are available to use on all the metrics.
 

diff --git a/docs/data-destinations/chronosphere-setup.md b/docs/data-destinations/chronosphere-setup.md
@@ -1,10 +1,10 @@
 ---
 title: Chronosphere Integration
 description: Learn about the Embrace <> Chronosphere integration
-sidebar_position: 5
+sidebar_position: 1
 ---
 
-# Data Destinations Chronosphere Integration
+# Chronosphere Integration
 
 ## Prerequisites
 

diff --git a/docs/data-destinations/data-dog-setup.md b/docs/data-destinations/data-dog-setup.md
@@ -1,10 +1,10 @@
 ---
 title: Datadog Integration
 description: Learn about the Embrace <> Datadog integration
-sidebar_position: 1
+sidebar_position: 2
 ---
 
-# Data Destinations Datadog Integration
+# Datadog Integration
 
 ## Prerequisites
 

diff --git a/docs/data-destinations/grafana-cloud-setup.md b/docs/data-destinations/grafana-cloud-setup.md
@@ -4,7 +4,7 @@ description: Learn about the Embrace <> Grafana Cloud integration
 sidebar_position: 3
 ---
 
-# Data Destinations Grafana Cloud Integration
+# Grafana Cloud Integration
 
 ## Prerequisites
 

diff --git a/docs/data-destinations/honeycomb.md b/docs/data-destinations/honeycomb.md
@@ -4,7 +4,7 @@ description: Learn about the Embrace <> Honeycomb integration
 sidebar_position: 4
 ---
 
-# Data Destinations Honeycomb Integration
+# Honeycomb Integration
 
 ## Prerequisites
 

diff --git a/docs/data-destinations/index.md b/docs/data-destinations/index.md
@@ -4,23 +4,38 @@ description: Learn about the Embrace integrations for viewing your data
 sidebar_position: 0
 ---
 
-# Embrace Data Destinations
+# Data Destinations
 
-As part of our Metrics Forwarding package, Embrace offers a number of Data Destinations to deliver your metrics to your cross-platform observability tool of choice:
+As part of our Metrics Forwarding package, Embrace offers a number of Data Destinations to deliver your metrics to your
+cross-platform observability tool of choice:
 
-* [Grafana visualization suite integration guide](/embrace-api/grafana_integrations/)
+* [Chronosphere integration guide](/data-destinations/chronosphere-setup.md)
 * [Datadog integration guide](/data-destinations/data-dog-setup.md)
-* [New Relic integration guide](/data-destinations/new-relic-setup.md)
 * [Grafana Cloud integration guide](/data-destinations/grafana-cloud-setup.md)
+  * [Grafana visualization suite integration guide](/embrace-api/grafana_integrations/)
 * [Honeycomb integration guide](/data-destinations/honeycomb.md)
+* [New Relic integration guide](/data-destinations/new-relic-setup.md)
 * [Splunk integration guide](/data-destinations/splunk.md)
-* [Chronosphere integration guide](/data-destinations/chronosphere-setup.md)
 
-All destinations receive a set of Standard metrics in daily, hourly, and five-minutely granularities:
-* crash total
-* sessions total
+## Metrics
+
+Metric name follows the format `embrace.<metric_name>.<granularity>`.
+
+All data destinations receive the following Standard metrics: 
+
+| Data Destinations                                      | Metric Names                                                                                                           |                                                                                                                        
+|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
+| Chronosphere, Datadog, Honeycomb, New Relic and Splunk | embrace.crash_total.five_minute, embrace.session_total.five_minute, embrace.crash_free_user_total.five_minute          |
+| Chronosphere, Datadog, Honeycomb, New Relic and Splunk | embrace.crash_total.hourly, embrace.session_total.hourly, embrace.crash_free_user_total.hourly                         |
+| Chronosphere, Datadog, Honeycomb, New Relic and Splunk | embrace.crash_total.daily, embrace.session_total.daily, embrace.crash_free_user_total.daily, embrace.users_total.daily |
+| Grafana Cloud                                          | embrace_crash_total_five_minute, embrace_session_total_five_minute, embrace_crash_free_user_total_five_minute          |
+| Grafana Cloud                                          | embrace_crash_total_hourly, embrace_session_total_hourly, embrace_crash_free_user_total_hourly                         |
+| Grafana Cloud                                          | embrace_crash_total_daily, embrace_session_total_daily, embrace_crash_free_user_total_daily, embrace_users_total_daily |
+
+## Get Started 
 
-To get started head to Settings -> Integrations in the dashboard and setup your first destination:
+Head to [Settings -> Integrations -> Data Destinations](https://dash.embrace.io/settings/organization/integrations/data_destinations) in the dashboard and setup your first data destination:
 
-<img src={require('@site/static/images/data-destinations/settings_page_example.png').default} alt="Image showing the settings page for data destinations" />
+<img src={require('@site/static/images/data-destinations/settings_page_example.png').default} alt="Image showing the
+settings page for data destinations" />
 
diff --git a/docs/data-destinations/new-relic-setup.md b/docs/data-destinations/new-relic-setup.md
@@ -1,10 +1,10 @@
 ---
 title: New Relic Integration
 description: Learn about the Embrace <> New Relic integration
-sidebar_position: 2
+sidebar_position: 5
 ---
 
-# Data Destinations New Relic Integration
+# New Relic Integration
 
 ## Prerequisites
 

diff --git a/docs/data-destinations/splunk.md b/docs/data-destinations/splunk.md
@@ -1,10 +1,10 @@
 ---
 title: Splunk Integration
 description: Learn about the Embrace <> Splunk integration
-sidebar_position: 4
+sidebar_position: 6
 ---
 
-# Data Destinations Splunk Integration
+# Splunk Integration
 
 ## Prerequisites