履歴からストリームへの移行

Boxでは、admin_logsを使用してライブイベントを登録しているアプリケーションをadmin_logs_streamingに移行することをお勧めします。admin_logs_streamingを使用すると、レイテンシが低下し、一貫性が高まるだけでなく、遅れて届くイベントが見逃されなくなります。admin_logsとadmin_logs_streamingの間のイベントの重複は、イベントIDを使用して排除することが可能です。

Enterpriseのstream_typeの比較

admins_logs_streamingのメリット

• 遅れて届くイベントが、登録しているアプリケーションで見逃されなくなる
• レイテンシが80%低下する (通常の操作時)
• より一貫性のあるレイテンシが実現する (通常の操作時)
• 遅れたイベントの埋め戻しをサービスで管理する必要がなくなったため、障害からの復旧がよりスムーズになる

admin_logsとadmin_logs_streamingの相違点

• 2週間分のイベント履歴 (リテンション) が提供される
• created_afterおよびcreated_beforeフィルタパラメータがサポートされない
• 重複を含む可能性がある (「少なくとも1回」は保証されている)
• イベントが時系列で返されなくなる (イベントはほぼ処理された順で返される)

admin_logsとadmin_logs_streamingの類似点

• 同じGET /events APIエンドポイントを共有する
• 同じイベントペイロードを返す (イベントIDを使用して2つのストリームタイプでのイベントの重複排除が可能)
• event_typeによるフィルタが可能
• stream_positionを使用したイベントのページネーションが可能

admin_logsからadmin_logs_streamingへの移行方法

1. 既存のリクエストは以下のようになります

curl https://api.box.com/2.0/events?stream_type=admin_logs&stream_position=1632893855 \
    -H "authorization: Bearer <ACCESS_TOKEN>"

2. admin_logs_streamingを使用して重複する既存のリクエストを開始します

• 2週間前から開始し、埋め戻しする:

    curl https://api.box.com/2.0/events?stream_type=admin_logs_streaming&stream_position=0 \
        -H "authorization: Bearer <ACCESS_TOKEN>"

または

• 今すぐ開始し、並行して実行する:

    curl https://api.box.com/2.0/events?stream_type=admin_logs_streaming&stream_position=now \
        -H "authorization: Bearer <ACCESS_TOKEN>"

3. これまでの結果のページネーションを行い、admin_logsイベントとの重複を排除します

curl https://api.box.com/2.0/events?stream_type=admin_logs_streaming&stream_position=1632893855 \
    -H "authorization: Bearer <ACCESS_TOKEN>"

4. 十分と思われるまで重複を継続します

5. 古いadmin_logsリクエストを無効にします