This documentation is for Dash Enterprise.
Dash Enterprise is the fastest way to write & deploy Dash apps and
Jupyter notebooks.
10% of the Fortune 500 uses Dash Enterprise to productionize AI and
data science apps. Find out if your company is using Dash Enterprise.
This guide serves as a reference for common operations related to monitoring Dash Enterprise and the user-created resources that are running on it.
Monitoring-related information is available in the Dash Enterprise App Manager as well as the Dash Enterprise CLI (as long as the system is healthy).
kubectl is only available to administrators with access to the cluster that Dash Enterprise is installed on.
Warning: Do not use
kubectlto edit or delete any objects in the cluster unless instructed by our customer success team.
The output of kubectl commands is a real-time view of the Kubernetes objects
in your cluster. You don’t need to be experienced with Kubernetes objects to follow the steps in this guide.
We use core system to refer to the Dash Enterprise components that exclude user-created resources like Dash apps.
We recommend checking the health of the core system after a new installation or upgrade.
To check the health of the core system with kubectl:
sh
kubectl get pods -n $NAMESPACE | grep -V 'Completed|Running'If the output is empty, that means all core components are running normally.
You can use memory usage data to help inform decisions around memory limits.
Memory usage information for services (managed Redis and Postgres databases) is only available via kubectl.
You must be the app owner or a co-owner, or have the admin role, to view app memory usage information in the App Info.
From the App Info (https://<your-dash-enterprise-server>/apps/<app-name>), go to the Scale tab. The Memory Usage information displays the current memory usage for the app’s combined processes and workspace (memory usage for services is not shown).
<img>
Most logs can be viewed using multiple methods, and outputs may vary based on the method that you choose.
The App Manager contains logs for an app’s latest build as well as older builds, whereas the CLI outputs logs for the latest build only.
App build logs viewed using the App Manager and Dash Enterprise CLI have a maximum of 5000 lines (this limit is shared with the app’s other logs), and any logs older than 7 days are cleared.
You must be the app owner or a co-owner, or have the admin role, to view app build logs in the App Manager.
Build logs are available in the App Info (https://<your-dash-enterprise-server>/apps/<app-name>).
In the Overview tab, select Show Build Logs to view the build logs for your app’s latest build. Alternatively, go to the Builds tab to view historical build logs. Build logs are ordered from oldest to newest.
<img>
Known issue: We are aware of an issue where build logs in the App Manager are sometimes incomplete, slow, or out of order.
You must be the app owner or a co-owner, or have the admin role, to view app build logs using the Dash Enterprise CLI.
To view the build logs of an app’s most recent build:
de apps logs --name <app-name> --type build
where <app-name> is the name of the app whose build logs you want to view.
See Managing Apps with the Dash Enterprise CLI for help installing the CLI as well as more options for the de apps logs command.
App runtime logs viewed using the App Manager and Dash Enterprise CLI have a maximum of 5000 lines (this limit is shared with the app’s other logs), and any logs older than 7 days are cleared. They span multiple app deployments, not just the latest.
You must be the app owner or a co-owner, or have the admin role, to view app runtime logs in the App Manager.
Dash Enterprise has a full-featured interface for viewing app runtime logs, which includes the ability to download them and configure display settings. Select the app whose logs you want to view, and then go to Logs. Runtime logs are ordered from oldest to newest.
If you have defined processes other than web in your app’s Procfile, select which process you want to view logs for in the
Process list.
<img>
Change how the logs are displayed using the Logs Settings <img>.
Wrapping, line numbers, and dates are on by default. Select them to turn them off or on.
<img>
Download the logs by selecting Download Logs.
<img>
You must be the app owner or a co-owner, or have the admin role, to view app runtime logs using the Dash Enterprise CLI.
To view an app’s runtime logs:
de apps logs --name <app-name> --type runtime
where <app-name> is the name of the app whose runtime logs you want to view.
By default, logs for the web process are displayed. See Managing Apps with the Dash Enterprise CLI for help installing the CLI as well as more options for the de apps logs command.
Workspace build logs in the App Manager have a maximum of 5000 lines (this limit is shared with the app’s other logs), and any logs older than 7 days are cleared.
You must be the app owner or a co-owner, or have the admin role, to view workspace build logs in the App Manager.
Workspace build logs are available in the App Info (https://<your-dash-enterprise-server>/apps/<app-name>). Go to the Workspace tab and select Show Workspace Logs to view the workspace build logs. They are ordered from newest to oldest.
<img>