ジョブIDで指定されたジョブのAPIログの統計情報を表示する
最新リリースからコンパイル済みのバイナリをダウンロードしてください. Windowsをお使いの方は、tbx-xx.x.xxx-win.zipのようなzipファイルをダウンロードしてください. その後、アーカイブを解凍し、デスクトップ フォルダに tbx.exe を配置します.
watermint toolboxは、システムで許可されていれば、システム内のどのパスからでも実行できます. しかし、説明書のサンプルでは、デスクトップ フォルダを使用しています. デスクトップ フォルダ以外にバイナリを配置した場合は、パスを読み替えてください.
このドキュメントは”デスクトップ”フォルダを例として使用します.
Windows:
cd $HOME\Desktop
.\tbx.exe log api job
macOS, Linux:
$HOME/Desktop/tbx log api job
macOS Catalina 10.15以上の場合: macOSは開発者情報を検証します. 現在、tbxはそれに対応していません. 実行時の最初に表示されるダイアログではキャンセルします. 続いて、”システム環境設定”のセキュリティーとプライバシーから一般タブを選択します.
次のようなメッセージが表示されています:
“tbx”は開発元を確認できないため、使用がブロックされました。
“このまま開く”というボタンがあります. リスクを確認の上、開いてください. ２回目の実行ではダイアログに”開く”ボタンがありますので、これを選択します
| オプション | 説明 | デフォルト |
|---|---|---|
-full-url |
完全なURLを表示する | false |
-interval-second |
時系列の間隔(秒) | 3600 |
-job-id |
ジョブID |
| オプション | 説明 | デフォルト |
|---|---|---|
-auth-database |
認証データベースへのカスタムパス (デフォルト: $HOME/.toolbox/secrets/secrets.db) | |
-auto-open |
成果物フォルダまたはURLを自動で開く | false |
-bandwidth-kb |
コンテンツをアップロードまたはダウンロードする際の帯域幅制限(Kバイト毎秒). 0の場合、制限を行わない | 0 |
-budget-memory |
メモリの割り当て目標 (メモリ使用量を減らすために幾つかの機能が制限されます) | normal |
-budget-storage |
ストレージの利用目標 (ストレージ利用を減らすためログ、機能を限定します) | normal |
-concurrency |
指定した並列度で並列処理を行います | プロセッサー数 |
-debug |
デバッグモードを有効にする | false |
-experiment |
実験的機能を有効化する | |
-extra |
追加パラメータファイルのパス | |
-lang |
表示言語 | auto |
-output |
出力書式 (none/text/markdown/json) | text |
-proxy |
HTTP/HTTPS プロクシ (hostname:port). プロキシの設定を省略したい場合はDIRECTを指定してください |
|
-quiet |
エラー以外のメッセージを抑制し、出力をJSONLフォーマットに変更します | false |
-retain-job-data |
ジョブデータ保持ポリシー | default |
-secure |
トークンをファイルに保存しません | false |
-skip-logging |
ローカルストレージへのログ保存をスキップ | false |
-verbose |
現在の操作を詳細に表示します. | false |
-workspace |
ワークスペースへのパス |
作成されたレポートファイルのパスはコマンド実行時の最後に表示されます. もしコマンドライン出力を失ってしまった場合には次のパスを確認してください. [job-id]は実行の日時となります. このなかの最新のjob-idを各委任してください.
| OS | パスのパターン | 例 |
|---|---|---|
| Windows | %HOMEPATH%\.toolbox\jobs\[job-id]\reports |
C:\Users\bob.toolbox\jobs\20190909-115959.597\reports |
| macOS | $HOME/.toolbox/jobs/[job-id]/reports |
/Users/bob/.toolbox/jobs/20190909-115959.597/reports |
| Linux | $HOME/.toolbox/jobs/[job-id]/reports |
/home/bob/.toolbox/jobs/20190909-115959.597/reports |
レイテンシー
このコマンドはレポートを3種類の書式で出力します. latencies.csv, latencies.json, ならびに latencies.xlsx.
| 列 | 説明 |
|---|---|
| url | URL |
| code | 応答コード |
| population | リクエスト数 |
| mean | 平均 |
| median | 中央値 |
| p_50 | パーセンタイル50 |
| p_70 | パーセンタイル 70 |
| p_90 | パーセンタイル90 |
-budget-memory lowオプションを指定した場合、レポートはJSON形式のみで生成されます
レポートが大きなものとなる場合、.xlsxフォーマットのファイルは次のようにいくつかに分割されて出力されます; latencies_0000.xlsx, latencies_0001.xlsx, latencies_0002.xlsx, …
リクエスト数
このコマンドはレポートを3種類の書式で出力します. population.csv, population.json, ならびに population.xlsx.
| 列 | 説明 |
|---|---|
| url | URL |
| code | 応答コード |
| population | リクエスト数 |
| proportion | 比率 |
-budget-memory lowオプションを指定した場合、レポートはJSON形式のみで生成されます
レポートが大きなものとなる場合、.xlsxフォーマットのファイルは次のようにいくつかに分割されて出力されます; population_0000.xlsx, population_0001.xlsx, population_0002.xlsx, …
時系列のまとめ
このコマンドはレポートを3種類の書式で出力します. time_series.csv, time_series.json, ならびに time_series.xlsx.
| 列 | 説明 |
|---|---|
| time | 時間 |
| url | URL |
| code_2xx | 2xxのリクエスト数 |
| code_3xx | 3xx のリクエスト数 |
| code_4xx | 4xx（429を除く）のリクエスト数 |
| code_429 | 429のリクエスト数 |
| code_5xx | 5xx のリクエスト数 |
| code_other | その他のリクエスト数 |
-budget-memory lowオプションを指定した場合、レポートはJSON形式のみで生成されます
レポートが大きなものとなる場合、.xlsxフォーマットのファイルは次のようにいくつかに分割されて出力されます; time_series_0000.xlsx, time_series_0001.xlsx, time_series_0002.xlsx, …
プログラムはシステム設定から自動的にプロクシ設定情報を取得します. しかしながら、それでもエラーが発生する場合には明示的にプロクシを指定することができます. -proxy オプションを利用します, -proxy ホスト名:ポート番号のように指定してください. なお、現在のところ認証が必要なプロクシには対応していません.