PlanetKitの初期化およびログ設定
アプリケーションでLINE Planetの機能を使用する前にPlanetKitを初期化する必要があります。ここでは、PlanetKitを初期化し、ログを設定するサンプルコードを提供します。
初期化
PlanetKitInitialSettingBuilderオブジェクトを引数としてPlanetKitManagerのinitialize()を呼び出し、PlanetKitを初期化します。このとき、必ずplanet_base_urlを設定する必要があります。
環境別のplanet_base_url情報は、開発環境で確認できます。
class YourApplication {
func initializePlanetKit() {
let logLevel: PlanetKitLogLevel = .simple
let logSizeLimit: PlanetKitLogSizeLimit = .small
let settingBuilder = PlanetKitInitialSettingBuilder()
.withEnableKitLogKey(level: logLevel, enable: true, logSize: logSizeLimit)
.withSetKitServerKey(serverUrl: planet_base_url)
let initialSettings = settingBuilder.build()
PlanetKitManager.shared.initialize(initialSettings: initialSettings)
...
}
}
ログの設定
デバッグするには、PlanetKitInitialSettingBuilderのwithEnableKitLogKey(level:enable:logSize)を使用します。初期化中のロギングを有効にしてから設定する必要があります。
ロギングの有効化
ロギングを有効にするには、withEnableKitLogKey(level:enable:logSize)を呼び出す際にenable: trueを設定します。デフォルトの設定は、無効になっています。
PlanetKit 5.1以上のバージョンからは、ファイルでのログ出力のみ可能です。
ログレベルの設定
ログレベルを設定して、デバッグ情報の出力レベルを調整できます。
ログレベルを設定するには、withEnableKitLogKey(level:enable:logSize)のlevelパラメーターをPlanetKitLogLevelの値のいずれかに設定してください。使用できるログレベルの設定は、次のとおりです。
silent：PlanetKitがデバッグ情報を出力しません。（デフォルト値）simple：PlanetKitが簡単なデバッグ情報を出力します。detailed：PlanetKitが詳細なデバッグ情報を出力します。
- PlanetKit 5.2以上のバージョンからログレベルが変更されました。
- LINE Planetチームにデバッグを依頼する際には、
detailedレベルで生成されたログファイルを共有してください。
ログサイズの制限設定
ログファイルの全体のサイズ制限を設定するには、withEnableKitLogKey(level:enable:logSize)のlogSizeパラメーターをPlanetKitLogSizeLimitの値のいずれかに設定します。使用できるログサイズの制限設定は、次のとおりです。
small：ログファイルの全体のサイズ制限は、16MBです。medium：ログファイルの全体のサイズ制限は、64MBです。large：ログファイルの全体のサイズ制限は、256MBです。（デフォルト値）unlimited：ログファイルの全体のサイズに制限はありません。