https://github.com/jintin/clerk

Clerk is a log service to collect and display your app log on Android devices.
https://github.com/jintin/clerk

android-application logging

Last synced: 6 months ago
JSON representation

Clerk is a log service to collect and display your app log on Android devices.

• Host: GitHub
• URL: https://github.com/jintin/clerk
• Owner: Jintin
• License: mit
• Created: 2019-03-31T12:21:47.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-06-07T21:42:38.000Z (over 3 years ago)
• Last Synced: 2025-03-24T14:06:43.616Z (6 months ago)
• Topics: android-application, logging
• Language: Kotlin
• Homepage: https://jintin.github.io/Clerk/
• Size: 370 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Clerk

[![Build Status](https://travis-ci.org/Jintin/Clerk.svg?branch=master)](https://travis-ci.org/Jintin/Clerk)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/60b7174503e047ae82202081ada2d9ee)](https://app.codacy.com/app/Jintin/Clerk?utm_source=github.com&utm_medium=referral&utm_content=Jintin/Clerk&utm_campaign=Badge_Grade_Dashboard)

[![Maintainability](https://api.codeclimate.com/v1/badges/ebee76105bbc0c162fd1/maintainability)](https://codeclimate.com/github/Jintin/Clerk/maintainability)

[![Download](https://api.bintray.com/packages/jintin/maven/Clerk/images/download.svg)](https://bintray.com/jintin/maven/Clerk/_latestVersion)

Clerk is a log service to collect and display your app log on Android devices.

## Install

* Simple install by gradle dependency to your project

```groovy

implementation 'com.github.jintin:clerk:1.1'

```

* Install the agent app on [Google Play](https://play.google.com/store/apps/details?id=com.jintin.clerk) or build from `app` module.

## Usage

Clerk send log information by Android broadcast functionality. There are two ways to do that:

1. Installing the `lib` module by gradle and calling the built-in function `ClerkUtils.log()` with require parameter. You can get more information by tracing the [sample module](https://github.com/Jintin/Clerk/tree/master/sample)

2. Sending the broadcast by your own follow by the interface:

```kotlin

Intent("com.jintin.clerk.LOG_ACTION").also {

    it.putExtra("data", "your Log information")

    it.putExtra("channel", "specific channel for search (optional)")

    it.putExtra("app", "your packagename")

    it.component = ComponentName("com.jintin.clerk", "com.jintin.clerk.app.LogReceiver")

    context.sendBroadcast(it)

}

```

## Contributing

Bug reports and pull requests are welcome on GitHub at .

## License

The module is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).