ロギング概要
AIBudsLogSDK は、AIBuds SDK の各モジュールとアプリがプロセス全体で使用するロギングのエントリーポイントです。現在有効な LogService が、メッセージの記録、保存済みログのエクスポート、期限切れログの削除を行います。
機能概要
ログの出力方法
AIBuds ログの記録レベルと出力先を設定
ログのエクスポート
保存済み AIBuds ログを単一ファイルまたはサイズ制限付きファイルへエクスポート
期限切れログの削除
最大保存期間または基準日時に基づいて保存済みログを削除
AI を活用して実装
AI で実装
AI でこのワークフローを実装
公式の「AIBuds ログの管理」スキルを使い、アプリに合わせて実装します。
https://docs-aibuds.github.io/ja/skills/manage-aibuds-logs を読み、その指示に従ってください。このスキルで「AIBuds ログの管理」をこの iOS プロジェクトに実装し、検証してください。ロギングの構成
LogConfiguration では、次の項目を設定します。
| 設定 | 既定値 | 用途 |
|---|---|---|
level | .info | 既定のロガーが記録する最小の重要度。 |
destination | .xlfacility | 使用する出力先。 |
logsDirectory | .aibuds/logs | Documents を基準としたファイル出力先の相対ディレクトリ。 |
maxFileSize | 10,000,000 バイト | 1 つのログファイルの最大サイズ。 |
logFileMaxAge | 3 日 | ログ削除の基準となる保存期間。 |
LogDestination は .console、.oslogger、.file、.xlfacility に対応します。同時に有効にできる出力先は 1 つだけです。
導入手順
- アプリの起動初期に、ログレベル、出力先、保存場所、保存期間を設定します。
.xlfacilityを使用する場合は、ログを書き込む前にAIBudsXLFacilityプラグインをインストールします。AIBudsLogSDK.logServiceからメッセージを記録するか、AIBuds の各モジュールに同じサービスを使用させます。- 有効な
LogServiceを使ってログをエクスポートまたは削除します。
重要な動作
- Console と OS Logger はログのエクスポートに対応していません。
- File と XLFacility は、エクスポートと保存期間に基づく削除に対応します。
- カスタムサービスをインストールしていない場合、
AIBudsLogSDK.logServiceは組み込みのDefaultLoggerを返します。 - プラグインを設定せずに
.xlfacilityを選択すると、コンソールにエラーが出力され、XLFacility による保存やエクスポートは行えません。