https://github.com/donfuxx/logkitten

LogKitten is an Android Library with a logcat monitoring service that shows notifications with logcat information for app crashes or errors of the app. Available at JitPack.io 🐱
https://github.com/donfuxx/logkitten

android android-library crashes debug debugging jitpack logcat logging-library monitor notifications qa qatools tester testing testing-tools

Last synced: 11 months ago
JSON representation

LogKitten is an Android Library with a logcat monitoring service that shows notifications with logcat information for app crashes or errors of the app. Available at JitPack.io 🐱

• Host: GitHub
• URL: https://github.com/donfuxx/logkitten
• Owner: donfuxx
• License: apache-2.0
• Created: 2018-08-10T07:06:44.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-21T18:38:13.000Z (over 7 years ago)
• Last Synced: 2025-07-13T03:44:49.948Z (11 months ago)
• Topics: android, android-library, crashes, debug, debugging, jitpack, logcat, logging-library, monitor, notifications, qa, qatools, tester, testing, testing-tools
• Language: Java
• Homepage: https://jitpack.io/#donfuxx/LogKitten
• Size: 1.6 MB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# LogKitten   [![](https://jitpack.io/v/donfuxx/LogKitten.svg)](https://jitpack.io/#donfuxx/LogKitten)

LogKitten is an **Android library module** that can be added to your Android project for example as a `debugImplementation` to make inspecting the logcat on the device easier in the following ways:

 - The LogKitten Service will be **started by clicking the "LogKitten" launcher icon** and it will monitor your app's logcat for Error and Warning level logs and will show them as notifications.

LogKitten notifications | Notification expanded | LogKitten settings | LogKitten full logs

------------ | ------------- | ------------ | -------------

![LogKitten notifications](https://github.com/donfuxx/LogKitten/blob/master/media/logkitten-screenshot-1.png?raw=true)|![Notification expanded](https://github.com/donfuxx/LogKitten/blob/master/media/logkitten-screenshot-2.png?raw=true)|![LogKitten settings](https://github.com/donfuxx/LogKitten/blob/master/media/logkitten-screenshot-3.png?raw=true)|![LogKitten full logs](https://github.com/donfuxx/LogKitten/blob/master/media/logkitten-screenshot-4.png?raw=true)

 

 - Logs can be shared by clicking the **share action** in a LogKitten notification. This is a handy tool if you have Testers for your project that want to forward crash logcats to the developers or a bugtracking system like Jira etc.

 - LogKitten service can be **stopped anytime**, by clicking the "Stop" action in the Service notification.

 - LogKitten service can be **restarted anytime** by clicking the "LogKitten" launcher icon.

 - It is recommended to include LogKitten **only in debug builds**, but not in your production release build. LogKitten is useful for developers and testers, but pretty useless for real users of your app.

![logkitten_ic_launcher-web](https://user-images.githubusercontent.com/8261416/44672957-04be7200-aa22-11e8-987d-bdc8c51d3f29.png)

## Setup Guide

### Step 1. Add the JitPack repository to your build file

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

    	allprojects {

    		repositories {

    			...

    			maven { url 'https://jitpack.io' }

    		}

    	}

### Step 2. Add the debug dependency

Add it in your app module gradle dependencies. It is recommended to use `debugImplementation`

    	dependencies {

    	        debugImplementation 'com.github.donfuxx:LogKitten:1.2.2'

    	}