smart-fun/LogFilter

Simple Android library which filters Logs, for example by keeping only ERROR LOGS in RELEASE MODE

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.smart-fun:LogFilter:1.0.4'
	}

	dependencies {
		implementation("com.github.smart-fun:LogFilter:1.0.4")
	}

	<dependency>
	    <groupId>com.github.smart-fun</groupId>
	    <artifactId>LogFilter</artifactId>
	    <version>1.0.4</version>
	</dependency>


                            
    libraryDependencies += "com.github.smart-fun" % "LogFilter" % "1.0.4"


                            
    :dependencies [[com.github.smart-fun/LogFilter "1.0.4"]]

Readme

Log Filter

Log Filter is a helper to set the Log Level of your App, for example setting VERBOSE in Debug mode and ERROR in Release mode. This way you see all the logs when debugging, but only the errors in release.

Usage

You need to initialize and keep a reference to the logger in your Application class

public class MainApplication extends Application {

    private Log mLog;

    @Override
    public void onCreate() {
        super.onCreate();

        if (BuildConfig.DEBUG) {
            mLog = new Log(Log.Priority.VERBOSE);
        } else {
            mLog = new Log(Log.Priority.ERROR);
        }

    }
}

Just as a reminder, to add an Application class to your app, you need to update the manifest with a android:name attribut in the application tag:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.mycompany.myapp">

    <application
        android:name=".MainApplication"
        ...

Then the usage is exactly the same as for the android Log class. You just need to replace the android.util.Log import with fr.arnaudguyon.logfilter.Log:

//import android.util.Log
import fr.arnaudguyon.logfilter.Log

public class MainActivity extends AppCompatActivity {

    private static final String TAG = "MainActivity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_main);

        Log.v(TAG, "VERBOSE TEST");
        Log.d(TAG, "DEBUG TEST");
        Log.i(TAG, "INFO TEST");
        Log.w(TAG, "WARNING TEST");
        Log.e(TAG, "ERROR TEST");

    }
}

That's it.

Installation with gradle

Add the following maven{} line to your PROJECT build.gradle file

allprojects {
    repositories {
        jcenter()
        maven { url "https://jitpack.io" }    // add this line
    }
}

Add the libary dependency to your APP build.gradle file

dependencies {
    compile 'com.github.smart-fun:LogFilter:1.0.3'    // add this line
}

##License##

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.