Integration Logging Guide for Developers

This guide helps you, as a developer installing UXCam, to enable and interpret integration logs when setting up the SDK. It walks you through configuring logging, understanding key log messages, and troubleshooting upload issues.

When you integrate our SDK, sessions and data are recorded and uploaded automatically. If uploads fail (e.g., video/data/session issues), having detailed integration logs helps you and our Support/CS teams diagnose and resolve problems quickly.

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Success

Negative potential consequences of an action.

Enabling & Disabling Logs

Simply set to true the configuration parameter as such:

UXCam.enableIntegrationLogging(true);

Key Log Levels & Tags

All messages are prefixed with UXCam and categorized by level:

INFO: Normal operational messages

WARNING: Recoverable issues or state changes

ERROR: Failures requiring attention

Refer to the tables below for important messages you’ll see.

Important Logs During Startup

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Success

Negative potential consequences of an action.

Level	Tag	Message	When
INFO	UXCam	Integration log enabled	On enabling logging
INFO	UXCam	Session Verification for Application key initiated with Request Parameters: `{…}`	After `start(with:)`
ERROR	UXCam: Verify	Session Verification for app key failed due to missing parameters.	If required fields are missing
ERROR	UXCam: Verify	Session Verification for app key failed with response: `{error_response}`	On server error response
INFO	UXCam: Verify	Session Verification for app key succeeded	On success
WARNING	UXCam: Session	Session await upload remained: 1	After verification if un-uploaded sessions
INFO	UXCam: Session	Started uploading session.	Upload begins
ERROR	UXCam: Session	Session upload failed with reason: New session await upload remained: X	On upload failure (timeout/network/etc.)
INFO	UXCam: Session	Session upload success: New session await upload remained: 0	On upload success
INFO	UXCam: Recording	Session and Screen Recording has started	After a new session has been created

File‑Type Upload Logs

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Success

Negative potential consequences of an action.

Level	Tag	Message	When
ERROR	UXCam: Session Upload	FileType upload has failed with reason and time. Host: `{host_response}`	Video/DataFile/Icon/Background upload failure
INFO	UXCam: Session Upload	FileType upload has succeeded in `{elapsed_time}`. Host: `{host_response}`	On individual file upload success

Session & Screen Recording Events

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Success

Negative potential consequences of an action.

Level	Tag	Message	When
WARNING	UXCam: Session	Session has paused due to `{reason}`	Manual pause / app background / crash
INFO	UXCam: Session	Session has resumed	App foreground / manual resume
WARNING	UXCam: Session	Session has stopped	Session ended or app background
INFO	UXCam: Screen Recording	Screen Recording has started at `{time}`	After session start
WARNING	UXCam: Screen Recording	Screen Recording has paused at `{time}` with `{reason}`	Manual pause / background / crash
INFO	UXCam: Screen Recording	Screen Recording has resumed at `{time}` with `{reason}`	Resume after pause
WARNING	UXCam: Screen Recording	Screen Recording has stopped due to `{reason}`	StopSession / background / manual stop
ERROR	UXCam: Screen Recording	Screen Recording has failed at `{time}` with `{reason}`	Technical errors (filter/write/encrypt/etc.)

Configuration Toggles

When you enable configurations, you'll see:

INFO UXCam  [ConfigurationName] has been enabled.

enableMultiSessionRecord()
enableCrashHandling()
enableAutomaticScreenNameTagging()
enableAdvancedGestureRecognition()
enableImprovedScreenCapture()
enableNetworkLogging()
occlusion()
environment()

User & Event Logs

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Success

Negative potential consequences of an action.

Level	Tag	Message
INFO	UXCam: UserProperties	User properties have been updated: `{…}`
INFO	UXCam: Event	Event recorded: `{event_properties}`
INFO	UXCam: Occlusion	Occlusion set on `{view/screenName}`
INFO	UXCam: Occlusion	Occlusion removed on `{view/screenName}`

Troubleshooting Tips

No logs appearing?
- Confirm logging is enabled (API or launch argument).
- Check console filters in your IDE.
Verification failed?
- Verify your appKey and SDK version match the dashboard.
- Ensure network connectivity and firewall allow SDK requests.
Uploads stuck or failing?
- Inspect Session await upload remained warnings.
- Check individual file-type errors for more details.
Still stuck?
Gather full log output and share with Support/CS for deeper analysis.