コンテンツにスキップ

Log 設定

Log 初期化設定

    //logger を有効化
    FTLoggerConfig *loggerConfig = [[FTLoggerConfig alloc]init];
    loggerConfig.enableCustomLog = YES;
    loggerConfig.enableLinkRumData = YES;
    loggerConfig.logLevelFilter = @[@(FTStatusError),@(FTStatusCritical)];
    loggerConfig.discardType = FTDiscardOldest;
    [[FTMobileAgent sharedInstance] startLoggerWithConfigOptions:loggerConfig];
    let loggerConfig = FTLoggerConfig()
    loggerConfig.enableCustomLog = true
    loggerConfig.enableLinkRumData = true
    loggerConfig.logLevelFilter = [NSNumber(value: FTLogStatus.statusError.rawValue),NSNumber(value: FTLogStatus.statusCritical.rawValue)] // loggerConfig.logLevelFilter = [2,3]
    loggerConfig.discardType = .discardOldest
    FTMobileAgent.sharedInstance().startLogger(withConfigOptions: loggerConfig)
プロパティ 型 必須 意味
logSamplingRate float いいえ Log サンプリングレート。範囲 [0,100]、小数をサポート、デフォルト 100。0.1 は 0.1%、1 は 1% を表します。SDK 1.6.8 以降でサポート。
sampleRate int いいえ SDK 1.6.8 以降で非推奨、互換性のため保持。整数パーセントのサンプリングレート。範囲 [0,100]、デフォルト 100。logSamplingRate の使用を推奨します。
enableWebViewLog BOOL いいえ SDK 1.6.8+:WebView 内の Browser Logs SDK が生成するログを受信します。デフォルト NO、enableCustomLog とは独立しています。Web 側では引き続きログ SDK の初期化が必要です。WebView ログ を参照してください。
enableCustomLog BOOL いいえ カスタム log をアップロードするかどうか。デフォルト NO
printCustomLogToConsole BOOL いいえ カスタムログをコンソールに出力するかどうかを設定します。デフォルト NO、カスタムログの出力フォーマット
logLevelFilter NSArray いいえ レベルログのフィルタを設定します。デフォルトでは設定しません。例:1. Info と Error レベルのログを収集する場合は @[@(FTStatusInfo),@(FTStatusError)] または @[@0,@1] を設定します;2. 収集するログレベルにカスタムレベルを含める場合、例えば "customLevel" と Error を収集する場合は @[@"customLevel",@(FTStatusError)] を設定します。SDK 1.5.16 以上のバージョンでカスタムレベルのフィルタをサポートします。
enableLinkRumData BOOL いいえ RUM データと関連付けるかどうか。デフォルト NO
globalContext NSDictionary いいえ log のカスタムタグを追加します。追加ルールはこちらを参照してください。
logCacheLimitCount int いいえ ローカルキャッシュの最大ログエントリ数制限 [1000,)。ログが多くなるほどディスクキャッシュの負荷が大きくなります。デフォルト 5000
discardType FTLogCacheDiscard いいえ ログが上限に達した後のログ破棄ルールを設定します。デフォルト FTDiscard。FTDiscard はログデータ数が最大値(5000)を超えた場合に追記データを破棄します;FTDiscardOldest はログデータが最大値を超えた場合に古いデータを破棄します。
サンプリングレートパラメータの命名

SDK 1.6.8 以降では logSamplingRate の使用を推奨します。値は 0~100 のパーセントで、小数をサポートします。無効な値(範囲外、NaN、無限大)は元の設定を上書きしません。旧 sampleRate / samplerate は整数パーセントのみをサポートし、非推奨としてマークされており、将来のバージョンで削除される可能性があります。旧 getter で小数のサンプリングレートを読み取ると、整数部分が返されます。

リモートサンプリングフィールドの単位と優先順位はリモート設定フィールドを参照してください。

Logger ログ出力

SDK の初期化時に Log 設定 で enableCustomLog を設定すると、カスタムログの追加が可能になります。

現時点ではログ内容は 30 KB に制限されており、超過した文字部分は切り捨てられます。

使用方法

//
//  FTLogger.h
//  GuanceSDK
/// info レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
-(void)info:(NSString *)content property:(nullable NSDictionary *)property;

/// warning レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
-(void)warning:(NSString *)content property:(nullable NSDictionary *)property;

/// error レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
-(void)error:(NSString *)content  property:(nullable NSDictionary *)property;

/// critical レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
-(void)critical:(NSString *)content property:(nullable NSDictionary *)property;

/// ok レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
-(void)ok:(NSString *)content property:(nullable NSDictionary *)property;

/// カスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - status: ログのステータスレベル
///   - property: カスタム属性(オプション)
- (void)log:(NSString *)content status:(NSString *)status property:(nullable NSDictionary *)property;
open class FTLogger : NSObject, FTLoggerProtocol {}
public protocol FTLoggerProtocol : NSObjectProtocol {
/// info レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
optional func info(_ content: String, property: [AnyHashable : Any]?)

/// warning レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
optional func warning(_ content: String, property: [AnyHashable : Any]?)

/// error レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
optional func error(_ content: String, property: [AnyHashable : Any]?)

/// critical レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
optional func critical(_ content: String, property: [AnyHashable : Any]?)

/// ok レベルのカスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - property: カスタム属性(オプション)
optional func ok(_ content: String, property: [AnyHashable : Any]?)

/// カスタムログを追加
/// - Parameters:
///   - content: ログ内容
///   - status: ログのステータスレベル
///   - property: カスタム属性(オプション)
optional func log(_ content: String, status: String, property: [AnyHashable : Any]?)
}

ログレベル

///イベントのレベルとステータス、デフォルト:FTStatusInfo
typedef NS_ENUM(NSInteger, FTLogStatus) {
    /// 情報
    FTStatusInfo         = 0,
    /// 警告
    FTStatusWarning,
    /// エラー
    FTStatusError,
    /// 重大
    FTStatusCritical,
    /// 復旧
    FTStatusOk,
};
///イベントのレベルとステータス、デフォルト:FTStatusInfo
public enum FTLogStatus : Int, @unchecked Sendable {
    /// 情報
    case statusInfo = 0
    /// 警告
    case statusWarning = 1
    /// エラー
    case statusError = 2
    /// 重大
    case statusCritical = 3
    /// 復旧
    case statusOk = 4
}

コード例

// SDK の初期化に成功していない場合、カスタムログの追加は失敗します
[[FTLogger sharedInstance] info:@"test" property:@{@"custom_key":@"custom_value"}];
// SDK の初期化に成功していない場合、カスタムログの追加は失敗します
FTLogger.shared().info("contentStr", property: ["custom_key":"custom_value"])

カスタムログをコンソールに出力

printCustomLogToConsole = YES を設定してカスタムログのコンソール出力を有効にすると、Xcode のデバッグコンソールに次の形式のログが表示されます:

iOS/tvOS:

2023-06-29 13:47:56.960021+0800 App[64731:44595791] [IOS APP] [INFO] content ,{K=V,...,Kn=Vn}

macOS:

2023-06-29 13:47:56.960021+0800 App[64731:44595791] [MACOS APP] [INFO] content ,{K=V,...,Kn=Vn}

2023-06-29 13:47:56.960021+0800 App[64731:44595791]:os_log ログ出力の標準プレフィックス;

[IOS APP] / [MACOS APP]:SDK がカスタムログを出力する際の識別用プレフィックス。SDK は実行プラットフォームに応じてプレフィックスを選択します:

[INFO]:カスタムログのレベル;

content:カスタムログの内容;

{K=V,...,Kn=Vn}:カスタム属性。

フィードバック

このページは役に立ちましたか?