Skip to content

Commit 3ba68d6

Browse files
mesmith027treysp
andauthored
Observability: Model page (#3743)
Co-authored-by: Trey Spiller <1831878+treysp@users.noreply.github.com>
1 parent c30d097 commit 3ba68d6

3 files changed

Lines changed: 40 additions & 15 deletions

File tree

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,62 @@
11
# Models
22

3-
From the main environments list, you can access individual models to explore their comprehensive observability features and detailed summary information. This centralized view provides quick access to critical model metrics and performance data.
3+
The model overview page provides comprehensive observability features that let you explore detailed information about a model. This centralized view gives you quick access to critical metrics and performance data, providing a window into the model's health and status.
44

5-
Click the environment you want to explore from the environments list
5+
Model owners typically use this page to monitor and check their models. It provides essential information in an easy-to-scan format, eliminating the need to debug issues through the command line interface. From this page you can quickly diagnose:
66

7-
![Tobiko Cloud environment page](./model/tcloud_environments.png)
7+
1. Model anomalies
8+
1. Did the model suddenly take a really long time to run?
9+
2. Is the model repeatedly failing due to audits or schema evolution?
10+
2. Downstream impacts
11+
1. If the model fails to run, lineage lets you immediately see what other models are affected
12+
3. Which version introduced errors
13+
1. Use the model's version history to identify which changes caused a problem
814

9-
Navigate to the Models section and click "Explore" to view available models
1015

11-
![Tobiko Cloud environment page explore models link](./model/tcloud_environment_explore-models.png)
16+
## Navigate to a model
1217

13-
Browse through the model list and select your desired model to access its detailed information
18+
There are a number of ways you can navigate to a model's page. This method shows you how to find your model directly from the Environments page.
1419

15-
![Tobiko Cloud environment models list](./model/tcloud_model_list.png)
20+
1. Select "Environments" from the left hand menu
21+
2. Click the environment you want to explore from the list.
22+
![Tobiko Cloud environment page](./model/tcloud_environments.png)
23+
3. Navigate to the Models section and click "Explore" to view available models
24+
![Tobiko Cloud environment page explore models link](./model/tcloud_environment_explore-models.png)
25+
4. Browse through the model list and select a model to access its detailed information
26+
![Tobiko Cloud environment models list](./model/tcloud_model_list.png)
1627

17-
Each model presents a comprehensive summary overview that includes several key components and metrics for monitoring and analysis.
28+
## Model page information
29+
30+
Each model page presents a comprehensive summary that includes the key components and metrics used to monitor model behavior.
31+
32+
From here, you can identify anomalies in the model's run time based on historical run times and how they have been changing over time (or not!).
33+
34+
You can also check other critical information, like the model's source code, its lineage relative to other models, its contents in previous versions, and even an approximation of how much it costs (if you have [cost savings set up](../costs_savings.md)).
1835

1936
The following detailed information outlines the different sections:
2037

2138
![Tobiko Cloud model status and metadata](./model/tcloud_model_status-metadata.png)
2239

23-
- Current status: Provides visual representations of model health through freshness indicators and detailed daily execution graphs
24-
25-
- Model details: Features comprehensive tabs that display summary statistics, complete source code documentation, and interactive model lineage visualizations
40+
- Current status graphs: Provide visual representations of model health through freshness indicators and detailed daily execution graphs
41+
- Freshness indicator: Shows the current status of the model and the percentage of up-to-date models in production (as long as this is green, you have nothing to worry about in your production environment)
42+
- Historical Freshness graph: Gives an at-a-glance picture of the history of the model's freshness.
43+
- Green means it's up to date and has run smoothly for every interval
44+
- Orange means that one interval is pending and will be processed on the next run
45+
- Red means the model has more than one interval waiting to be processed because an interval was not processed during a previous run
46+
- Daily executions: tells you the length of time it took the model to run on each day. This is a great place to quickly identify anomalies in the model's run time (both running too long *or* too short).
47+
- Model details: Features tabs that display summary statistics, model source code, and interactive model lineage visualizations
2648

2749
![Tobiko Cloud model version history](./model/tcloud_model_2.png)
2850

2951
- Version history: Delivers a comprehensive chronological view of all model versions, with detailed information including:
3052
- Precise timestamp of version promotion
3153
- Clear indication of change impact (breaking or non-breaking modifications)
3254
- Direct access to the complete implementation plan code
33-
- Loaded intervals: these periods represent the time spans between consecutive cron job executions, from the start of one cron job to the end of the next cron job. These intervals are crucial for understanding the boundaries of data processing cycles
34-
- the table displays which specific model version was responsible for generating and processing data during each distinct cron interval, enabling precise tracking of version-specific outputs
35-
- helps track forward-only model changes by maintaining a clear chronological record of modifications, ensuring data consistency and preventing retroactive alterations
36-
- provides comprehensive visibility into completed data processing operations, allowing users to monitor progress and verify successful execution of scheduled tasks
55+
- Data Warehouse costs: estimates the cost of the model as set up by your team in [cost savings](../costs_savings.md)
56+
57+
![Tobiko Cloud model version history](./model/tcloud_model_3.png)
58+
59+
- Loaded intervals: these periods represent the time spans processed during each job execution, which generally consist of the time between one job and the next. These intervals are crucial for understanding the boundaries of data processing cycles, which may correspond to the start of anomalous model behavior.
60+
- The table displays the specific model version in effect during that job execution, enabling precise tracking of version-specific outputs
61+
- Helps track forward-only model changes by maintaining a clear chronological record of modifications, ensuring data consistency and preventing retroactive alterations
3762
- Recent activity: Maintains a detailed log of version executions and comprehensive version audits
91 KB
Loading
258 KB
Loading

0 commit comments

Comments
 (0)