Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Note
This information applies to Databricks CLI versions 0.205 and above. The Databricks CLI is in Public Preview.
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
Use the following information to troubleshoot issues with the Databricks CLI.
Enable logging
If a command fails or does not produce the expected output, you can use logging to help identify what might have gone wrong. You can log messages that the Databricks CLI outputs about various command events, warnings, and errors. To log these messages, specify the following Databricks CLI command options:
| Flag | Description |
|---|---|
--log-file |
A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr. |
--log-format |
text to write output logs to text or json to write output logs to JSON. If this flag is not specified then output logs are written as text. |
--log-level |
A string representing the log format level. Valid log levels are error, warn, info, debug, trace, and disabled. The default level is disabled, which means nothing is logged. --debug is equivalent to --log-level debug. |
The following example command logs trace messages for the specified command to a file named databricks-cli.log in JSON format.
databricks clusters list --log-file databricks-cli.log --log-format json --log-level trace
Error downloading Terraform
An expired key in some versions of the Databricks CLI causes the following error when running databricks bundle deploy:
error downloading Terraform: unable to verify checksums signature: openpgp: key expired
To resolve this error, upgrade the Databricks CLI to a latest patched version, which updates the verification mechanism to work with a newer key. Upgrade to the patched version that corresponds to your current CLI minor version:
Binary install: Download the patched version from the Databricks CLI releases page on GitHub.
setup-cli (as an install script or GitHub Action): Update the version in your configuration to a patched version from the Databricks CLI releases page on GitHub.
For example, to use
0.296.1with the GitHub Action:- uses: databricks/setup-cli@main with: version: 0.296.1
Commands not finishing
If you run a command such as databricks cluster list and it appears to hang, update your version of the Databricks CLI to the most recent version. Earlier versions of the CLI would attempt to load complete lists even if the number of items in the list was large, and the command would appear to not finish.