/EvTrack

[Android Library] Make event and exception tracking like a piece of cake

Primary LanguageJavaApache License 2.0Apache-2.0

EvTrack

Specs

Download API

Show some ❤️

GitHub stars GitHub forks GitHub watchers GitHub followers Twitter Follow

Event & Exception tracking made easy.

Based of EasyDeviceInfo lib and okhttp.

Including in your project

EvTrack is available in the Jcenter, so getting it as simple as adding it as a dependency

compile 'com.github.nisrulz:evtrack:{latest version}'

where {latest version} corresponds to published version in Download

#Usage

  • Create an instance of the EvTrack class
EvTrack evTrack = new EvTrack();
  • Next if in debug stage, enable logs
evTrack.enableLogs();
  • To record an event, pass in an ArrayMap to recordEvent() function
ArrayMap<String, String> event_params = new ArrayMap<String,String>();
event_params.put("key1", "value1");
event_params.put("key2", "value2");
..
event_params.put("key7", "value7");
evTrack.recordEvent(event_params, SERVER, httpCallback);
  • To record an exception, pass in an ArrayMap to recordException() function
ArrayMap<String, String> exp_param = new ArrayMap<String,String>();
exp_param.put("key1", "value1");
exp_param.put("key2", "value2");
..
exp_param.put("key7", "value7");
evTrack.recordException(e, exp_param, SERVER , httpCallback);
  • Implement the Callback
private final Callback httpCallback = new Callback() {
       @Override
       public void onFailure(Request request, IOException e) {
           Log.e(LOGTAG, "Req Failed : " + e.getLocalizedMessage());
       }

       @Override
       public void onResponse(Response response) throws IOException {
           Log.i(LOGTAG, "Req Successful : " + String.valueOf(response.code()));
       }
   };

Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:

  1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
  2. If its a feature, bugfix, or anything please only change code to what you specify.
  3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
  4. Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.
  5. Check for existing issues first, before filing an issue.
  6. Have fun!

Created & Maintained By

Nishant Srivastava (@nisrulz)

If you found this library helpful or you learned something from the source code and want to thank me, consider buying me a cup of

License

Copyright 2016 Nishant Srivastava

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.