1 Report an issue

By default, the SDK logs and stacks traces of the integration calls in the phone’s
internal storage. These logs are useful to troubleshoot the integration
issues.

1.1 Enable the debug mode

However, in addition to this default logs, you can enable measurement logging,
also calle debug mode, which is helpful for debugging the service performance
issues. This can be done in two way :

1.1.1 On NAO Cloud

The debug mode can be enabled for a selected apikey. However, it does mean
that the debug mode is automatically activated for all applications that load the
service with this apikey. This can be done by following the instructions
below.

1. Log on to NAO Cloud and select the concerned site
2. Go to the left side menu and click on Developer
3. Scroll down the items list to API key
4. In the bottom right corner of the screen, click on Advanced to display
   the options
5. Click on activate the debug mode.

Warning : Always ask Pole Star before enabling this feature. This mode can
saturate the storage, DO NOT enable it on production API key, as it could have
a detrimental effect on your users’ experience.

1.1.2 Calling start/stop logging API in the App

An alternative way to enable the measurement logging is to invoke the methods exposed
by the API. This implements a couple of methods : startLoggingMeasurements
and stopLoggingMeasurements which allow to start and stop the measurement
logging respectively.

To start and stop logging the debug measurements, use code similar to the
following.

On iOS 

[NAOServicesConfig startLoggingMeasurements];
...
[NAOServicesConfig stopLoggingMeasurements];
...
[NAOServicesConfig uploadNAOLogInfo];

On Android 

NAOServicesConfig.startLoggingMeasurements();
...
NAOServicesConfig.stopLoggingMeasurements();
...
NAOServicesConfig.uploadNAOLogInfo();

1.2 Upload the debug measurement logs

In both the above cases, the debug measurement logs can be retrieved
manually from the phone (Android only), or sent to NAO Cloud through
the NAOServicesConfig.uploadNAOLogInfo() API. However :

• when uploadNAOLogInfo(…) is called, the SDK will upload all
  necessary files to NAO Cloud, making them available to Pole Star for
  analysis.

• it is highly recommended to implement this issue reporting method
  in order to quickly address issues. Note that a NAO Service must
  already be started for the call to be successful.
• DO NOT implement a systematic call to this API, but rather
  implement a button to trigger upload. This button can be hidden
  so that only the persons testing the application can use it to send
  additional information when needed.
• Note : this feature does not work with private server.