Debugging Settings¶

Enable diagnostic tools and logging for troubleshooting system issues.

Debugging Settings provide advanced diagnostic capabilities for troubleshooting problems and understanding system behavior. These tools should normally be disabled but can be activated when investigating issues.

Navigation: Settings → Debugging

Overview¶

Debugging features include:

Application logging (to varying detail levels)
Telemetry and diagnostics
OTLP (OpenTelemetry) integration
Performance profiling
Network request logging
Database query logging

Debug Mode¶

Enable Debug Mode¶

Turns on verbose logging throughout the system:

SQL queries logged
API requests/responses logged
Authentication events logged
Detailed error messages
Browser console messages

To enable: 1. Settings → Debugging 2. Toggle Debug Mode: On 3. Refresh browser (F5) 4. Save

To disable: 1. Toggle Debug Mode: Off 2. Refresh browser 3. Save

⚠️ Warning: Debug mode degrades performance and increases log volume. Disable when done troubleshooting.

Logging Level¶

Controls verbosity of logged information:

TRACE - Most verbose -every operation logged - Use only for deep troubleshooting - Creates very large logs - Significant performance impact

DEBUG - Detailed diagnostic information - Helps understand program flow - Recommended for troubleshooting - Moderate performance impact

INFORMATION (Default) - Normal operational logging - Key events and state changes - Minimal performance impact - Balance of detail and performance

WARNING - Only problems and warnings - Minimal logging - Fastest performance - May miss diagnostic details

ERROR - Only errors logged - Minimal logging - Fastest performance - May miss important warnings

CRITICAL - Only critical failures - Very sparse logging - Best performance - May not capture important context

To set logging level: 1. Settings → Debugging 2. Find Logging Level 3. Select level from dropdown 4. Save 5. Restart register or refresh browser

Diagnostics & Telemetry¶

Diagnostics Collection¶

Enable Diagnostics

Collects system diagnostic data
Includes performance metrics
Sent to Kensium support portal
Helps identify issues

What is collected: - Application crashes and errors - Performance measurements - Feature usage statistics - System configuration (anonymized)

Privacy note: Diagnostic data does NOT include transaction data or personal information.

To enable/disable: 1. Settings → Debugging 2. Toggle Enable Diagnostics 3. Save

Telemetry¶

Enable Telemetry

Collects usage information
Helps improve the product
Optional -can be disabled

What is collected: - Features used - Usage patterns - Error frequency - Performance statistics

To configure: 1. Settings → Debugging 2. Find Telemetry Options 3. Check/uncheck what to collect 4. Save

OTLP Integration (OpenTelemetry)¶

What is OTLP?¶

OpenTelemetry Protocol (OTLP) is a standard for sending diagnostic data to external monitoring systems.

Used for: - Advanced monitoring - Performance analysis - Distributed tracing - Integration with APM tools

Configuring OTLP¶

OTLP Endpoint URL

The address of your OTLP collector:

Example: http://otel-collector.company.com:4317
Must be accessible from register
Requires network connectivity to monitoring server

To configure: 1. Settings → Debugging 2. Find OTLP Configuration 3. Enter Endpoint URL 4. Enter API Key (if required) 5. Save

OTLP Headers

Custom headers sent with OTLP requests:

Authentication headers
Custom metadata
Example: Authorization: Bearer token123

OTLP Data Sent¶

When OTLP is enabled, the system sends:

Traces - Request flow and timing
Metrics - Performance measurements
Logs - Application events

Disabling OTLP¶

To disable OTLP:

Settings → Debugging
Clear Endpoint URL field
Save
System stops sending OTLP data immediately

Note: Disabling does not affect local logging.

Network Debugging¶

Request/Response Logging¶

Enable Network Logging

Logs all HTTP requests and responses
Includes headers and body data (large volume)
Creates very large log files
Use sparingly

To enable: 1. Settings → Debugging 2. Toggle Network Logging 3. Save 4. Refresh browser

API Request Filtering¶

Log Only Specific Endpoints

Reduce log volume by logging specific API paths:

Example: /api/sales/* (only sales API calls)
Helpful when investigating specific feature

To configure: 1. Settings → Debugging 2. Find API Filter 3. Enter API path pattern 4. Save

Database Debugging¶

Query Logging¶

Enable Database Query Logging

Logs all SQL queries executed
Includes query parameters and execution time
Large volume of data
Performance impact

To enable: 1. Settings → Debugging 2. Toggle Query Logging 3. Save 4. Restart register

Slow Query Threshold¶

Log Queries Slower Than (ms)

Queries taking longer than threshold are logged
Helps identify performance issues
Default: 1000ms (1 second)

To adjust: 1. Settings → Debugging 2. Find Slow Query Threshold 3. Enter milliseconds 4. Save

Performance Profiling¶

Enable Profiling¶

Captures detailed performance data:

CPU usage per function
Memory allocation
Call stack traces
Timing analysis

To enable: 1. Settings → Debugging 2. Toggle Enable Profiling 3. Save 4. Restart register

Caution: Profiling has significant performance impact. Disable when done.

Profiling Output¶

Results saved to:

Local file system (if local storage)
Cloud storage (if S3 configured)
Available for download and analysis

Accessing Logs¶

Log Locations¶

Browser Console

Press F12 to open Developer Tools
Click Console tab
All client-side logs displayed

Server Logs

Location depends on server deployment
Ask IT for log file location
Typically /var/log/kensium/ or similar

Download Logs

Settings → Debugging
Click Download Logs
Compressed file with all logs
Email to support if needed

Log Retention¶

How Long Logs Kept

Recent logs: 7 days (current)
Archived logs: 90 days (older)
Very old logs: Deleted

To access archived logs: - Use Download Logs to get full history - Or contact IT for archived log access

Sending Diagnostics to Support¶

Create Diagnostics Bundle¶

When contacting Kensium support:

Settings → Debugging
Click Create Support Bundle
Wait for bundle to generate (may take a minute)
Download the bundle file
Attach to support ticket

Support bundle includes: - Recent logs - System configuration - Diagnostic settings - Error messages - Performance data

Uploading to Support Portal¶

Go to Kensium Support Portal
Create new support ticket
Attach diagnostics bundle
Describe the issue
Submit ticket

Debugging Best Practices¶

✅ Enable debug features only when needed
✅ Disable when troubleshooting is complete
✅ Don't leave debug mode on in production
✅ Monitor log file sizes (they grow quickly)
✅ Archive and delete old logs periodically
✅ Use appropriate logging level
✅ Document what you're debugging

Troubleshooting¶

Debug Mode Slows System¶

Expected -disable when not troubleshooting
Reduce logging level from TRACE to DEBUG
Disable network logging if enabled

Logs Growing Too Large¶

Logs may fill disk space
Reduce logging level
Delete archived logs
Ask IT to compress/archive

OTLP Not Connecting¶

Verify endpoint URL is correct
Check firewall allows outbound HTTPS
Verify API key if required
Check OTLP collector is running
Review server logs for connection errors

Can't Find Specific Error¶

Adjust logging level to DEBUG or TRACE
Reproduce the issue with logging enabled
Search logs for error message
Check system events/audit logs