Waiting Room の状態を監視する

Waiting Room の状態は、ダッシュボードまたは API で監視できます。

ダッシュボードに表示される Total active users と Queued users、および API エンドポイントで返す値は推定値です。これらの指標に対応するデータは、全世界のデータセンターから同期したあと、約 30 秒間キャッシュされます。そのため、状態はクエリした時点、集計のタイミング、キャッシュの古さによって、20〜50 秒前の値になります。

Waiting Room を通過するトラフィックの詳細は、Waiting Room Analytics を参照してください。

ダッシュボードでの状態

Waiting Room ダッシュボードを開き、Waiting Room の一覧を表示します。

Status 列には、Waiting Room の現在の状態が表示されます。

Not queueing:
- Waiting Room は有効ですが、訪問者を Waiting Room へ送るトラフィックしきい値に達していません。
- アプリケーション内の推定ユーザー数を表示します。
Queueing:
- Waiting Room は有効で、訪問者を Waiting Room へ送っています。
- キュー内の推定ユーザー数を表示します。
- ホバーすると、ユーザーに想定される最大待ち時間を表示します。
Disabled: Waiting Room は停止しています。
Queue-all:
- すべてのトラフィックを Waiting Room でキューイングします。
- ホバーすると、キュー内の推定ユーザー数を表示します。

API での状態

設定済み Waiting Room でトラフィックがキューイングされているかを確認するには、Cloudflare API のベース URL に次のエンドポイントを付けます。

Required API token permissions

At least one of the following token permissions is required:

Waiting Rooms Read
Waiting Rooms Write

Get waiting room statusbash

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/waiting_rooms/$WAITING_ROOM_ID/status" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

レスポンスは次のとおりです。

queueing: 訪問者が現在 Waiting Room でキューイングされています。
not_queueing: ルームが空か、Waiting Room が停止しています。

設定済み Waiting Room が停止しているか、トラフィックが強制キューされているかを確認するには、Cloudflare API のベース URL に次のエンドポイントを付けます。

Required API token permissions

At least one of the following token permissions is required:

Waiting Rooms Read
Waiting Rooms Write

Waiting room detailsbash

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/waiting_rooms/$WAITING_ROOM_ID" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

上記のエンドポイントは、設定済み Waiting Room のすべての設定を取得します。

      "success": true,
      "errors": [],
      "messages": [],
      "result": {
        "id": "REDACTED",
        "created_on": "2014-01-01T05:20:00.12345Z",
        "modified_on": "2014-01-01T05:20:00.12345Z",
        "name": "shop_waiting_room",
        "description": "Waiting room for webshop",
        "suspended": false,
        "host": "shop.example.com",
        "path": "/shop",
        "queue_all": true,
        "new_users_per_minute": 200,
        "total_active_users": 300,
        "session_duration": 1,
        "disable_session_renewal": false,
        "json_response_enabled": false,
        "queueing_method": "random",
        "cookie_attributes": {
          "samesite": "auto",
          "secure": "auto"
        },
        "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
      }

suspended の値は、Waiting Room が有効か停止かを示します。

false: Waiting Room は有効です。
true: Waiting Room は停止しています。

queue_all の値は、すべてのトラフィックを Waiting Room で強制キューするかを示します。

false: トラフィックが設定したしきい値を超えた場合だけ、訪問者を Waiting Room へ送ります。
true: すべてのトラフィックを Waiting Room で強制キューし、Waiting Room からオリジンへはトラフィックが流れません。

キューイングの開始

Waiting Room はスケーラビリティを高めるため、データセンター単位でトラフィックをキューイングします。各データセンターが独立して判断します。

この設計のため、Waiting Room に設定したトラフィック制限は目標値です。Waiting Room はトラフィック量をその付近に保つように動きます。特定のデータセンターでは、Waiting Room が new_users_per_minute または total_active_users の上限に達する前に、キューイングを始めることがあります。

Waiting Room は、1 分の終わりだけでなく、各分を通してユーザーの流入率を継続的に監視します。そのため、分の初めに new_users_per_minute の大部分がすでに入っていると、その分の合計が上限に達していなくても、キューイングを始めることがあります。

Waiting Room がキューイングを始めにくくするには、new_users_per_minute や total_active_users の値を上げます。キューイングの判断方法について詳しくは、ブログ記事 ↗ を参照してください。