カテゴリ:

システム関数 (情報)

SYSTEM$REPORT_HEALTH_STATUS

コンシューマーアプリからプロバイダーアカウントへ アプリケーションの健全性情報 を送信します。

構文

SYSTEM$REPORT_HEALTH_STATUS( '<status>' )
Copy

引数

'status'

VARCHAR 型の文字列リテラルはアプリケーションの健全性ステータスを示します。次の値のいずれかを指定できます。

  • 'OK':コンシューマーインスタンスは正常です。

  • 'FAILED':コンシューマーインスタンスはエラー状態にあります。

  • 'PAUSED':コンシューマーは手動でアプリを一時停止しました。

使用上の注意

  • この関数は、コンシューマーアプリケーションにより呼び出されることを想定しています。アプリケーションは定期的にこの関数を呼び出し、プロバイダーアカウントに健全性ステータスを報告する必要があります。

  • アプリケーションロジックは、独自の監視とエラー処理に基づいて、どのような健全性ステータスを報告するかを決定します。

  • この関数によって報告される健全性ステータスは、 GET_HEALTH_STATUS 関数を介してプロバイダーアカウントに表示されます。コンシューマーインスタンスの健全性を監視するには、プロバイダーアカウントから GET_HEALTH_STATUS を定期的に呼び出す必要があります。タスクまたはモニタータスクを使用してこの関数を呼び出す場合は、アプリケーションにタスクを実行するための正しい権限があることを確認してください。コンシューマーインスタンスが FAILED ステータス、 PAUSED ステータスを報告したとき、またはステータスの報告を停止したときに通知するアラートを設定することを検討してください。

  • Snowflakeは、アプリケーションの各コンシューマーインスタンスによって報告された最新の健全性ステータスのみを保持します。

  • Snowflakeの過剰な負荷を避けるために、この関数はレート制限されています。同じコンシューマーインスタンスから55分以内に関数が再度呼び出されると、ステータスレポートが受け入れられなかったことを示す false を返します。

  • プロバイダー側からのアプリケーションの健全性監視の詳細については、 アプリのモニタリングを使用する をご参照ください。

戻り値

  • 健全性ステータスが正常に報告された場合、この関数は TRUE を返します。

  • レート制限によりステータスレポートが失敗した場合、この関数は FALSE を返します。