Monitor the Status and Runtime of the Depot¶
The status indicates the Resource's lifecycle state, such as active, error, or deleted, and helps users quickly assess whether the Resource is available and functioning as expected. In contrast, the runtime reflects the Resource's execution state, such as running, failed, or pending, capturing what is actively happening behind the scenes, typically at the container or pod level. Together, these signals help users to detect configuration issues, operational failures, and disruptions that could impact downstream workflows.
DataOS CLI¶
Users can check whether a Depot is active or deleted by running the command dataos-ctl resource get -t depot -n ${{depotname}} in the DataOS CLI. The output will appear as follows:
dataos-ctl get -t depot -n systemstreams
INFO[0000] 🔍 get...
INFO[0000] 🔍 get...complete
NAME | VERSION | TYPE | WORKSPACE | STATUS | RUNTIME | OWNER
----------------|---------|-------|-----------|--------|---------|-----------------
systemstreams | v1 | depot | | active | | dataos-manager
Metis UI¶
Users can track the status of a Depot, whether active or deleted, along with the total count of active and deleted Depots through the Metis UI.
-
Simply navigate to
Resources → Depotsto check the status of any Depot within the environment. Additionally, users can quickly find a specific Depot by searching for its name in the Metis UI search bar.
Open the Metis Catalog -
When a user clicks on a specific Depot, they can also track the aggregated status along with the runtime, which applies only to the object storage Depots.
Depot details in Metis -
To check the runtime of a Depot (If applicable), simply navigate to the ‘Runtime’ tab as shown below.
Depot runtime in Metis The Runtime section shows the live execution environment of a Resource, in this case, a Depot. It reflects details like when the runtime was created, which workspace and data plane it’s using, its current status (e.g.,
Running), and how long it has been active. This helps users verify whether the Resource is functioning as expected in real time.
Operations App¶
Using the Operations App, users can monitor the operational logs of a Depot. In addition to tracking its status, they can also view details such as the builder stage, Cloud Kernel Resource Count, WebService Resource Count, and, if applicable, the Operator Runtime Resource Count.
Follow the steps below to monitor a Depot on the Operations app:
-
Open the Operations app.
Open the Operations app -
Navigate to the User Space tab and go to the Resources section.
-
Select Depot as the Resource type to filter all Depots in the environment.
Operations > User Space > Depot -
Search for or select the target Depot.
-
Monitor its status, including Cloud Kernel Resource Count, WebService Resource Count, Operator Runtime Resource Count, Builder Stage, and Runtime Status.
Depot status and runtime in Operations Monitoring the Builder Stage is recommended when the Resource status shows an
error.- If the status is
errorand the Builder Stage is stillbuilding, it indicates that the issue occurred after the building stage. - If the status is
errorand the Builder Stage also showserror, it means the issue happened during the building stage itself.
This helps in identifying whether the problem lies within the building phase or after the Resource was built.
- If the status is
Status alerts¶
To proactively track critical state transitions, users can configure a Monitor and Pager to send alerts when the status of a Depot changes to values like error or deleted. This enables teams to respond immediately to resource failures, misconfigurations, or unexpected deletions that may impact dependent components. Click here to view the steps to set up alerts for status changes.
Runtime alerts¶
To proactively detect execution issues, users can configure a Monitor and Pager to send alerts when the runtime of a Resource enters a failure state, such as failed or remains stuck in pending. This ensures timely awareness of broken or stalled executions that may affect downstream processes. Click here to view the steps to set up alerts for runtime failures..