콘텐츠로 이동

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 Session, View, Action을 연결할지 여부.
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);

단일 Log 콘텐츠에는 최대 30 KiB의 UTF-8 데이터가 유지되며, 초과분은 문자 경계에서 잘립니다. 속성에는 Token, 인증 Header, 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));
}

문서 평가

이 페이지가 도움이 되었나요?