Log

Understanding

Using the log feature provided by the STOVE SDK, you can collect and analyze players' in-game behavior and key events.
The collected data is sent to the STOVE platform's analytics system, and based on it the game operator can assess content status, measure event effectiveness, detect anomalous metrics, and more.
Logs support both Mobile (Android/iOS) and PC, and the provision method differs by platform.

Log Types

Provision Method by Platform

Development

Mobile — Setting the External Identifier (setExternalId)

The STOVE Mobile SDK automatically collects core logs inside the platform. For cross-analysis purposes, it provides the Log.setExternalId() interface so you can include an externally managed identifier (e.g., an MMP user ID) in log events. (Log v2.8.2 or higher) After the call, the external identifier is automatically attached to all subsequent logs.

Prerequisites

• You must finish setting the external identifier by calling Log.setExternalId() before calling Auth.initialize(). If you call it after initialization, some early logs won't include the identifier.
• The external-identifier value is issued and managed by the game/service. The SDK doesn't validate it separately.
• The external identifier is set globally in the SDK and persists per process.

Development Flow

1. Secure the external identifier: prepare the external-identifier value issued by the game/service. (e.g., an MMP user ID)
2. Call Log.setExternalId(externalId): set the identifier before calling Auth.initialize().
3. Proceed with auth initialization: from Auth.initialize() onward, proceed with the normal auth/log flow as-is, and the external identifier is automatically included in the logs that occur.

Troubleshooting

Sample Code

string externalId = "external-id-12345";
Log.SetExternalId(externalId);

PC (PCSDK)

Prerequisites

• Log transmission is possible only after you initialize the LogSDK (Log_Initialize) once BaseSDK initialization (Base_Initialize) completes. Calling Log_Initialize() before BaseSDK initialization finishes fails initialization.
• Base_RunCallback() must be called periodically in the game loop for the log-transmission result callback to work correctly.
• For cleanup, clean up the LogSDK with Log_UnInitialize(), then clean up BaseSDK with Base_UnInitialize().
• The LogSDK provides two log-related functions: transmission and version lookup, namely Log_Send / Log_GetVersion. User attributes, flush, debug mode, etc. are Mobile-SDK-only; on PC, the game includes them directly in the log item and sends them.

Development Flow

1. Initialization: You can send logs only after initializing the LogSDK (Log_Initialize()) once BaseSDK initialization (Base_Initialize()) completes.
2. Log transmission: Set metadata such as game version and server code, plus additional data (a contents JSON string), in the log-item parameter (StovePCLogSendParam), and send the log (Log_Send()).
3. Result handling: Verify success via the result object in the callback. On failure, branch by error code.
4. Cleanup: Right before the game exits, clean up the LogSDK with Log_UnInitialize(), then clean up BaseSDK with Base_UnInitialize().

Troubleshooting

Sample Code

// Legacy C/C++ API (~3.4.x)
#include "LogSDK.h"

using namespace Stove::PCSDK;
using namespace Stove::PCSDK::Base;
using namespace Stove::PCSDK::Log;

// 1) Initialization (after Base_Initialize completes)
auto initResult = Log_Initialize();
if (!initResult.IsSuccessful())
{
    // Implement the logic for initialization failure.
    return;
}

// 2) Send an event log
StovePCLogSendParam param;
// All fields are optional, so fill in only the values you need for your game.
param.SetGameVersion(L"1.0.0");
param.SetServerCd(L"Server01");
param.SetContents(L"{\"level\":42,\"class\":\"warrior\"}");

Log_Send(&param, [](CallbackResult callbackResult)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Implement the logic for a successful send.
    }
    else
    {
        // Implement the failure logic (retry/logging, etc.).
    }
});

// 3) Cleanup on exit
Log_UnInitialize();
// Then call Base_UnInitialize

Frequently Asked Questions