使用状況ログ
警告
この機能は実験的であり、将来のリリースで変更される可能性があります。
備考
使用状況ログは v.26.1.5 以降で利用可能です。
Asprova My Schedule / WS サーバは、ログイン、ログアウト、データアクセスなどのイベントの使用状況ログを記録できます。
使用状況ログの有効化
警告
使用状況ログを有効にすると、サーバのパフォーマンスに悪影響を及ぼす可能性があります。
使用状況ログはデフォルトで無効です。有効にするには、サーバの config.json で以下を設定してください:
{
"enable_usage_log": true
}
設定
| 設定項目 | デフォルト値 | 説明 |
|---|---|---|
enable_usage_log | false | 使用状況ログの有効・無効を切り替えます。 |
usage_log_retention | "30d" | 使用状況ログファイルが自動削除されるまでの保持期間です。 |
ログファイル
使用状況ログファイルは、サーバのデータディレクトリ (user_file_directory) 内の logs ディレクトリに書き込まれます。
デフォルトでは、以下のパスになります:
C:\ProgramData\Asprova\Asprova My Schedule\WS\logs
毎日 usage-YYYY-MM-DD.log という名前のファイルが生成されます。ファイルは自動的にローテーションされ、保持期間の設定に基づいて古いファイルは削除されます。
ログファイルの各行は、以下を含む JSON オブジェクトです:
- eventType — イベントの種類(下記参照)。
- user — イベントを発生させたユーザ(該当する場合)。
userId— ユーザの ID。username— ユーザの名前。
- req — イベントを発生させた HTTP リクエストの情報(該当する場合)。
method— HTTP メソッド(例:POST)。path— リクエストパス(例:/api/auth/login)。ip— クライアントの IP アドレス。
- details — イベント固有の追加情報。
- timestamp — イベントの発生日時。
イベント
以下のイベントが記録されます:
| イベント | 説明 |
|---|---|
ws:server:start | サーバが起動しました。 |
ws:user:created | ユーザが作成されました。 |
ws:user:login:success | ユーザのログインが成功しました。 |
ws:user:login:failure | ログイン試行が失敗しました。 |
ws:user:logout |