Skip to content

Commit 2a1b547

Browse files
authored
Feature/data product metrics (#1016)
* added data product metrics docs * added link to application ids * applied suggestions * applied suggestions 2 * applied suggestion 3
1 parent f030343 commit 2a1b547

File tree

4 files changed

+34
-0
lines changed

4 files changed

+34
-0
lines changed

docs/understanding-tracking-design/defining-the-data-to-collect-with-data-poducts/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ With data products, you can:
1414
* More easily communicate what the data means and how to use it
1515
* Collaborate more effectively with the various teams involved in delivering value from your data
1616
* Drive a self-serve culture around data across your organization
17+
* See event volume metrics helping to monitor data collection over time.
1718

1819
## Elements of a Data Product
1920

Loading
Loading

docs/understanding-your-pipeline/data-products/index.md

+33
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,39 @@ Break down the barriers that exist between data producers and data consumers, by
7272

7373
![Key elements of a Data Product](images/key-elements-of-a-data-product.png)
7474

75+
**Volume metrics**; data products can detect events ingested in your pipeline that match the configured event specifications. This allows your team to monitor occurrence-related metrics for events being tracked with specific [event specification IDs](/docs/collecting-data/code-generation/commands/index.md#snowtype-patch).
76+
77+
**Benefits:**
78+
79+
You will be able to view several items in the UI that help detect anomalies or potential misconfigurations in trackers that are either not sending the expected events or are using incorrect [application IDs](/docs/understanding-tracking-design/organize-data-sources-with-source-applications/index.md#application-ids). This is particularly useful during the development phase when implementing tracking for a specific application using [Snowtype](/docs/collecting-data/code-generation). These elements include:
80+
81+
* A counter for each event specification, showing the total number of events detected from the tracked application IDs in the last 30 days.
82+
* A 'last seen' field for each event specification, indicating when the last event matching the event specification ID was detected.
83+
* A list of application IDs from which events are being tracked, displayed for each event specification. For each application ID, a status will be shown with different colors:
84+
* __Green__: Event specifications are being tracked and identified with the specific application ID inherited from the configured [source applications](/docs/understanding-tracking-design/organize-data-sources-with-source-applications/index.md).
85+
* __Gray__: No event specifications are being tracked for an application ID inherited from the configured source applications.
86+
* __Yellow__: Event specifications are being tracked for an application ID that has not been configured or inherited from the source applications.
87+
88+
:::note
89+
90+
Some data products, such as [__Base Web__](/docs/understanding-tracking-design/defining-the-data-to-collect-with-data-poducts/data-product-templates/index.md#base-web) and [__Base Mobile__](/docs/understanding-tracking-design/defining-the-data-to-collect-with-data-poducts/data-product-templates/index.md#base-mobile), contain standard events (e.g., _page pings_, _link clicks_, _screen view_, _application install_).
91+
92+
For these data products, the volume metrics will behave differently:
93+
94+
- If no standard events are being tracked with an application ID different from those inherited from the source applications set up in the data product, the behavior will be the same as for a normal data product.
95+
96+
- If standard events are being tracked with application IDs different from those inherited from the source applications set up in the data product, a toggle will appear above the event specification list.
97+
98+
This toggle will be disabled by default, so the metrics displayed will relate only to the application IDs inherited from the source applications set up in the data product.
99+
100+
![](images/data_product_metrics_default.png)
101+
102+
If the toggle is enabled, it will show the metrics for all the application IDs found for the standard events (not just the ones inherited from the data product).
103+
104+
![](images/data_product_metrics_toggled.png)
105+
106+
:::
107+
75108
## How data products help with governance, data quality and data discoverability
76109

77110
The **data structures** that you attach to your event specification describe the [structure of the data](/docs/understanding-your-pipeline/schemas/). They validate that the values of the properties contained within your events and entities are **valid** as they pass through your pipeline.

0 commit comments

Comments
 (0)