> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/event-store.md).

# Event Store

自動保持、ストレージ制限、オプションのクラウドバックアップ付きで、エッジデバイスに推論イベントを保存します。

Event Store は、デバイス上の推論パイプラインが生成したイベントを記録するエッジコンテナサービスです。検査結果、品質チェック、安全アラート、その他の Workflow 出力をローカルに保存し、REST API 経由で提供するとともに、ディスク使用量を抑えるためのクリーンアップを実行します。保護対象データが原因でクリーンアップできない場合、空き容量が確保されるまでストアはデータリクエストをブロックします。

Event Store に書き込まれたイベントは、長期保存と分析のために Roboflow に [Vision Events](https://docs.roboflow.com/deployment/ja/to/vision-events.md) としてバックアップすることもできます。

{% hint style="info" %}
Event Store は Enterprise のお客様のみご利用いただけます。 [詳しくは Roboflow の営業チームまで](https://roboflow.com/sales) お問い合わせください。
{% endhint %}

## 接続情報

次の `<device-ip>` を、Deployment Manager のデバイスページに表示されている IP アドレスに置き換えてください。

<table data-search="false"><thead><tr><th>用途</th><th>アドレス</th></tr></thead><tbody><tr><td>REST API</td><td><code>http://&#x3C;device-ip>:8001</code></td></tr><tr><td>Swagger 対話型ドキュメント</td><td><code>http://&#x3C;device-ip>:8001/docs</code></td></tr></tbody></table>

ポート 8001 では、どちらも HTTP 経由で提供されます。エンドポイントのリファレンスについては、 [Event Store REST API](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/event-store/rest-api.md) を参照してください。

API を呼び出さずにデバイスのリアルタイムの容量と使用履歴を確認するには、 [Event Store のステータスを表示](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/monitoring/view-event-store-status.md).

## ストレージ設定

デバイスの Configuration タブにある Event Store カードで「Configure」をクリックして開く「Configure Event Store」ウィンドウの「Storage Settings」で、これらの設定を行います。各設定はサービスの環境変数に対応しています。

カードは、報告された空きディスク容量とメモリ総量を使って上限を確認し、ストレージ値を提案します。容量データを利用できない場合は、上限を確認できなかったことが表示されます。警告は、ストレージの逼迫、アップロードの滞留、またはメモリ不足を示します。

<table data-search="false"><thead><tr><th>設定</th><th>変数</th><th>デフォルト</th><th>説明</th></tr></thead><tbody><tr><td>「保持日数」</td><td><code>RETENTION_DAYS</code></td><td><code>1</code></td><td>この日数より古い削除対象イベントは削除されます。アップロード待ちのデータや下書きは、これより長く残ることがあります。</td></tr><tr><td>「最大レコード数」</td><td><code>MAX_RECORDS</code></td><td><code>1000000</code></td><td>クリーンアップ時のレコード数の目標値です。保護対象のレコードがあると、この値まで削除できない場合があります。</td></tr><tr><td>「最大レコードサイズ（KiB）」</td><td><code>MAX_RECORD_SIZE_BYTES</code></td><td><code>524288</code> （512 KiB）</td><td>保存するイベントメタデータの最大サイズです。画像と動画のデータ量は含みません。アプリの入力欄の単位は KiB です。別途、リクエスト上限も適用されます。</td></tr><tr><td>「最大ストレージ（GiB）」</td><td><code>MAX_STORAGE_BYTES</code></td><td><code>5368709120</code> （5 GiB）</td><td>追跡対象ファイルのクリーンアップ上限であり、ファイルシステム全体の使用量ではありません。アプリの入力欄の単位は GiB です。</td></tr><tr><td>「クリーンアップ間隔（秒）」</td><td><code>CLEANUP_INTERVAL_SECONDS</code></td><td><code>300</code></td><td>自動クリーンアップの実行間隔です。</td></tr><tr><td>「メモリ予算（MiB）」</td><td><code>EVENT_STORE_MEMORY_BUDGET_BYTES</code></td><td>デバイスメモリの 1/8</td><td>サービスのメモリ上限です。この上限を超える書き込みは拒否されます。既定値を使用するには、アプリで空欄にしてください。</td></tr><tr><td>「最小空きディスク容量（MiB）」</td><td><code>MIN_FREE_DISK_BYTES</code></td><td>1 GiB とディスク容量の 5% のうち、小さい方</td><td>データディスクに確保する空き容量です。空き容量がこの値を下回ると、書き込みは停止します。既定値を使用するには、アプリで空欄にしてください。</td></tr></tbody></table>

{% hint style="info" %}
「Memory Budget (MiB)」、「Min Free Disk (MiB)」、リクエストサイズの上限、および HTTP 507 レスポンスには、Event Store 1.1.2 以降が必要です。それ以前のバージョンでは、これら2つの設定は無視され、ストアが満杯になると HTTP 507 ではなく HTTP 529 が返されます。
{% endhint %}

追加の変数：

<table data-search="false"><thead><tr><th>変数</th><th>デフォルト</th><th>説明</th></tr></thead><tbody><tr><td><code>PORT</code></td><td><code>8001</code></td><td>API の HTTP ポート。</td></tr><tr><td><code>DATA_DIR</code></td><td><code>/data</code></td><td>デバイス上のデータ保存ディレクトリ。</td></tr><tr><td><code>CONSISTENCY_CHECK_INTERVAL</code></td><td><code>12</code></td><td>N 回のクリーンアップごとに整合性チェックを実行します（デフォルトのクリーンアップ間隔では、およそ1時間ごと）。</td></tr><tr><td><code>API_KEY</code></td><td>なし</td><td>任意の API キーです。詳しくは、 <a href="#authentication">認証</a>.</td></tr></tbody></table>

## 自動クリーンアップ

クリーンアップはバックグラウンドスレッドで実行され、バッチ単位でコミットされますが、データベースへのアクセスをリクエストと取り合うことがあります。スケジュールされた各処理では、まず古いドラフトを自動確定し（ [ドラフトイベントと動画](#draft-events-and-video)を参照）、その後、次の3つのステップを順番に実行します。

1. 保持期間。 `RETENTION_DAYS`より古い削除対象レコードを、このストアでの作成日時を基準に削除します。
2. レコード数の上限。レコード数が `MAX_RECORDS`を超えた場合、削除対象レコードを削除します。まずアップロード済みのレコードを削除し、次に各グループ内で古いものから削除します。
3. ストレージ上限。対象ファイルを削除し、使用量を `CLEANUP_PRUNE_THRESHOLD` パーセントの `MAX_STORAGE_BYTES` （デフォルト `95`）まで減らします。まずアップロード済みのファイルを削除し、次に古いものから削除します。親レコードは保持され、その `current_file_count` は減算されます。

クラウドバックアップが有効な場合、ドラフトとアップロード待ちのデータは保護されます。容量が逼迫した場合、確定済みの放置レコードは削除されることがあります。「Records and Files」モードでは、バックアップ待ちのファイルも保護されます。「Records Only」では、確定済みイベントのファイルをバックアップなしで削除できます。バックアップが無効な場合、クリーンアップによって未アップロードのイベントや未完了のドラフトが削除されることがあります。

クリーンアップを `CONSISTENCY_CHECK_INTERVAL` 回実行するごとに、また各 `POST /admin/cleanup`の実行時に、サービスはデータベースとファイルシステムの照合も行います。データベースに対応するレコードがないディスク上の孤立ファイルを、書き込み中のファイルに触れないよう10分間の猶予期間を設けて削除し、すでに存在しないファイルの追跡行も削除します。

次のコマンドで、クリーンアップをすぐに実行することもできます。 `POST /admin/cleanup`。詳しくは、 [管理](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/event-store/rest-api.md#administration).

### 画像の有効期間

API が返す画像 ID は、本質的に有効期間が短いものです。1分前には解決できた ID が、クリーンアップの実行後に 404 になることがあります。ストレージ容量に制約のあるエッジハードウェアでは、これは意図された動作です。

* 画像の取得時には `404` レスポンスを処理してください。
* 画像 ID を1つのセッションを超えてキャッシュしないでください。
* イベントの `current_file_count` と `original_file_count` を比較すると、そのファイルがクリーンアップされたかどうかを確認できます。

## 下書きイベントと動画

パイプラインでは、イベントをすぐに保存し、エンコードが完了した数秒後に動画を添付できます。イベントを作成するには、 `draft: true`を指定し、動画の準備ができたらアップロードしてから、イベントを確定します。 `draft` を指定せずに作成されたイベントは、作成時に確定されるため、既存のパイプラインに影響はありません。

イベントが確定されるまでは、クラウドへのアップロードがスキップされます。また、クリーンアップからも保護されますが、これはサービスでクラウドアップロードが有効な場合に限られます。クラウドアップロードが無効の場合、下書きも他のレコードと同様に削除できます。

<table data-search="false"><thead><tr><th>設定</th><th>変数</th><th>デフォルト</th><th>説明</th></tr></thead><tbody><tr><td>「下書きの自動確定までの時間（秒）」</td><td><code>DRAFT_AUTO_FINALIZE_SECONDS</code></td><td><code>3600</code></td><td>動画が届かない下書きは、指定した秒数が経過すると強制的に確定され、バックアップとクリーンアップの対象になります。</td></tr><tr><td>「動画の最大アップロードサイズ（MB）」</td><td><code>MAX_VIDEO_UPLOAD_BYTES</code></td><td><code>1073741824</code> （1 GiB。アプリでは <code>1024</code> として入力）</td><td>デバイス上でイベントに添付できる動画1本あたりの最大サイズです。この変数の単位はバイト、アプリの入力欄の単位はMBです。</td></tr></tbody></table>

{% hint style="warning" %}
設定 `DRAFT_AUTO_FINALIZE_SECONDS` を `0` にすると、定期的な処理が無効になります。確定処理を一度も呼び出さないプロデューサーが作成した下書きは蓄積し、クラウドバックアップが有効な場合、ストアがいっぱいになってHTTP 507でデータリクエストがブロックされる可能性があります。滞留している下書きを確定して、バックアップとクリーンアップが進むようにしてください。
{% endhint %}

## 画像ごとのメタデータとローカル専用ファイル

パイプラインでは、画像や予測に加えて、イベントに追加データを添付できます。

画像ごとのメタデータは、個々の画像に添付する、小規模な1階層のキーと値のオブジェクトです。判定結果、シリアル番号、角度ラベルなどを記録できます。レコードとともに保存され、APIから返されますが、クエリの対象にはなりません。「レコードとファイル」バックアップでは、各画像とともにアップロードされます。 `METADATA_MAX_VALUE_LENGTH` （デフォルト値： `1000`）は、文字列値の長さを制限します。

ローカル専用ファイルは、検査データ、サムネイル、JSONなど、イベントに添付する任意のファイルです。デバイス上にのみ保存され、アップロードされることはありません。コンテンツタイプに制限はありません。また、 `MAX_LOCAL_ONLY_FILE_UPLOAD_BYTES` （デフォルト値： `104857600`、100 MiB）は、アップロードごとの上限を設定します。ファイルを添付できるのはイベントがまだ下書きの間だけです。そのため、パイプラインではイベントを `draft: true`を指定して作成し、ファイルを添付してから確定する必要があります。

詳しくは、 [REST APIリファレンス](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/event-store/rest-api.md).

## クラウドバックアップ

「Vision Eventsのバックアップを有効にする」がオンの場合、確定済みのイベントはRoboflowにアップロードされます。ユースケースが指定されていないイベントには、選択した「デフォルトのユースケース」が適用されます。「バックアップモード」には次の2つの選択肢があります。

* 「レコードとファイル」では、イベントのメタデータに加えて、関連する画像ファイル、画像ごとのメタデータ、動画クリップがアップロードされます。
* 「レコードのみ」では、イベントのメタデータがアップロードされ、画像と動画はデバイス上に残ります。そのため、使用する帯域幅が少なくなります。

どちらのモードでも、ローカル専用ファイルはアップロードされません。

「レコードとファイル」モードでは、MP4およびMOV形式のクリップがイベントあたり最大4本までアップロードされ、Vision Eventsダッシュボードで再生できます。他の形式（例：MKV、AVI）のクリップ、5本目以降のクリップ、および3 GiBを超えるクリップ（クラウドの上限）は、デバイス上に残ります。デバイス側の上限（「動画の最大アップロードサイズ（MB）」）はこれとは別で、デフォルトは1 GiBです。3 GiBを超える値に設定するのは、デバイス上に保持するクリップの場合に限ってください。

再試行可能なクリップのアップロード失敗が発生すると、イベント全体が次の設定時間だけ保留されます： `UPLOAD_RETRY_DELAY_SECONDS` （デフォルト値： `3600`、1時間）。次に、 `VIDEO_UPLOAD_MAX_ATTEMPTS` で指定した回数（デフォルト値： `3`）の試行後、イベントはクリップを待たずに処理されます。試行回数に含まれない失敗もあるため、これは配信期限を保証するものではありません。

バックアップの有効化とRoboflowでの結果のクエリについては、 [イベントの送信](https://docs.roboflow.com/deployment/ja/to/vision-events/send-events.md) を参照してください。

### アップロードの信頼性

失敗したアップロードは再試行されます。「アップロード放棄ポリシー」は、サーバーが拒否し続けるレコードの扱いを制御し、「最大アップロード試行回数」は `UPLOAD_MAX_ATTEMPTS`.

<table data-search="false"><thead><tr><th>ポリシー</th><th>変数の値</th><th>動作</th></tr></thead><tbody><tr><td>放棄しない</td><td><code>NEVER_ABANDON</code> （デフォルト）</td><td>レコードは成功するまで無期限に再試行されます。データ保護の面では最も安全ですが、滞留レコードでデバイスの容量がいっぱいになると、未アップロードのレコードを破棄する代わりに、HTTP 507でデータ要求をブロックし始めます。</td></tr><tr><td>最大試行回数に達したら放棄</td><td><code>ABANDON_AFTER_MAX_ATTEMPTS</code></td><td>レコードは、 <code>UPLOAD_MAX_ATTEMPTS</code> 回のコンテンツエラーによる試行後（デフォルトは <code>10</code>）、放棄済みとしてマークされ、ストレージのクリーンアップ対象として優先されます。継続的に失敗するレコードを失うほうが、データ要求をブロックするより望ましい場合に使用してください。</td></tr></tbody></table>

サーバーからのコンテンツ関連の4xxレスポンス（例：400、413、422）のみが試行回数に加算されます。5xxレスポンス、タイムアウト、ネットワークエラー、および401、403、404、408、429はすべて一時的なエラーとして扱われ、ポリシーにかかわらず再試行されます。

`MIN_UPLOAD_IMAGE_BYTES` （デフォルトは `1`）の場合、指定サイズより小さい画像はアップロード前にスキップされます。破損していても空ではない画像は、現在サーバーから5xxとして返されるため、どちらのポリシーでも無期限に再試行されます。一般的な破損サイズを上回る値に設定するのが回避策です。

## 認証

APIキー認証は任意で、デフォルトでは無効です。有効にするには、サービスで `API_KEY` を設定します。有効にすると、データおよび管理用のルートで `X-API-Key` ヘッダーが必要になります。 `/health`, `/docs`, `/redoc`および `/openapi.json` は、認証なしで引き続きアクセスできます。

```yaml
環境変数：
  - API_KEY=your-secret-api-key-here
```

```bash
curl -H "X-API-Key: your-secret-api-key-here" \
  http://<device-ip>:8001/v2/events/latest/query
```

`/health` は認証なしで引き続きアクセスできるため、監視システムやロードバランサーからポーリングできます。
