Android Log Collection

Send logs to Datadog from your Android applications with Datadog’s dd-sdk-android client-side logging library and leverage the following features:

• Log to Datadog in JSON format natively.
• Add context and extra custom attributes to each log sent.
• Forward Java/Kotlin caught exceptions.
• Record real client IP addresses and User-Agents.
• Optimized network usage with automatic bulk posts.

Note: The dd-sdk-android library supports all Android versions from API level 19 (KitKat).

Setup

1. Add the Gradle dependency by declaring the library as a dependency in your build.gradle file:

   repositories {
       maven { url "https://dl.bintray.com/datadog/datadog-maven" }
   }
   
   dependencies {
       implementation "com.datadoghq:dd-sdk-android:x.x.x"
   }

2. Initialize the library with your application context and your Datadog client token. For security reasons, you must use a client token: you cannot use Datadog API keys to configure the dd-sdk-android library as they would be exposed client-side in the Android application APK byte code. For more information about setting up a client token, see the client token documentation:

   • Dropdown

   class SampleApplication : Application() {
       override fun onCreate() {
           super.onCreate()
   
           val config = DatadogConfig.Builder("<CLIENT_TOKEN>", "<ENVIRONMENT_NAME>", "<APPLICATION_ID>")
                           .build()
           Datadog.initialize(this, config)
       }
   }

   class SampleApplication : Application() {
       override fun onCreate() {
           super.onCreate()
   
           val config = DatadogConfig.Builder("<CLIENT_TOKEN>", "<ENVIRONMENT_NAME>", "<APPLICATION_ID>")
                           .useEUEndpoints()
                           .build()
           Datadog.initialize(this, config)
       }
   }

   There is also a utility method which gives you the current state of the SDK. You can use this to check if it was properly initialized or not:

       if(Datadog.isInitialized()){
         // your code here
       }

   When writing your application, you can enable development logs. All internal messages in the library with a priority equal or higher than the provided level are then logged to Android’s Logcat.

       Datadog.setVerbosity(Log.INFO)

3. Configure the Android Logger:

   val logger = Logger.Builder()
       .setNetworkInfoEnabled(true)
       .setLogcatLogsEnabled(true)
       .setDatadogLogsEnabled(true)
       .setBundleWithTraceEnabled(true)
       .setLoggerName("<LOGGER_NAME>")
       .build();

4. Send a custom log entry directly to Datadog with one of the following functions:

   logger.d("A debug message.")
   logger.i("Some relevant information ?")
   logger.w("An important warning…")
   logger.e("An error was met!")
   logger.wtf("What a Terrible Failure!")

   Exceptions caught can be sent with a message:

   try {
       doSomething()
   } catch (e : IOException) {
       logger.e("Error while doing something", e)
   }

   Note: All logging methods can have a throwable attached to them.

5. (Optional) - Provide a map alongside your log message to add attributes to the emitted log. Each entry of the map is added as an attribute.

   logger.i("onPageStarted", attributes = mapOf("http.url", url))

   In Java you would have:

   Logger.d(
           "onPageStarted",
           null,
           new HashMap<String, Object>() {{
               put("http.url", url);
           }}
   );

Advanced logging

Initialization

The following methods in Logger.Builder can be used when initializing the logger to send logs to Datadog:

Global configuration

Find below functions to add/remove tags and attributes to all logs sent by a given logger.

Global Tags

Add Tags

Use the addTag("<TAG_KEY>","<TAG_VALUE>") function to add tags to all logs sent by a specific logger:

// This adds a tag "build_type:debug" or "build_type:release" accordingly
logger.addTag("build_type", BuildConfig.BUILD_TYPE)

// This adds a tag "device:android"
logger.addTag("device", "android")

Note: <TAG_VALUE> must be a String.

Remove Tags

Use the removeTagsWithKey("<TAG_KEY>") function to remove tags from all logs sent by a specific logger:

// This removes any tag starting with "build_type"
logger.removeTagsWithKey("build_type")

Learn more about Datadog tags.

Global Attributes

Add attributes

By default, the following attributes are added to all logs sent by a logger:

• http.useragent and its extracted device and OS properties
• network.client.ip and its extracted geographical properties (country, city)

Use the addAttribute("<ATTRIBUTE_KEY>", "<ATTRIBUTE_VALUE>") function to add a custom attribute to all logs sent by a specific logger:

// This adds an attribute "version_code" with an integer value
logger.addAttribute("version_code", BuildConfig.VERSION_CODE)

// This adds an attribute "version_name" with a String value
logger.addAttribute("version_name", BuildConfig.VERSION_NAME)

Note: <ATTRIBUTE_VALUE> can be any primitive, String, or Date.

Remove attributes

Use the removeAttribute("<ATTRIBUTE_KEY>", "<ATTRIBUTE_VALUE>") function to remove a custom attribute from all logs sent by a specific logger:

// This removes the attribute "version_code" from all further log send.
logger.removeAttribute("version_code")

// This removes the attribute "version_name" from all further log send.
logger.removeAttribute("version_name")

Batch collection

All the logs are first stored on the local device in batches. Each batch follows the intake specification. They are sent as soon as network is available, and the battery is high enough to ensure the Datadog SDK does not impact the end user’s experience. If the network is not available while your application is in the foreground, or if an upload of data fails, the batch is kept until it can be sent successfully.

This means that even if users open your application while being offline, no data will be lost.

The data on disk will automatically be discarded if it gets too old to ensure the SDK doesn’t use too much disk space.

Further Reading

お役に立つドキュメント、リンクや記事:

dd-sdk-android Source codeGITHUB Learn how to explore your logsDOCUMENTATION