ダッシュボードの概要
FourA Dashboardでは、APIキーとプロキシユーザーの管理、テストリクエストの実行、パフォーマンスの監視、請求の処理、アカウントの設定を行えます。このページでは、メインのOverview画面とサイドバーの各セクションについて説明します。
Dashboardへのアクセス
foura.ai/dashboardからサインインします。FourAアカウントが必要です。お持ちでない場合はこちらから登録してください。
2つのプロダクト、共通のページ群
Overview、Metrics、Activityの各ページには、2つの選択肢を持つProductスイッチがあります。
| Product | カウント対象 | 単位 |
|---|---|---|
| API | /api/single、/api/proxy、/api/browser、/api/autoへ送信されたリクエスト |
リクエストおよびクレジット |
| Proxy | proxy.foura.ai経由で独自のツールが開いたトンネル |
トンネルおよびバイト |
トンネルはクライアントが送信したすべてのトラフィックをそのまま転送し、CONNECTの内部で発生する処理は暗号化されたユーザー独自のトラフィックとなります。そのため、Proxyビューではトンネルとバイトのみをカウントし、リクエストやクレジットはカウントしません。プロダクト自体の詳細についてはProxy Portを参照してください。
スイッチは常にいずれか一方に設定されており、訪問間でも記憶され、URLアドレス内では#overview/proxy、#metrics/proxy、または#activity/proxyとして反映されます。これらのリンクのいずれかを貼り付けると、該当するプロダクトが選択された状態でページが開きます。
ProxyプロダクトとProxy Finderエンドポイントチップを混同しないでください。Proxy Finderは、APIの4つのエンドポイントの1つであるPOST /api/proxy/です。Proxyプロダクトはプロキシポートを指します。
Overviewページ(APIプロダクト)
サインイン後のランディングページには、選択した期間の主要な数値が表示されます。
初回リクエスト前
最初のリクエストが届くまで、APIビューにはサンプルデータが表示され、各パネルやチャートにSampleタグが付き、2つのステップを含むThis is sample data.バナーが表示されます。ステップには、テストコマンドとともに新しいキーを開くCreate API keyと、リクエストを送信するためのOpen Playgroundがあります。スマートフォンやタブレットではコマンドを実行できないため、Playgroundへ誘導されます。最初のリクエストが実際に送信されると、サンプルデータは恒久的に置き換えられます。
Proxyビューには独自のNo traffic yet.バナーがあり、いずれかのプロキシユーザーがトラフィックを処理するまで、Create proxy userとOpen Proxyが表示されます。どちらかのバナーを閉じると、両方が非表示になります。
サマリーカード
上部に5つのパネルが表示され、該当期間内にAutoが実行された場合は6つ目のパネルが追加されます。
| パネル | 表示内容 |
|---|---|
| Concurrency | 現在同時に実行中のリクエスト数、および期間中の平均値と最大値 |
| Requests | 合計呼び出し数、続いて Single、Proxy、Browser、Auto の各内訳と全体に対する割合。Auto の呼び出しは Auto 配下に 1 回としてカウントされます。 |
| Auto attempts | 期間中に Auto が実行された場合にのみ表示されます。Auto 呼び出しの背後で Auto が実行した Single、Proxy、Browser のリクエストと、Auto 呼び出しあたりの試行回数です。これらがリクエスト数や成功率にカウントされることはなく、クレジットは Auto のクレジット内に含まれます。ただし、Single、Proxy、Browser のレート制限および同時実行制限にはカウントされます。 |
| Credits | 請求対象クレジット(Billed credits)をメイン値として表示し、その下に消費クレジット(Spent credits)を表示(合計および Auto を含む各プロダクト別) |
| Bytes | 転送データ量: In は送信データ、Out は受信データ、Premium はそのトラフィックのうちプレミアム出口を経由した分(ページが正常に配信されたかどうかに関わらず)です。Premium は 2 つの合計の内数であり、加算されることはありません。 |
| Response Time | 期間全体の平均、最小、最大レスポンスタイム |
請求対象クレジット(Billed)と消費クレジット(Spent)は異なる数値です。 請求対象となるのは成功したリクエストのみであるため、Billed は支払いの対象となる値です。失敗したリクエストでも proxy や browser は消費されるため、Spent にはすべての結果が含まれます。これらを混同して確認すると、同一アカウントであっても別々のページで数値が異なって見える原因になります。課金対象となる結果については Request Outcomes を参照してください。
Requests および Credits パネルでは、4 つの endpoint が Single、Proxy、Browser、Auto と表記されています。それらの上にある Endpoints フィルター行では Proxy を Proxy Finder と表記していますが、同じものを指します(POST /api/proxy/)。
これら 4 つの合計が全体の合計と常に一致するとは限りません。ごく少数の呼び出しにはこれらいずれにも該当しないものがあり、それらは全体の合計にのみ含まれ、どの endpoint にもカウントされません。
タイムラインチャート
パネルの下には、リクエスト数、クレジット消費量、結果の内訳、レスポンスタイム、帯域幅、同時実行数をプロットした 6 つのタイムラインチャートが表示されます。各チャートのヘッダーには、プロットを元のデータテーブルに切り替えるトグルがあります。
概要ページ、Proxy プロダクト
Product を Proxy に切り替えると、同じページにトンネル関連のデータが表示されます。パネルは 4 つあります。
| パネル | 表示内容 |
|---|---|
| Tunnels at Once | 同一タイミングでオープンされているトンネル数。Current は直近数秒間を対象とし 5 秒ごとに更新され、Avg と Max は対象期間全体をカバーします。プランの上限は、すべての proxy ユーザーを合わせた全体に適用されます。 |
| Tunnels | Success と Failed、および全体に対するそれぞれの割合。Failed にはその他すべての結果が含まれ、Outcome 行にその詳細が表示されます。 |
| Traffic | In はツールが送信したデータ、Out は受信したデータ、Premium はプレミアムネットワークを経由して送信されたデータ(合計に加算されるのではなく、内数としてカウント)です。 |
| Setup Time | 正常に確立されたトンネルのみを対象とした、トンネルが引き渡されるまでの平均、最小、最大待機時間。これは最初の 1 バイトを受信するまでの待機時間であり、トンネルの先にあるサイトの速度ではありません。 |
その下には5つのタイムラインチャートが並びます: Tunnel Timeline、Outcome Timeline、Setup Time Timeline、Traffic Timeline、Tunnels at Once Timeline。それぞれAPIチャートと同様のチャート/テーブル切り替えが可能です。
Outcomeピルが選択されている間は3つのパネルがグレーアウトします。理由はそれぞれのケースで、その結果に対する数値が存在しないためです。Tunnels at Onceはどのoutcomeでもグレーアウトします。Setup TimeとTrafficは失敗のoutcomeでグレーアウトし、Success onlyバッジが表示されます。失敗したトンネルはハンドオーバーされず、トラフィックも発生しないためです。
PeriodとDetail
Periodはどのくらい過去まで遡って表示するかを指定します。8つのピルとCustomがあります:
| ピル | 期間 |
|---|---|
| 30M | 過去30分 |
| 3H | 過去3時間 |
| 12H | 過去12時間 |
| 24H | 過去24時間 |
| 7D | 過去7日間 |
| 30D | 過去30日間 |
| 90D | 過去90日間 |
| 1Y | 過去12か月 |
Customを開くと、This month、Last month、Last 6 months、All timeの4つのプリセットと、From/Toの日付指定ダイアログが表示されます。日付範囲は選択した日の終了時刻までとなり、現時点を超えることはありません。
Detailは各バーの細かさを指定します: 毎分、5分ごと、30分ごと、毎時、6時間ごと、毎日、毎週、毎月。デフォルトはAutoで、チャート上に少なくとも15本のバーが表示される最も粗いステップが選択されるため、1年間のデータが365本の極細線にならず全体の傾向として把握できます。Autoオプションには選択されたステップ名が表示されます。
PeriodとDetailは両方の製品に適用されます。
FourAが解像度を保持している期間よりも過去に遡るDetailステップは、非表示にはならずグレーアウトします:
| 解像度 | 保持期間 |
|---|---|
| Per-request | 7日間 |
| 5-minute | 30日間 |
| Hourly | 12か月 |
| Daily | 全期間 |
解像度の保持期間を超えるPeriodを選択すると、より細かいオプションがグレーアウトします。Autoがそれらを選択することはないため、データ集約によってチャートが空になることはありません。
フィルター
フィルターは重ね合わせて適用でき、PeriodとDetailも併用可能です。
| フィルター | 対象製品 | 機能 |
|---|---|---|
| Product | 両方 | APIまたはProxy |
| Endpoints | API | 単一のエンドポイント(Single、Proxy Finder、Browser、Auto)にスコープを設定。Autoの呼び出しはAuto配下に1回カウントされます。内部でラダー実行されたSingle、Proxy、BrowserのリクエストはAuto attemptsパネルに名前付きで表示され、個別のリクエストとしてはカウントされません。 |
| Outcome | 両方 | 1つのカテゴリを抽出。APIでは全7種、Proxy製品ではトンネルの終了ステータスである5種を利用可能。 |
| Owner | 両方 | Everything、Personal、または所属組織のいずれか。少なくとも1つの組織に所属している場合のみ表示。 |
| Key | API | 単一のAPIキーに限定 |
| Proxy user | Proxy | 単一のプロキシユーザーに限定 |
API側のConcurrencyパネルとチャートにはEndpointsやOutcomeフィルターは適用されません。いずれかが有効な間は両方ともグレーアウトし、チャートヘッダーにその旨が表示されます。
Ownerフィルター
Owner ドロップダウンは「誰のトラフィックを表示しているか」を切り替えます。Everything、Personal、および所属する各組織のエントリが用意されています。Metrics、Activity、API Keys、Proxy の各画面にも同一の選択が反映されるため、ページ間で不一致が生じることはありません。
Usage & Limits と Billing にはこのドロップダウンが意図的にありません。これらは「何が自分に請求されるか」を示す画面であり、お客様の個人キーや proxy ユーザー、および自身がオーナーを務める組織の利用分が表示されます。Organizations を参照してください。
サイドバーのセクション
4 つのグループ(Dashboard、Tools、Access、Account)に分かれた 11 のセクションがあります。
Dashboard: Overview、Metrics、Activity
「何が起きたか」を確認するための 3 つのページです。3 つすべてに Product 切替スイッチがあります。
Overview は上記のページであり、サインイン後は常にこの画面が起点となります。
Metrics には Usage パネルがあります。API 側では API key、client IP、domain ごとにグループ化された内訳、Proxy 側では proxy user、target、exit country、client IP、outcome ごとの内訳が表示され、ページネーション対応テーブルの上部に全期間のカードが表示されます。Metrics guide を参照してください。
Activity は直近 1 時間のライブフィードです。API 側では各行が 1 つのリクエスト(method、target domain、status、outcome、duration、転送サイズ、credits)を示します。Proxy 側では各行が 1 つのトンネル(proxy user、target、exit、outcome、setup、duration、bytes、client IP)を示します。Activity Log を参照してください。
Tools: Playground、Extension
コードを書くことなく、実際の API key を使用してライブリクエストをテストできます。Auto、Single、Proxy、Browser から選択し、URL を設定してフラグやタイムアウトを調整し、Send をクリックします。よく使う設定をプリセットとして保存したり、History から直近 20 回の実行を再実行したりできます。
利用量は本番環境のコールと同様に、API key のクォータにカウントされます。Playground guide を参照してください。
Extension(Beta 表記)では、FourA Chrome 拡張機能をダウンロードできます。ポップアップから proxy ユーザーを経由して Chrome をルーティングでき、DevTools の FourA タブではページが発生させたリクエストをそのまま使える API コールに変換できます。Chrome Extension を参照してください。
Access: API Keys、Proxy
API Keys では、アプリケーションが API を呼び出すために使用するキーの作成、確認、管理を行います。キーには pk_live_ プレフィックスが使用されます。Managing API Keys を参照してください。
Proxy では、proxy ユーザーの作成や、proxy URL に対応する任意のクライアント向けの接続文字列のコピーを行います。ポートを経由するトンネルとトラフィックは、API と同様にお使いのプランのクォータにカウントされます。Proxy Users および Proxy Port リファレンスを参照してください。
Account: Organizations、Usage & Limits、Billing、Settings
Organizations では、1 人のオーナーのもとで同僚と API key や proxy ユーザーを共有します。メールアドレスでメンバーを追加し、ロールを設定し、必要に応じて組織のオーナー権限を譲渡できます。組織のクレデンシャルによる利用量は、組織オーナーのプランにカウントされます。Organizations を参照してください。
Usage & Limits では、プラン内容、現在の請求期間の使用量、適用されている各制限を確認でき、キーごと、エンドポイントごと、プロキシユーザーごとの内訳も表示されます。詳細は Usage & Limits を参照してください。
Billing では、サブスクリプションの管理、クレジットやトラフィックの追加購入、支払い方法や請求書の管理を行えるほか、今期のクレジット、トラフィック、プレミアムトラフィックのプランに対する使用状況を確認できます。詳細は Billing & Subscriptions を参照してください。
Settings には、表示名、パスワード、アクティブなセッション、連携済みのサインインプロバイダーが保持されます。ダッシュボードからのメールアドレス変更には対応していません。サポートまでお問い合わせください。
Tips
- コードを書く前に Playground をお試しください。新しいサイトにどのエンジンが必要か不明な場合は、Auto を選択して自動判定させてください。
- Credits カードで請求対象(billed)と消費量(spent)を比較してください。両者の差が大きいエンドポイントは失敗頻度が高くなっており、attempt report でその原因を確認できます。
- Proxy 製品において、Outcome Timeline に表示される一連の Rate Limited はプランの制限値によるものであり、ターゲット側による拒否ではありません。Metrics の Outcome ビューで該当する制限を確認できます。
- API キーとプロキシユーザーは安全に保管してください。漏洩が疑われる場合は、直ちに無効化してください。
Next Steps
- Authentication: API キーの作成と管理の詳細
- Quick Start: CLI から最初の request を送信する手順
- How Your Plan Is Metered: クレジット、トラフィック、および適用される上限について
- Usage & Limits: プランに対するクレジットとトラフィックの追跡
- API Endpoints: API を直接利用する方法