コンテンツにスキップ

Log 設定

Windows SDK の Log は、独立した永続キューを使用して Logging Intake に送信されます。C# と Native C/C++ は、サンプリング、レベルフィルター、RUM 関連付け、キューのセマンティクスを共有します。アプリケーションが Log API を明示的に呼び出して書き込んだビジネスログのみが、この送信パイプラインに入ります。

Log 初期化設定

GuanceSdk.Init(new GuanceConfig
{
    DatawayUrl = "https://openway.guance.com",
    ClientToken = "<client-token>",
    RumAppId = "<rum-app-id>",
    Logging = new LogConfig
    {
        EnableCustomLog = true,
        EnableLinkRumData = true,
        SamplingRate = 100, // NuGet 0.1.0-alpha.8 以降でサポート
        LevelFilters = new[]
        {
            LogStatus.Info,
            LogStatus.Warning,
            LogStatus.Error,
            LogStatus.Critical
        },
        GlobalContext = new Dictionary<string, object?>
        {
            ["component"] = "desktop-ui"
        }
    }
});

C# パラメーター

パラメーター デフォルト値 説明
EnableCustomLog false カスタム Log を受け付けるかどうか。有効でない場合、AddLog() はキューに追加されません。
EnableLinkRumData false 現在の RUM セッション、ビュー、アクションに関連付けるかどうか。
SamplingRate(NuGet 0.1.0-alpha.8 以降) 100 Log の独立サンプリング率(%)。範囲は 0~100 で、小数をサポートします。
SampleRate(非推奨) 1 0~1 の単位のままです。SamplingRate を使用してください。
LevelFilters null 収集を許可する標準 Log レベル。null はレベルによるフィルタリングを行いません。
GlobalContext 空のディクショナリ 各 Log に追加されるグローバル属性。
DiscardStrategy DiscardNew キューが満杯の場合、新しいデータまたは最も古いデータを破棄します。
guance_log_property global_context[] = {
    {"component", "native-ui"}
};

guance_log_config_v2 logging;
guance_log_config_v2_init(&logging);
logging.enable_custom_log = 1;
logging.enable_link_rum_data = 1;
logging.sampling_rate = 100.0f; // vcpkg 0.1.0-alpha.9 以降でサポート
logging.level_filter_mask =
    GUANCE_LOG_INFO |
    GUANCE_LOG_WARNING |
    GUANCE_LOG_ERROR |
    GUANCE_LOG_CRITICAL;
logging.global_context = global_context;
logging.global_context_count = 1;

if (!guance_log_configure_v2(rum, &logging)) {
    // 設定が無効なため、Log は有効になりません。
}

Native C/C++ パラメーター

すべてのバージョン付き構造体では、先に guance_log_config_v2_init() を呼び出す必要があります。

フィールド デフォルト値 説明
enable_custom_log 0 カスタム Log を受け付けるかどうか。
enable_link_rum_data 0 現在の RUM コンテキストに関連付けるかどうか。
sampling_rate(vcpkg 0.1.0-alpha.9 以降) 100 Log の独立サンプリング率(%)。範囲は 0~100 で、小数をサポートします。
旧構造体 sample_rate(非推奨) 1 0~1 の単位のままです。v2 設定の sampling_rate を使用してください。
level_filter_mask 0 標準レベルのビットマスク。0 は標準レベルとカスタムステータスを受け入れます。
global_context NULL guance_log_property の配列。設定時に文字列がコピーされます。
global_context_count 0 グローバル属性の数。最大 1024。
discard_strategy GUANCE_LOG_DISCARD_NEW キューが満杯の場合、新しいデータまたは最も古いデータを破棄します。

Log、RUM、Session Replay は SDK のディスクキャッシュ上限を共有します。キャッシュ容量、ファイル数、バッチサイズは、SDK 初期化 で一括して設定します。

同じ .NET 設定で SamplingRate と SampleRate の両方が設定されている場合、SamplingRate が優先されます。

Logger ログ出力

サポートされる標準ステータスは、debug、info、warning、error、critical、ok です。

GuanceSdk.AddLog(
    "saved settings",
    LogStatus.Info,
    new Dictionary<string, object?>
    {
        ["operation"] = "save"
    });

GuanceSdk.AddLogs(new[]
{
    new LogEntry("first", LogStatus.Info),
    new LogEntry("second", "audit")
});
guance_log_property properties[] = {
    {"operation", "save"}
};

guance_log_add(
    rum,
    "saved settings",
    "info",
    properties,
    1);

guance_log_entry entries[] = {
    {"first", "info", nullptr, 0},
    {"second", "audit", nullptr, 0}
};
const int accepted = guance_log_add_batch(rum, entries, 2);

1 件の Log の内容は最大 30 KiB の UTF-8 データが保持され、超過分は文字境界で切り捨てられます。属性には、Token、認証ヘッダー、Cookie、ユーザーの機密情報を含めないでください。

RUM 関連付け

Log の RUM 関連付けを有効にすると、SDK は現在の session_id、view_id、action_id を Log に書き込みます。関連付けには Log 書き込み時点のアクティブなコンテキストのみが使用され、既にキューに追加されたデータが遡って変更されることはありません。

キューと診断

Log と RUM は、独立したキューとアップロードカウンターを使用します。Flush と通常のシャットダウンでは、両方のキューが同時に処理されます。

var diagnostics = GuanceSdk.GetLogDiagnosticsSnapshot();
Console.WriteLine(
    $"enqueued={diagnostics.LogsEnqueued}, " +
    $"droppedByConfig={diagnostics.LogsDroppedByConfiguration}, " +
    $"droppedBySampling={diagnostics.LogsDroppedBySampling}, " +
    $"droppedByLevel={diagnostics.LogsDroppedByLevel}, " +
    $"droppedByCapacity={diagnostics.LogsDroppedByCapacity}, " +
    $"uploaded={diagnostics.UploadSuccessCount}, " +
    $"lastError={diagnostics.LastUploadError}");
guance_log_diagnostics diagnostics;
guance_log_diagnostics_init(&diagnostics);
if (guance_log_get_diagnostics(rum, &diagnostics)) {
    printf("enqueued=%lld dropped=%lld uploaded=%lld\n",
        static_cast<long long>(diagnostics.logs_enqueued),
        static_cast<long long>(diagnostics.logs_dropped),
        static_cast<long long>(diagnostics.upload_success_count));
}

フィードバック

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