Repository navigation
[DPS-XXXX] Event spec validation metrics #1947
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Gleb Lobov (gleb-lobov)
merged 4 commits into
main
from
feature/event-spec-validation-console-docs
Sep 22, 2026
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file modified
BIN
+125 KB
(140%)
docs/event-studio/event-catalog/images/event-catalog-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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
Binary file modified
BIN
-66.5 KB
(84%)
...vent-studio/tracking-plans/create-and-manage/images/create-tracking-plan-v2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-25.4 KB
(95%)
...event-studio/tracking-plans/create-and-manage/images/tracking-plan-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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
Binary file added
BIN
+449 KB
docs/event-studio/tracking-plans/data-quality/images/event-catalog-volume.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+142 KB
...dio/tracking-plans/data-quality/images/event-specification-tracking-summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+442 KB
.../event-studio/tracking-plans/data-quality/images/tracking-plan-data-quality.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+241 KB
docs/event-studio/tracking-plans/data-quality/images/tracking-plans-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: "Monitor tracking plan data quality in Console" | ||
| sidebar_label: "Data quality" | ||
| sidebar_position: 4 | ||
| description: "See how many events matched each tracking plan and event specification over the last 30 days, and how many of them were valid or inferred, had violations, or failed." | ||
| keywords: ["tracking plan data quality", "event specification validation", "event volume", "events with violations", "failed events", "tracking summary", "Console"] | ||
| date: "2026-09-17" | ||
| --- | ||
|
|
||
| Console shows the results of [event specification inference](/docs/event-studio/tracking-plans/event-specification-inference/index.md) and [event specification validation](/docs/event-studio/tracking-plans/event-specification-validation/index.md) next to your tracking plans and event specifications. Every event volume figure is split into valid events, inferred events, events with violations, and failed events. You can see how well an implementation matches its specification without querying your warehouse. | ||
|
|
||
| Metrics cover the last 30 days for one pipeline at a time. Every view that shows them has a pipeline selector, which defaults to your production pipeline. | ||
|
|
||
| ## Understand the event categories | ||
|
|
||
| Console sorts every event that the pipeline matches to a published event specification into one of four categories: | ||
|
|
||
| | Category | Meaning | | ||
| | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Valid events | Events that arrived with an `event_specification` entity and passed validation | | ||
| | Inferred events | Events that the pipeline matched to the specification by inference. Inferred events are valid events too, but the pipeline doesn't validate them | | ||
| | Events with violations | Events that arrived with an `event_specification` entity, failed validation, and were loaded to your warehouse with an `event_specification_validation` entity attached | | ||
| | Failed events | Events attributed to the specification that ended up in [failed events](/docs/fundamentals/failed-events/index.md). This includes events with schema violations, and events that failed validation in a tracking plan that [sends them to failed events](/docs/event-studio/tracking-plans/event-specification-validation/index.md#send-invalid-events-to-failed-events) | | ||
|
|
||
| Only events that arrive with an `event_specification` entity go through validation, so only they can end up as valid events or events with violations. Tracking code generated with [Snowtype](/docs/event-studio/implement-tracking/index.md) attaches this entity for you. Events without it can only be matched by inference. | ||
|
|
||
| The total volume is the sum of the four categories. Where Console shows a bar next to a volume, each segment is one category. Hover over the bar to see the count for each category. | ||
|
|
||
| Failed event counts come from your [data quality dashboard](/docs/monitoring/index.md), not from the Console API. They are available when the selected pipeline loads failed events into your warehouse, the data quality dashboard is connected to that pipeline, and you have permission to view it. Otherwise the failed events category shows N/A, volumes exclude failed events, and a warning icon next to the volume explains why. | ||
|
|
||
| ## View data quality for a tracking plan | ||
|
|
||
| Open a tracking plan to see its **Data quality** panel. The chart shows the total number of events across all event specifications in the plan, split by category, with the share and count of each. Click **View details** to open the data quality dashboard for the selected pipeline, or the failed events page when the dashboard isn't connected. | ||
|
|
||
|  | ||
|
|
||
| The event specifications table shows the same breakdown per event specification in its **Volume** column. The **Last seen** column shows the most recent event for the specification, whether it was valid or failed. | ||
|
|
||
| The **Data quality rules** button in the page header controls whether events that fail validation count as events with violations or as failed events. See [Send invalid events to failed events](/docs/event-studio/tracking-plans/event-specification-validation/index.md#send-invalid-events-to-failed-events). | ||
|
|
||
| ## Compare tracking plans and event specifications | ||
|
|
||
| The **Tracking plans** list shows the volume breakdown for every tracking plan in its **Event volume** column. The [Event Catalog](/docs/event-studio/event-catalog/index.md) shows it for every event specification across all tracking plans in its **Volume** column. Both views have a pipeline selector next to the filters. | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## Track specification versions and application IDs | ||
|
|
||
| Each event specification has a **Tracking summary** tab that breaks the metrics down by specification version and application ID. Use it to check that a new version has reached all applications, or that an application still sends an old version. | ||
|
|
||
|  | ||
|
|
||
| Each row is one version of the specification that the pipeline saw events for in the last 30 days. The **App ID** column lists the application IDs that sent those events, with a status for each: | ||
|
|
||
| | Status | Meaning | | ||
| | -------------- | --------------------------------------------------------------------------------------------------------------- | | ||
| | Green check | The app ID belongs to a source application of this version and sent events | | ||
| | Yellow warning | The app ID sent events, but doesn't belong to any source application of this version | | ||
| | Gray minus | The app ID belongs to a source application of this version, but didn't send events in the last 30 days | | ||
|
|
||
| A yellow status usually means that an application tracks the event without being listed in the specification. Add its [source application](/docs/event-studio/source-applications/index.md) to the specification, or remove the tracking from that application. | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tracking plan => Tracking Plan
please double check in other parts too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually no, we call them lower case. I prefer the entities to be capitalized, but this is not what we are doing in general
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
look here please "What is a Tracking Plan"
https://docs.snowplow.io/docs/fundamentals/tracking-plans/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok I checked more probably the example I provided should be changed too to lower case... anyway, maybe claude can do it for us