ダッシュボードの概要
FourA Dashboardは、APIキーとproxyユーザーの管理、テストリクエストの実行、パフォーマンスの監視、請求処理、アカウント設定を行う場所です。このページでは、メインのOverview画面とサイドバーの各セクションについて説明します。
Dashboardへのアクセス
foura.ai/dashboardでサインインします。FourAアカウントが必要です。お持ちでない場合はこちらからサインアップしてください。
2つの製品、1つのページ構成
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製品はproxy portを指します。
Overviewページ(API製品)
サインイン後のランディングページには、選択した期間の主要指標が表示されます。ページは60秒ごとに自動更新され、タイトルの横にある更新ボタンにはカウントダウンが表示され、クリックすると即座に再読み込みされます。
初回リクエスト前
最初のリクエストが到着するまで、APIビューにはサンプルデータが表示されます。各パネルやチャートにはSampleタグが付き、2つのステップを含むThis is sample data.バナーが表示されます。ステップは、テストコマンドとともに新規キーを表示するCreate API keyと、リクエストを送信するためのOpen Playgroundです。スマートフォンやタブレットではコマンドを実行できないため、Playgroundへの誘導が表示されます。最初のリクエストが実際に送信されると、サンプルデータは完全に置き換えられます。
Proxyビューには独自のNo traffic yet.バナーがあり、Create proxy userとOpen Proxyが表示されます。これは、いずれかのproxyユーザーがトラフィックを処理するか、最初のAPIリクエストが到着するまで表示されます。どちらかのバナーを閉じると、両方のバナーが非表示になります。
サマリーカード
上部に並ぶ6つのパネル:
| パネル | 表示内容 |
|---|---|
| Concurrency | 現在同時に実行されているリクエスト数、および対象期間の平均と最大値 |
| Requests | 合計呼び出し数、続いて Single、Proxy、Browser、Auto の各内訳と合計に対する割合。Auto の呼び出しは Auto 配下に1回としてカウントされます。 |
| Auto attempts | 常に表示され、対象期間中に Auto が何も実行しなかった場合はゼロになります。Auto の呼び出しの背後で Auto が実行した Single、Proxy、Browser のリクエストと、Auto 呼び出しあたりの試行回数です。これらは通常のリクエスト数や成功率にはカウントされず、消費クレジットは Auto のクレジット内に含まれます。ただし、Single、Proxy、Browser の rate limit および concurrency limit にはカウントされます。 |
| Credits | 請求対象クレジット(主値)とその下に消費クレジットを表示。合計および Auto を含む各製品ごとに表示されます。 |
| Bytes | 転送データ量: In は送信データ、Out は受信データ、Premium はそのトラフィックのうちプレミアム出口を経由した部分(その出口がページを配信できたかどうかを問わない)です。Premium は2つの合計値の内数であり、合計値に加算されることはありません。 |
| Response Time | 対象期間全体の平均、最小、最大値 |
請求対象(Billed)と消費(Spent)は異なる数値です。 請求対象となるのは成功したリクエストのみであるため、Billed は支払いの対象となる数値です。一方、失敗したリクエストでもプロキシやブラウザのリソースを消費するため、Spent にはすべての結果が含まれます。一方を他方と混同して読み取ると、同じアカウントであるにもかかわらず2つのページで別のアカウントのように見えてしまいます。どの結果に対して請求が発生するかについては、Request Outcomes を参照してください。
Requests および Credits パネルでは、4つのエンドポイントを Single、Proxy、Browser、Auto と表記しています。それらの上にある Endpoints フィルター行では Proxy を Proxy Finder と呼んでいますが、これは同一のものです: POST /api/proxy/。
これら4つの合計が全体の合計と常に一致するとは限りません。ごく一部の呼び出しはいずれのエンドポイントにも属さず、それらは全体の合計にのみカウントされ、どの個別エンドポイントにもカウントされません。
タイムラインチャート
パネルの下には、リクエスト量、クレジット消費、結果の内訳、レスポンスタイム、帯域幅、同時実行数をプロットした6つのタイムラインチャートがあります。各チャートのヘッダーにある切り替えスイッチで、プロット表示をベースのテーブルデータに切り替えることができます。
概要ページ、Proxy 製品
Product を Proxy に切り替えると、同じページがトンネル単位のメトリクスに切り替わります。4つのパネルが表示されます:
| パネル | 表示内容 |
|---|---|
| Tunnels at Once | 同一瞬間に開いているトンネル数。Current は直近数秒間を対象とし5秒ごとに更新されます。Avg および Max は指定期間を対象とします。プランの制限は、すべてのプロキシユーザーの合算に対して適用されます。 |
| 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つのパネルとそのタイムラインチャートが薄暗く表示されますが、これは各ケースにおいて該当するOutcomeの数値が存在しないためです。Tunnels at OnceはいずれのOutcomeでも薄暗くなり、そのチャートにはNot filterableバッジが表示されます。Setup TimeとTrafficは失敗のOutcomeで薄暗くなり、チャートにはSuccess onlyバッジが表示されます。失敗したトンネルは引き渡されることがなく、トラフィックも発生しないためです。
期間と詳細度
Periodは遡る期間を指定します。8つのピルとCustomがあります:
| ピル | 期間 |
|---|---|
| 30M | 過去30分間 |
| 3H | 過去3時間 |
| 12H | 過去12時間 |
| 24H | 過去24時間 |
| 7D | 過去7日間 |
| 30D | 過去30日間 |
| 90D | 過去90日間 |
| 1Y | 過去12か月間 |
Customを開くと、今月、先月、過去6か月、全期間という4つのプリセットと、開始日および終了日のペアを含むダイアログが表示されます。日付範囲は選択した日の終わりまでとなり、現在の時刻を超えることはありません。
Detailは各バーの幅を決定します: 1分ごと、5分ごと、30分ごと、毎時、6時間ごと、毎日、毎週、毎月。デフォルトはAutoで、チャート上に少なくとも15本のバーが表示される最も粗いステップが選択されます。これにより、1年間が365本の細い線の集合ではなく把握しやすい形状として表示されます。Autoオプションには選択されたステップの名前が表示されます。
期間と詳細度は両方のプロダクトに適用されます。
FourAがその解像度を保持している期間を超えて遡る詳細度ステップは、非表示にはならずグレーアウトされます:
| 解像度 | 保持期間 |
|---|---|
| リクエストごと | 7日間 |
| 5分ごと | 30日間 |
| 毎時 | 12か月間 |
| 毎日 | 全履歴 |
許容範囲を超える古い期間を選択すると、より細かいオプションがグレーアウトされます。Autoがそれらを選択することはないため、データが集約されてチャートが空になることはありません。
フィルター
フィルターは重ね合わせて組み合わせることができ、PeriodとDetailも並行して機能します。
| フィルター | プロダクト | 機能 |
|---|---|---|
| Product | 両方 | APIまたはProxy |
| Endpoints | API | 1つのendpointにスコープを設定: Single、Proxy Finder、Browser、Auto。Auto呼び出しはAutoの下で1回カウントされます。そのラダーがバックグラウンドで実行したSingle、Proxy、BrowserのリクエストはAuto attemptsパネルに名前で表示され、個別のリクエストとしてはカウントされません。 |
| Outcome | 両方 | 1つのカテゴリを分離。APIでは全7種類、Proxyプロダクトではトンネルの終了状態となり得る5種類を提供します。 |
| Owner | 両方 | すべて、個人、またはいずれかの組織。少なくとも1つの組織に所属している場合にのみ表示されます。 |
| Key | API | 単一のAPIキーに限定 |
| Proxy user | Proxy | 単一のproxyユーザーに限定 |
API側のConcurrencyパネルとチャートには、EndpointsまたはOutcomeフィルターは適用されません。いずれかが有効な間は両方とも薄暗く表示され、チャートのヘッダーにもその旨が表示されます。
Ownerフィルター
Ownerドロップダウンは「誰のトラフィックを表示しているか」を切り替えます。Everything、Personal、および所属する組織ごとのエントリが用意されています。Metrics、Activity、API Keys、Proxyの各ページでもこの選択が同期されるため、ページ間で不一致が生じることはありません。
Usage & LimitsとBillingには意図的にこのコントロールがありません。これらは「自分に請求される対象は何か」に対応しており、個人のキーやproxyユーザー、および自分が所有する組織のリソースが集計されます。詳細はOrganizationsを参照してください。
サイドバーのセクション
11のページとDocsリンクで構成され、Dashboard、Tools、Access、Accountの4グループに分かれています。
Dashboard: Overview、Metrics、Activity
「何が起きたか」を把握するための3つのページです。3ページすべてにProduct切り替えスイッチが配置されています。
Overviewは上記のページであり、サインイン後の起点となる画面です。
MetricsにはUsageパネルがあります。API側ではAPI key、クライアントIP、またはドメイン別、Proxy側ではproxy user、ターゲット、出口国、クライアントIP、または結果別に内訳を表示します。ページ分割されたテーブルの上部には期間全体のカードが表示されます。詳細はMetricsガイドを参照してください。
Activityは過去1時間のトラフィックを表示します。ページを開いた時点で読み込まれ、更新ボタンで最新行を取得します。API側では各行が1つのrequest(メソッド、ターゲットドメイン、ステータス、結果、所要時間、転送サイズ、クレジット)を表します。Proxy側では各行が1つのトンネル(proxy user、ターゲット、出口、結果、セットアップ時間、所要時間、バイト数、クライアントIP)を表します。詳細はActivity Logを参照してください。
Tools: Playground、Extension、Docs
コードを書くことなく、実際のリクエストを本番API keyに対してテストできます。Auto、Single、Proxy、Browserのいずれかを選択し、URLを設定、フラグやタイムアウトを調整してSendを押します。一般的な設定はプリセットとして保存でき、直近20件の実行履歴からいつでもリプレイ可能です。
使用量は本番環境の呼び出しと同様にキーのクォータから消費されます。詳細はPlaygroundガイドを参照してください。
Betaと表記されているExtensionは、FourA Chrome拡張機能をダウンロードする場所です。拡張機能のポップアップから任意のproxy user経由でChromeをルーティングでき、DevTools内のFourAタブではページが発生させたリクエストをそのまま使えるAPIコールに変換できます。詳細はChrome Extensionを参照してください。
Docsをクリックすると本ドキュメントが新しいタブで開くため、表示中のダッシュボード画面は保持されます。
サイドバー上部のテーマボタンでは、デバイス設定、ライト、ダークを順次切り替えられます。この選択はfoura.aiおよびドキュメント全体で共有され、いずれかで設定したテーマがダッシュボードにも反映されます。
Access: API Keys、Proxy
API Keysでは、アプリケーションがAPIを呼び出すために使用するキーを作成、確認、管理します。キーにはプレフィックスpk_live_が付きます。詳細はManaging API Keysを参照してください。
Proxyでは、proxyユーザーの作成や、proxy URLを受け付ける任意のクライアント向け接続文字列のコピーを行えます。ポート経由のトンネルおよびトラフィックは、APIと同様にプランの使用量としてカウントされます。Proxy UsersおよびProxy Portリファレンスを参照してください。
アカウント: Organizations、Usage & Limits、Billing、Settings
Organizationsを使用すると、単一のオーナーのもとでAPIキーやproxyユーザーを同僚と共有できます。メールアドレスでメンバーを追加し、ロールを設定し、必要に応じて組織の所有権を引き継ぐことができます。組織の認証情報による使用量は、組織オーナーのプランに対してカウントされます。Organizationsを参照してください。
Usage & Limitsには、現在のプラン、当請求期間の使用量、適用されるすべての制限が表示され、キー別、endpoint別、proxyユーザー別の内訳を確認できます。Usage & Limitsを参照してください。
Billingでは、サブスクリプションの管理、クレジットやトラフィックの追加購入、支払い方法や請求書の管理を行えるほか、今期のプランに対するクレジット、トラフィック、プレミアムトラフィックの使用状況を確認できます。Billing & Subscriptionsを参照してください。
Settingsには、表示名、パスワード、アクティブなセッション、連携済みのサインインプロバイダーが含まれます。ダッシュボードからのメールアドレス変更には対応していません。サポートまでお問い合わせください。
ヒント
- コードを書く前にPlaygroundを活用してください。新しいサイトに必要なエンジンが不明な場合は、Autoを選択して自動判定させることから始めてください。
- Creditsカードで請求額と消費額を比較してください。両者の差が大きいendpointは失敗が頻発している可能性があり、attempt reportでその原因を確認できます。
- Proxyプロダクトにおいて、Outcome Timelineに表示されるRate Limitedのブロックは、ターゲット側による拒否ではなく、契約プランの制限値によるものです。MetricsのOutcomeビューで該当する制限を確認できます。
- APIキーとproxyユーザーの安全を確保してください。漏洩の疑いがある場合は、直ちにいずれかを無効化してください。
次のステップ
- Authentication: APIキーの作成と管理の詳細
- Quick Start: CLIから最初のリクエストを実行
- How Your Plan Is Metered: クレジット、トラフィック、適用される上限の詳細
- Usage & Limits: プランに対するクレジットとトラフィックの追跡
- API Endpoints: APIを直接利用