3.6. SMFileLogger
StarIO.xcframeworkおよびStarIO_Extension.xcframeworkのログをファイルに出力する機能を提供するクラスです。 SMLogger クラスを継承します。
注釈
このクラスで記録されたログを使用して問い合わせを行う場合は、問題の原因となった可能性のあるイベントの日時も提供してください。
プロパティ
名称
説明
SMFileLoggerクラスのシングルトンインスタンスです。
保存するログファイルの最大サイズを指定します。
保存するログファイルのディレクトリパスを示します。
出力ログファイルは、アプリケーションのDocuments/starlogディレクトリに保存されます。 ファイル共有機能を利用して、保存したファイルにアクセスできます。
- Ex. 1: iTunes file sharingを利用する場合
Information Property Listに項目を追加する必要があります。 設定手順は以下の通りです。
Information Property List(デフォルトでは"Info.plist")を選択します。
Keyに
Application supports iTunes file sharing
を追加します。Valueに
YES
を設定します。
- Ex. 2: opening documents in placeを利用する場合
Information Property Listに項目を追加する必要があります。 設定手順は以下の通りです。
Information Property List(デフォルトでは"Info.plist")を選択します。
Keyに
Supports opening documents in place
を追加します。Valueに
YES
を設定します。
3.6.2. maxLogSize
保存するログファイルの最大サイズを指定します。
宣言
open var maxLogSize: UInt
値
説明
型
保存するログファイルの最大値(MB)。デフォルト値: 50(MB)0が指定された場合、最大サイズは制限されません。UInt
3.6.3. logDirectoryPath
保存するログファイルのディレクトリパスを示します。
宣言
open var logDirectoryPath: String { get }
値
説明
型
ログファイルが保存される"Documents/starlog"のディレクトリパスを示します。
String
3.6.4. SMFileLoggerクラスを使用したログ出力のサンプル
// Get SMFileLogger class singleton instance.
let logger = SMFileLogger.shared
// Set the log level.
logger.logLevel = .default
// Set the maximum log size to be kept (optional).
logger.maxLogSize = 10
// Start log output.
logger.start()
// Output the desired character string (optional).
logger.log("(Log message)")
// Stop log output.
logger.stop()