Overview
When you encounter issues with Koala Data Explorer, enabling diagnostic logs helps identify problems and collect information for support. The extension includes a built-in log viewer for easy troubleshooting.Logging may impact performance and should be disabled when not troubleshooting.
Quick Start - Log Viewer
🎯 Easiest Method:- Enable logging in VS Code settings (see below)
- Open Koala Data Explorer
- Click the “Show Debug Logs” button 📊 in the top toolbar
- Reproduce the problem while watching the logs
- Real-time updates as events happen
- Professional interface with timestamps
- Export to file for support tickets
- Clear logs to focus on current issues
When to Enable Logging
Enable logging when experiencing:- Connection Issues: Authentication failures, timeouts
- Query Problems: Execution errors, syntax issues
- Data Issues: Missing data sources, export problems
- Performance Issues: Slow queries, freezing
- General Issues: Extension crashes, unexpected behavior
How to Enable Logging
Step 1: Enable in Settings
-
Open VS Code Settings:
- Press
Ctrl+,
(Windows/Linux) orCmd+,
(Mac) - Or go to File → Preferences → Settings
- Press
- Search for “Koala Data Explorer Logging”
-
Configure settings:
- ✅ Check “Koala Data Explorer: Logging: Enabled”
- 📊 Set “Koala Data Explorer: Logging: Level” to “DEBUG”
Step 2: Use Log Viewer
- Open Koala Data Explorer
- Click “Show Debug Logs” button 📊 in toolbar
- Log viewer panel opens showing real-time information
- Reproduce the issue while monitoring logs
What to Look For
Connection Issues
Look for entries containing:[CONNECTION_MANAGER] Connection failed
[AUTH] Authentication error
- HTTP error codes:
401
,403
,500
- Network timeout messages
Query Execution Problems
Look for entries containing:[QUERY_EXECUTION] Query failed
[BIP_SERVICE] SOAP error
- SQL syntax error messages
- Permission denied errors
Error Indicators
- ERROR level entries (red text)
- WARN level entries (yellow text)
- Stack traces showing detailed error information
- HTTP status codes indicating problems
Log Levels
- ERROR: Critical problems preventing functionality
- WARN: Issues that might cause problems but don’t stop operation
- INFO: General information about extension operations
- DEBUG: Detailed diagnostic information (recommended for troubleshooting)
Collecting Logs for Support
Using the Log Viewer
- Enable logging and reproduce the problem
- In the log viewer panel:
- Click “Export Logs” to save to file
- Or select and copy relevant log entries
- Attach exported file to support email
Support Information
When contacting support, include:- What you were trying to do (step-by-step)
- What happened (exact error message or behavior)
- When it started (after update, always happening, etc.)
- Connection type (Basic Auth, OAuth PKCE, Windows SSO)
- Environment (Oracle Fusion instance details if known)
- Exported log file from the log viewer
Advanced Log Access
Extension Host Logs
For power users who need direct access:- Press
Ctrl+Shift+P
/Cmd+Shift+P
- Type “Developer: Show Logs”
- Select “Extension Host”
- Look for entries starting with
[KOALA]
Browser Console (UI Issues)
For webview-related problems:- With Koala open, press
F12
- Go to Console tab
- Set filter to Verbose
- Look for
[UI]
,[STATE]
,[BACKEND_MSG]
entries
Common Error Messages
Error Message | Meaning | Solution |
---|---|---|
”BIP catalog not found” | Required Oracle setup missing | Click “Deploy to BIP” button |
”Authentication failed” | Invalid credentials | Check username/password in connection |
”Connection timeout” | Network or server issue | Check VPN, firewall, try again later |
”Invalid SQL syntax” | Query syntax error | Review SQL in editor |
”Permission denied” | No data access | Contact Oracle admin for permissions |
”Token expired” | OAuth token needs refresh | Disconnect and reconnect |
”Row limit exceeded” | Too much data returned | Add ROWNUM or WHERE limits |
Performance Considerations
Disable When Finished
Remember to disable logging after troubleshooting:- Go to VS Code Settings
- Search for “Koala Data Explorer Logging”
- Uncheck “Koala Data Explorer: Logging: Enabled”
- This improves performance and reduces resource usage
Impact on Extension
- Debug logging: Detailed information, higher performance impact
- Info logging: General information, moderate impact
- Error logging: Only critical issues, minimal impact
- Disabled: Best performance for daily use
Getting Help
Self-Service Steps
- Use the log viewer - easiest way to see what’s happening
- Check common error messages table above
- Try basic troubleshooting (restart VS Code, check connection)
Contact Support
If you need help:- Export logs using built-in export feature
- Submit ticket at support portal
- Include logs and detailed problem description
- Response time: Typically 1-2 business days