Debug Logs

With Appetize, you can capture, inspect and troubleshoot all debug log events that occurred during your app session for real-time or later analysis.

Note by default, a user needs to be authenticated to view debug logs for their app. See App Permissions for more information.

Capture Debug Logs

Debug logs are generated by your app using NSLog or Logger for iOS and Log for Android

To enable Appetize to capture all debug log events, you can choose to enable it through a query parameter or with the help of the JavaScript SDK.

With Query Parameter

Add the debug=true query parameter to your app or embed URL

&debug=true

See Query Params Reference for more information.

With JavaScript SDK

Set debug: true in the configuration e.g.

await client.config({
    debug: true,
    ...
})

See Configuration for more information.

Inspecting Debug Logs

With App Page

The app page provides a simple debug log of all the events that took place. You can access this via your app's app link

https://appetize.io/app/{appId|buildId|publicKey}?&debug=true

or by going to your Apps page, selecting the app you want to inspect, and then clicking debug on the latest build or choosing a specific build you would like to debug.

Debug logs can also be downloaded via the Download Logs action at the top right of the log viewer. This is helpful when sharing logs with developers for troubleshooting purposes.

With JavaScript SDK

You can listen for all debug log events via our JavaScript SDK. To easily view them in the browser you can print them to the console or you can store it to file for later analysis

// check debug logs
session.on('log', (data) => {
    console.log(data.message)
})

See our JavaScript API Reference for more information.

Last updated