ヘルスチェック — Orbitvu Documentation

監視ツールから呼び出せるシークレット URL で、プラグインがプレゼンテーションを保存できること、およびジョブが停止したままになっていないことを確認できます。

Health Check URL は Stores → Configuration → Orbitvu Self Hosted V2 → Health Check にあります。View health status をクリックするとブラウザーで開きます。また、監視ツール（例：アップタイムモニターや Grafana）に追加することもできます。

Health Check の設定

この URL は JSON ドキュメントを返します。

{
  "status": "ok",
  "presentations_directory_writable": true,
  "auto_synch_locked": false,
  "auto_link_locked": false,
  "presentations_count": 42,
  "plugin_version": "2.0.0",
  "timestamp": "2026-05-20T10:30:00+00:00"
}

フィールド	意味
`status`	`ok`、またはプレゼンテーションのディレクトリに書き込めない場合やデータベースを読み取れない場合は `degraded`。
`presentations_directory_writable`	プラグインが `pub/media/orbitvu/presentations` に書き込めるかどうか。
`auto_synch_locked`, `auto_link_locked`	同期または自動リンクが現在実行中かどうか（ロックが長時間解除されない場合は、ジョブが停止したままになっています）。
`presentations_count`	ショップ内のプレゼンテーションの数。
`plugin_version`	インストールされているプラグインのバージョン。

HTTP ステータスコード：200 – ok、503 – degraded、401 – キーがない、またはキーが正しくない。

この URL にはシークレットキー（ov_auth）が含まれています。監視ツールは、代わりに X-Orbitvu-Key HTTP ヘッダーでキーを送信することもできます。この方法なら、キーがサーバーのアクセスログに残りません。Generate new url をクリックすると新しいキーが作成されます。