Scrolls is a simple logging library that allows writing to a local file.
Features:
- Specify one or multiple log destinations
- Log to a local file
- Browse log files and their content in an included viewer
- Share the log files via the system share intent
- Compress log files into a zip before sharing to reduce the transfer time and size
- Clean up old log files on a regular bases
Scrolls is easily configurable and can be used in conjunction with other logging libraries, like for example as a sub-Tree of the Timber library.
- Add the Scrolls dependency declaration to your module's
build.gradlefile, to the dependencies enclosure:
dependencies {
// ..
implementation "mobi.lab.scrolls:scrolls:X.Y.Z"// ..
}The artifact is available in Maven Central
repositories {
...
mavenCentral()
...
}NOTE: Before the Scrolls moved to Maven Central it used to have a different group id - "lab.mobi.scrolls". If you are migrating from there then be sure to update the group id!
Replace the "X.Y.Z" part with the latest version of the library, available versions are visible at https://mvnrepository.com/artifact/lab.mobi.scrolls/scrolls.
- Update you application manifest, add Activity and Provider declarations:
<?xml version="1.0" encoding="utf-8"?>
<manifest package="sample.application"
xmlns:android="http://schemas.android.com/apk/res/android">
<application>
<activity
android:name="mobi.lab.scrolls.activity.LogListActivity"
android:label="Logs"
android:taskAffinity="sample.application.loglist"
android:theme="@style/AppTheme">
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
</intent-filter>
</activity>
<activity
android:name="mobi.lab.scrolls.activity.LogPostActivity"
android:process=".LogPostProcess"
android:theme="@style/AppTheme"/>
<activity
android:name="mobi.lab.scrolls.activity.LogReaderActivity"
android:theme="@style/AppTheme"/>
<provider
android:name="mobi.lab.scrolls.ScrollsFileProvider"
android:authorities="${applicationId}.logs"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/file_provider_paths"/>
</provider>
</application>
</manifest>
Notes:
LogListActivitycreates a newLoglauncher icon to show logs@style/AppThemestyles the activities to better match the consuming application
Scrolls is now moved to AndroidX. If you include it to a brand new project then you may get a compile error about conflicting pre- and post-AndroidX dependencies. To solve this make sure Jetifier is turned on from gradle.properties:
android.useAndroidX=true
# ..android.enableJetifier=true/* * 1. Most basic usage is as follows: * Set the implementation to use. * Needs to be done only once, do it from your launch class or Application object. */Log.setImplementation(LogImplCat.class); /* * Get a new instance to use and use the current class name as a log tag. * Also allows to supply a simple String as a tag to use. */Loglog = Log.getInstance(this);
/* * Start logging. */log.v("This is a verbose message.");
log.i("This is an info message.");
log.d("This is a debug message.");
log.w("This is a warning message.");
log.e("This is an error message.");
log.wtf("This is an assert message.");
// You can also log Throwable objectstry {
thrownewIOException("1 2 3 test"); } catch(IOExceptione) {
log.e(e, "This is an error message with a stack trace.");
}
// And you can use String.format style argumentslog.d("This is a debug line about a user %s %s.", "Cheradenine", "Zakalwe");
/* * 2. In case you want to use more than one log implementation at a time you can use LogImplComposite class. * Some log implementations need you to call init() on them first before usage. * Let's call init for a classes called LogImplFile and LogImplComposite. *//* * Init LogImplFile by giving the directory to store log files in. * (Needs to be done only once) */LogImplFile.init(getFilesDir());
/* * Init LogImplComposite by giving it two actual log implementations to use, the LogCat one and the File one * (Needs to be done only once) */LogImplComposite.init(newClass[] {LogImplCat.class, LogImplFile.class});
/* * Now we are ready to set the overall log implementation as the LogImplComposite class * (Needs to be done only once) */Log.setImplementation(LogImplComposite.class);
/* * Get a new instance and log like always. */Loglog = Log.getInstance(this);
log.d("This is a debug message.");/* Configure posting to backend giving the project name */LogPostImpl.configure(this, BuildConfig.APPLICATION_ID + ".logs"/** Provider **/);
/* * Get a new LogPostBuilder instance. * The builder object has several methods for configuring parameters. */LogPostBuilderbuilder = newLogPostBuilder();
builder.addTags("my","first","post"); // Sample method to configure tags for the post/* * Do the actual post by starting log posting activity. */builder.launchActivity(context);To build the library and the sample app use the following command
./gradlew buildAllReleaseAfter the build the Scrolls library *.aar and the sample application *.apk can be found under scrolls-android\scrolls-lib\build\outputs folder.
Please see RELEASE_GUIDE.md
- Scrolls on GitHub: https://github.com/MobiSolutions/scrolls-android
- Sonatype OSSRH Nexus UI: https://s01.oss.sonatype.org
- Scrolls artifacts on Maven Central: https://repo1.maven.org/maven2/mobi/lab/scrolls/scrolls/ (can take some time)
- Scrolls artifacts on Sonatype OSSRH: https://s01.oss.sonatype.org/content/groups/public/mobi/lab/scrolls/scrolls/ (available right away after publishing)
- Original Sonatype OSSRH JIRA issue: https://issues.sonatype.org/browse/OSSRH-66630
- Can be used to add user access
- Project access Wiki: https://confluence.lab.mobi/display/DEV/Sonatype+Maven+Access+Credentials
- Codemagic CI: https://codemagic.io/apps
- OSSRH guide: https://central.sonatype.org/publish/publish-guide/