Repository files navigation

⚠️Repository Archived

This SDK has been rebranded fromInstabug toLuciq.

The new repo can be foundhere →

This repository is no longer maintained.You can also check out ourMigration Guide for more detailed information about how to migrate to the new SDK.

Instabug is an in-app feedback and bug reporting tool for mobile apps. With just a simple shake, your users or beta testers canreport bugs or send in-app feedback and the SDK will capture an environment snapshot of your user's device including all console logs,server-side network requests and bug reproduction steps compiling all these details in one organised dashboard to help you debug and fix bugs faster.

Instabug also provides you with areliable crash reporter that automatically captures a detailed report of the running environment, the different threads’ states,the steps to reproduce the crash, and the network request logs. All the data is captured automatically with no need for breadcrumbs, and you can alwaysreply back to your users and they will receive your messages within the app.

For more info, visitInstabug.com.

Add this line to your build.gradle file.

implementation'com.instabug.library:instabug:<latest-version>'

In yourApplication class add this line to youronCreate method.

Java

newInstabug.Builder(this,"APP_TOKEN").build();

Kotlin

Instabug.Builder(this,"APP_TOKEN").build()

Some permissions are automatically added to your AndroidManifest.xml file. Some of them are required to be able to fetch some information like the network and wifi connection. Others are used to allow the user to attach images, videos, and audio recordings.

Generally, the permission request doesn't appear unless the user attempts to use any of the features requiring the permission. The only exception, if you set the invocation event to be Screenshot. Then, the storage permission will be requested when the application launches.

This behavior is happening with the screenshot invocation because there isn't any native event that tells the SDK that a screenshot has been captured. The only way to do it is to monitor the screenshots directory. The SDK is invoked once a screenshot is added to the directory while the application is active.

<uses-permissionandroid:name=“android.permission.ACCESS_NETWORK_STATE” /><uses-permissionandroid:name=“android.permission.WRITE_EXTERNAL_STORAGE” /><uses-permissionandroid:name=“android.permission.READ_EXTERNAL_STORAGE” /><uses-permissionandroid:name=“android.permission.ACCESS_WIFI_STATE” /><uses-permissionandroid:name=“android.permission.RECORD_AUDIO” /><uses-permissionandroid:name=“android.permission.MODIFY_AUDIO_SETTINGS” />

You can remove any of the permissions if you are not willing to use the feature associated with it as in the following example.

<uses-permissionandroid:name=“android.permission.WRITE_EXTERNAL_STORAGE”tools:node=“remove”/>

You can also check out ourAPI Reference for more detailed information about our SDK.