Set Up Logs
Structured logs allow you to send, view and query logs sent from your applications within Sentry.
With Sentry Structured Logs, you can send text-based log information from your applications to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual attributes.
Logs for Android are supported in Sentry Android SDK version 8.12.0 and above.
To enable logging, you need to initialize the SDK with the logs.enabled option set to true.
AndroidManifest.xml<meta-data android:name="io.sentry.logs.enabled" android:value="true" />
Once the feature is enabled on the SDK and the SDK is initialized, you can send logs using the Sentry.logger() APIs.
The Sentry.logger() namespace exposes six methods that you can use to log messages at different log levels: trace, debug, info, warn, error, and fatal.
These properties will be sent to Sentry, and can be searched from within the Logs UI, and even added to the Logs views as a dedicated column.
import io.sentry.Sentry;
Sentry.logger().info("A simple log message");
Sentry.logger().error("A %s log message", "formatted");
For more advanced use cases, like attaching custom attributes, use the Sentry.logger().log() methods:
import io.sentry.Sentry;
import io.sentry.SentryAttribute;
import io.sentry.SentryAttributes;
import io.sentry.SentryLogLevel;
import io.sentry.logger.SentryLogParameters;
Sentry.logger().log(
SentryLogLevel.FATAL,
SentryLogParameters.create(
SentryAttributes.of(
SentryAttribute.stringAttribute("my.string-attribute", "some-value"),
SentryAttribute.booleanAttribute("my.bool-attribute", true),
SentryAttribute.integerAttribute("my.int-attribute", 42),
SentryAttribute.doubleAttribute("my.double-attribute", 3.12),
SentryAttribute.named("my.attribute", new Point(1, 2))
)
),
"log message %s",
"param1"
);
The Android SDK automatically adds the SentryTimberIntegration if the sentry-android-timber dependency was found on the classpath. The integration is added with minLogsLevel set to INFO.
If you want to customize these levels, please have a look at Timber docs.
If you are not using our Gradle plugin, please have a look at Timber docs.
This snippet captures an intentional error, so you can test that logs are working as soon as you set it up:
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import java.lang.Exception
import timber.log.Timber
class MyActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
try {
throw Exception("This is a test.")
} catch (e: Exception) {
Timber.e(e)
}
}
}
The Sentry Android Gradle Plugin automatically captures Logcat logs of level WARNING or higher.
If you would like to change the minimum level, please have a look at Logcat docs.
This snippet captures an intentional error, so you can test that everything is working once you've set it up:
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import io.sentry.Sentry
import android.util.Log
class MyActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
Log.w("MyTag", "Warning message.")
Sentry.captureException(Exception("My Exception"))
}
}
To filter logs, or update them before they are sent to Sentry, you can use the getLogs().beforeSend option.
import io.sentry.SentryLevel;
import io.sentry.android.core.SentryAndroid;
import android.app.Application;
public class MyApplication extends Application {
public void onCreate() {
super.onCreate();
SentryAndroid.init(this, options -> {
options.setDsn("https://examplePublicKey@o0.ingest.sentry.io/0");
options.getLogs().setBeforeSend((logEvent) -> {
// Modify the event here:
logEvent.setBody("new message body");
return logEvent;
});
});
}
}
The beforeSend function receives a log object, and should return the log object if you want it to be sent to Sentry, or null if you want to discard it.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").