Avaya Client SDK

< Back to Package Overview

Troubleshooting and Debugging

Diagnostic Logging

The Avaya SDK provides access to diagnostic events using 4 logging levels:

  • ERROR
  • WARNING
  • INFO
  • DEBUG

Choose a log level using the setLogLevel() method of the Client object.

mClient.setLogLevel(Client.LogLevel.DEBUG);

By default logs are written in the logcat window of Android Studio.

Note: More information on using logcat can be found in the Google Developer documentation.

Implementing custom diagnostic logging behavior

To implement your own logging behavior first implement the Client.LogListener interface and override the onLogMessage() method.

class YourLogHandler implements Client.LogListener
{
    @Override
    public void onLogMessage(Client.LogLevel level, String tag, String msg) 
    {
        // Implement your own custom logging behavior here
    }
}

Then instantiate your log handler and assign it to your client instance.

YourLogHandler yourLogHandler = new YourLogHandler();
mClient.setLogListener(yourLogHandler);

Crash Reporting

Since crash reporting applies to the application as a whole Client SDK does not include any crash reporting support of its own, leaving this to the OS or application to implement. When reporting a crash in Client SDK code there are a few things to be aware:

Client SDK includes native code and by default the system will only capture a limited stack trace for native crashes, so including a native crash reporter in your application is strongly recommended. Some third party crash reporting services include this support in their libraries, or you can use Google Breakpad. If a native code crash is encountered, please include a native code crash report with your support request.

Google Analytics

Client SDK may optionally be configured to use Google Analytics to collect, process, and store activities of application users, to track feature usage and improve the quality of Client SDK. Google Analytics data collection is disabled by default, and the end user must specifically opt-in for the collection of analytics. Analytics data collected about Client SDK is available to Avaya Employees only, and cannot be shared with third party developers or end users.

To enable Google Analytics within Client SDK requires the Google Analytics Terms and Conditions to be met.

You will give end users proper notice about the use of Google Analytics for the collection of quality improvement metrics for the Avaya Communications Package when it is enabled in your application. You must either get consent from the end user to enable Google Analytics, or provide them with the opportunity to opt-out of analytics collection.

Source

Complying with the Google Analytics Terms of Service

Client SDK complies with the Google Terms of Service where possible. As Client SDK is a component within your application and does not interact with end users directly, Client SDK cannot fully meet the Google Analytics Terms and Conditions. To enable Google Analytics within Client SDK, your application meet the following condition:

You will give end users proper notice about the use of Google Analytics for the collection of quality improvement metrics for the Avaya Communications Package when it is enabled in your application. You must either get consent from the end user to enable Google Analytics, or provide them with the opportunity to opt-out of analytics collection.

Source