Game > Gamebase > Android SDK User Guide > Logger

This document describes how to use Log & Crash Search API.

Initialize

Initialize NHN Cloud Logger SDK with appkey issued from Log & Crash Search.
To send crash logs, without a miss, occurring immediately with app execution, NHN Cloud Logger must be initialized from Application.onCreate().

API

+ (void)initialize(Context context, LoggerConfiguration configuration);

Example

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        // Initialize TOAST Logger
        final String LOG_AND_CRASH_APPKEY = "AaBbCcDdEeFfGgHh";
        final boolean sendCrashLog = true;
        final LoggerConfiguration.Builder configBuilder = LoggerConfiguration.newBuilder(
                LOG_AND_CRASH_APPKEY, sendCrashLog);
        Gamebase.Logger.initialize(context, configBuilder.build());
    }
}

Send Logs

Send logs to Log & Crash Server. NHN Cloud Logger SDK provides the following five level of logs to send:

  • DEBUG
  • INFO
  • WARN
  • ERROR
  • FATAL

Log levels are as follows:

  • DEBUG > INFO > WARN > ERROR > FATAL

API

+ (void)debug(String message);
+ (void)info(String message);
+ (void)warn(String message);
+ (void)error(String message);
+ (void)fatal(String message);

+ (void)debug(String message, Map<String, String> userFields);
+ (void)info(String message, Map<String, String> userFields);
+ (void)warn(String message, Map<String, String> userFields);
+ (void)error(String message, Map<String, String> userFields);
+ (void)fatal(String message, Map<String, String> userFields);

+ (void)debug(String format, Object... args);
+ (void)info(String format, Object... args);
+ (void)warn(String format, Object... args);
+ (void)error(String format, Object... args);
+ (void)fatal(String format, Object... args);

Example

// Default
Gamebase.Logger.debug("Message", userField);

// With userFields
final Map<String, String> userField = new HashMap<>();
userField.put("KEY", "VALUE");
Gamebase.Logger.debug("Message", userField);

// Formatted string
final String val1 = "myValue1";
final String val2 = "maValue2";
Gamebase.Logger.debug("VALUE1: %s, VALUE2: %s", val1, val2);

Set User-Defined Fields

Set the user-defined fields you need.

With user-defined field setting, set values are delivered to a server along with logs, every time send logs API is called.

API

+ (void)setUserField(String field, Object value);

Example

Gamebase.Logger.setUserField("KEY", "VALUE");

Further Tasks after Sending Logs

With the listener registered, further tasks can be executed after log is sent.

API

+ (void)setLoggerListener(LoggerListener listener);

Example

Gamebase.Logger.setLoggerListener(new LoggerListener() {
    @Override
    public void onSuccess(@NotNull LogEntry logEntry) {
        // Sending logs succeeded
    }

    @Override
    public void onFilter(@NotNull LogEntry logEntry, @NotNull LogFilter logFilter) {
        // The logs were filtered out and not sent.
    }

    @Override
    public void onSave(@NotNull LogEntry logEntry) {
        // If log transmission fails due to network disconnection, the log is saved in a file for log retransmission.(The saved file cannot be checked.)
    }

    @Override
    public void onError(@NotNull LogEntry logEntry, @NotNull GamebaseException exception) {
        // Sending logs failed
    }
});

Use Handled Exception API

On the Android platform, you can send exception-related content in the try/catch syntax using NHN Cloud Logger's Handled Exception API. The exception logs you sent can be viewed in the console by clicking Log & Crash Search > App Crash Search and clicking Handled under Error Type. For more information on how to use the Log & Crash Search console, Console User Guide.

API

+ (void)report(String message, Throwable throwable);
+ (void)report(String message, Throwable throwable, Map<String, String> userFields);

Example

try {
    // User Codes...
} catch (Exception e) {
    final Map<String, Object> userFields = new HashMap<>();
    userField.put("KEY", "VALUE");
    Gamebase.Logger.report("message", e, userFields);
}
Table of Contents
TOP