TimberLorry


Source link: https://github.com/Drivemode/TimberLorry

TimberLorry

Periodical log collector framework.


Photo Licensed under CC BY-NC 2.0 by jbdodane

Usage

In your Application, initialize TimberLorry with configuration on your preference. After this, you can schedule periodical log collection.

public class TimberLorryApplication extends Application {

  @Override
  public void onCreate() {

super.onCreate();

TimberLorry.initialize(new Config.Builder()

  .collectIn(10) // collect log data every 10 seconds.

  .serializeWith(new GsonSerializer())

  .addOutlet(new LogcatOutlet()).build(this));

TimberLorry.getInstance().schedule();

  
}
 
}

How TimberLorry works

TimberLorry is a log collector without data loss for some reasons(e.g. reboot, exit application). TimberLorry will store logs in the buffer(internal database by default), and periodically send it to an endpoint. If no internet connection available, the periodical work will not executed.

Building Blocks

TimberLorry has some gateways to customize payloads, serialization logic, and buffer storage, and log endpoint. All customization will be injected with Config object.

Custom Payload

Payload is an entity object containing log data. The following snippet shows an example code.

public class ButtonClick implements Payload {

  private final long timeInMillis;

public ButtonClick(long timeInMillis) {

this.timeInMillis = timeInMillis;
  
}
 
}

Payloads will be serialized by Serializer in the buffer.

Custom Serializer

You can add your own serializer.

Here is an example using Gson.

public class GsonSerializer implements Serializer {

  @Override
  public String serialize(Payload payload) {

return new Gson().toJson(payload);

  
}
 
}

We have this GsonSerializer in plug project.

Custom BufferResolver

If you would like to use another log data storage(e.g. internal storage, shared preferences), you can implement your own BufferResolver.

public class SharedPrefBufferResolver extends AbstractBufferResolver {

  private final Application application;

public SharedPrefBufferResolver(Application application, @NonNull AccountManager accountManager, @NonNull ContentResolver resolver, Account account) {

super(accountManager, resolver, account);

this.application = application;
  
}

@Override
  public void save(Serializer serializer, Payload payload) {

Record record = new Record(payload.getClass(), serializer.serialize(payload));

// ... write record on the preference.
  
}

@Override
  public void save(Serializer serializer, Payload... payloads) {

for (Payload payload : payloads) {

 Record record = new Record(payload.getClass(), serializer.serialize(payload));

 SharedPreferences pref = SharedPreferences.getDefaultSharedPreferences(application);

 // ... write record on the preference.

}

  
}

@Override
  public List<Record> fetch() {

List<Record> records = new ArrayList<>();

SharedPreferences pref = SharedPreferences.getDefaultSharedPreferences(application);

// ... find records on the preference and convert them to Record.

return records;
  
}

@Override
  public void remove(Record record) {

SharedPreferences pref = SharedPreferences.getDefaultSharedPreferences(application);

// ... find record on the preference and remove it.
  
}

@Override
  public void clear() {

SharedPreferences pref = SharedPreferences.getDefaultSharedPreferences(application);

pref.edit().clear().apply();

  
}
 
}

Custom Log Endpoint

You can add log endpoint with custom Outlet. If you want to filter Payload in your Outlet, check the Payload class information in Outlet#accept(Class<?>) and return true if you accept the Payload in this Outlet.

public class LogcatOutlet implements Outlet {

  public static final String TAG = LogcatOutlet.class.getSimpleName();

/** 
  * {
@inheritDoc
}
 
  */
  @Override
  public boolean accept(Class<?> payload) {

return true; // every payload is logged with this outlet
  
}

/** 
  * {
@inheritDoc
}
 
  */
  @Override
  public Result dispatch(String payload) {

// do thread blocking work here :)

// if something went wrong here, catch the exception here and envelope it into Result object to return.

Utils.logV(payload);

return Result.success();

  
}

@Override
  public String name() {

return "LogCat";
  
}
 
}

Plugins

We have some customizations in "plug" project as plugin by default. Currently in "plug" project, following plugins are provided.

Download

Via Gradle

dependencies {

  compile 'com.drivemode:TimberLorry:1.0.0@aar'
  compile 'com.drivemode:TimberLorry-Plug:1.0.0@aar' // this is an optional 
}

License

Copyright (C) 2015 Drivemode, Inc. All rights reserved.  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. 

Resources

Show image as a popup on a click event or any event. Simply set the image as drawable and thats it! And also you can set width, height & background color as you want.

The app is mostly based on using the Text too speech. Basically the app mimics the behaviour of a bingo caller person. The user will be able to play bingo in an organized manner, knowing every chip played and awarding the winner players.

ChipView helps you in creating attractive [Chips] for your application. ChipView provides you a flexible way of creating and organizing your chip by following ways:

  • Adding a background or text color to your chip
  • Creating custom layout for your chip
  • Can even create multi color chips

Simple View Behavior for Android CoordinatorLayout.

Simple library for fast right-left list item swiping.

A simple way to convert any model to multipart.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes