Databricks CLI のトラブルシューティング

注記

Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。

Databricks CLI に関する問題のトラブルシューティングを行うには、次の情報を使用します。

ログの有効化

コマンドが失敗する、または期待される出力が生成されない場合は、ログを使用すると、どこに問題があるかを特定するのに役立ちます。 Databricks CLI が出力するさまざまなコマンド イベント、警告、およびエラーに関するメッセージをログできます。 これらのメッセージをログするには、次の Databricks CLI コマンド オプションを指定します。

フラグ 説明
--log-file 出力ログの書き込み先を表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 出力ログをテキストに書き込む場合は text、出力ログを JSON に書き込む場合は json。 このフラグが指定されていない場合、出力ログはテキストとして書き込まれます。
--log-level ログ形式レベルを表す文字列。 有効なログ レベルは、 error、 warn、 info、 debug、 trace、および disabledです。 既定のレベルは disabledです。これは何もログに記録されていないことを意味します。 --debug は --log-level debug と等価です。

次のコマンド例では、指定したコマンドのトレース メッセージを json 形式で databricks-cli.log という名前のファイルに記録します。

databricks clusters list --log-file databricks-cli.log --log-format json --log-level trace

Terraform のダウンロード中にエラーが発生しました

一部のバージョンの Databricks CLI でキーの有効期限が切れていると、 databricks bundle deployの実行時に次のエラーが発生します。

error downloading Terraform: unable to verify checksums signature: openpgp: key expired

このエラーを解決するには、Databricks CLI を最新の 修正プログラムが適用されたバージョンにアップグレードします。これにより、新しいキーで動作するように検証メカニズムが更新されます。 現在の CLI マイナー バージョンに対応する修正プログラムが適用されたバージョンにアップグレードします。

  • Binary install: GitHubの Databricks CLI リリース ページから修正プログラムが適用されたバージョンをダウンロードします。

  • setup-cli (インストール スクリプトまたは GitHub アクションとして): 構成のバージョンを、GitHubの Databricks CLI リリース ページから修正プログラムが適用されたバージョンに更新します。

    たとえば、GitHub アクションで 0.296.1 を使用するには、次のようにします。

    - uses: databricks/setup-cli@main
  with:
    version: 0.296.1

保存された資格情報エラー

Databricks CLI バージョン 1.0.0 以降、Databricks CLI では、JSON ファイルではなく、OS ネイティブのセキュリティで保護されたストレージ (macOS のキーチェーン、Windowsの資格情報マネージャー、Linux 上の D-Bus シークレット サービス) に、ユーザーからマシンへの認証トークン (U2M) が格納されます。 トークン ストレージを参照してください。 ワークフローが JSON ファイルの上に構築されている場合、新しいストレージ メソッドに対して動作せず、次のシナリオで問題が発生する可能性があります。

  • GA にアップグレードされましたが、まだ再度ログインしていません。 Databricks CLI では、古いバージョンによって格納された資格情報が読み取られなくなり、エラーが返されます。

    Stored credentials from older CLI versions are no longer used.
Run "databricks auth login" to sign in again.

If secure storage is not available in this environment, set
DATABRICKS_AUTH_STORAGE=plaintext and re-run login.

    これを解決するには、 databricks auth login を実行します。

  • ログイン時にセキュリティで保護されたストレージチェックが失敗するdatabricks auth login中、Databricks CLI は、OAuth フローを開始する前にセキュリティで保護されたストレージをチェックします。 チェックが失敗した場合 (Linux コンテナー、SSH セッション、WSL1、および D-Bus が実行されていないヘッドレス サーバーで最も一般的)、動作は、セキュリティで保護されたストレージが明示的に構成されているかどうかによって異なります。

    • 既定のモード(明示的なストレージ設定なし):Databricks CLI は暗黙的にプレーンテキストにフォールバックし、auth_storage = plaintextの[__settings__] セクションに~/.databrickscfgを書き込みます。 後続のコマンドでは、再確認せずにプレーンテキストが使用されます。
    • 明示的なセキュア モード (構成プロファイルのDATABRICKS_AUTH_STORAGE=secure または auth_storage = secure ): Databricks CLI は、 DATABRICKS_AUTH_STORAGE=plaintext フォールバックを指すエラーを返します。

    チェックアウトが完全に失敗するのではなくタイムアウトした場合 (キーチェーンはロックされているが到達可能な場合など)、Databricks CLI はキーチェーン バックエンドを保持し、OS ロック解除プロンプトはブラウザーの OAuth フローと並行して実行されます。

    ログイン後に Databricks CLI が使用しているストレージ モードを確認するには、 databricks auth describe実行します。

  • 格納されているトークンを読み取るときに、キーチェーンに到達できません。 ログイン時とは異なり、Databricks CLI は、トークンの読み取り時にキーチェーンに到達できない場合、自動的にはフォールバックしません。 たとえば、デスクトップ コンピューターにログインし、ヘッドレス セッションで SSH 経由で接続した場合、保存されたトークンを必要とするコマンドはエラーで失敗します。 これを解決するには、プレーンテキスト フォールバックを使用します。 「 プレーンテキスト フォールバックを使用する」を参照してください。

コマンドが終了しない

databricks cluster listなどのコマンドを実行してハングしているように見える場合は、Databricks CLI のバージョンを最新バージョンに更新します。 以前のバージョンの CLI では、リスト内の項目の数が多く、コマンドが完了していないように見える場合でも、完全なリストの読み込みが試みられました。

  • Last updated on