Diagnostic Bundle
Overview
The Diagnostic Bundle feature allows administrators to generate a sanitized support package containing system information, configuration summaries, logs, and troubleshooting data from a OneDB installation.
Diagnostic Bundles are primarily used for:
- Troubleshooting production issues
- Investigating listener or API connectivity problems
- Reviewing cluster health
- Analyzing application errors
- Assisting OneDB Support during incident investigations
To protect sensitive information, OneDB automatically masks or excludes confidential values before generating the bundle.
Sensitive values such as passwords, secrets, keys, and protected configuration data are never included in plain text.
Accessing Diagnostic Bundle
Navigate to:
Operations → Diagnostic Bundle
The Diagnostic Bundle page allows administrators to select the information that should be included in the generated package.
Advanced
Designed for deeper troubleshooting and complex investigations.
In addition to the Basic preset, it may include:
- Application Logs
- Listener Traffic Logs
- API Traffic Logs
- Listener Error Logs
- API Error Logs
- Thread Dumps
- Optional Health Snapshots
This preset provides more detailed diagnostics and is typically requested by OneDB Support during advanced analysis.
Log Range
The Log Range setting controls how much historical log data is included.
Available options:
| Option | Description |
|---|---|
| Last 1 hour | Collect logs generated during the previous hour |
| Last 6 hours | Collect logs generated during the previous six hours |
| Last 24 hours | Collect logs generated during the previous day |
| Last 7 days | Collect logs generated during the previous week |
Selecting a larger range increases the bundle size and generation time.
Core Information
The following information can be included in a diagnostic bundle.
Appliance Information
Provides information about the underlying OneDB appliance, including:
- Hostname
- Operating system
- Runtime environment
- Network information
- Appliance version
Application Information
Provides details about the running OneDB application, including:
- Application version
- Build information
- Runtime status
- Service metadata
License Summary
Provides a summary of the currently installed license, including:
- License type
- Product edition
- Expiration status
- Licensed features
Database Connection Summary
Includes non-sensitive information about configured database connections.
Examples:
- Connection names
- Database types
- Connection status
- Configuration summaries
Passwords and secrets are excluded.
Listener Status
Provides information about configured listeners, including:
- Listener ports
- Current status
- Runtime availability
Cluster Status
Provides cluster-related information, including:
- Cluster nodes
- Node status
- Heartbeat status
- Replication health
Cache Status
Includes information about internal OneDB caches.
Useful for:
- Troubleshooting synchronization issues
- Verifying cache reload operations
- Diagnosing configuration propagation problems
Site Configuration Summary
Provides a sanitized summary of selected site-wide configuration settings.
Sensitive values are masked automatically.
Logs and Diagnostics
Recent Error Logs
Includes recent application errors that may help identify failures or unexpected behavior.
Recent Application Logs
Includes standard application activity logs.
Useful when troubleshooting:
- Startup issues
- Configuration problems
- Runtime exceptions
Listener Traffic Logs
Includes listener-related traffic diagnostics.
Useful for:
- Database connectivity investigations
- Traffic flow verification
- Protocol troubleshooting
Listener Error Logs
Includes listener-specific error events and failures.
API Traffic Logs
Includes diagnostic information collected through the OneDB API channel.
Useful for:
- API troubleshooting
- Authentication analysis
- Integration investigations
API Error Logs
Includes API-specific error events and exception details.
Audit Summary
Provides a summary of audit activity captured by OneDB.
May include:
- Query audit statistics
- Security events
- Protection rule actions
- Monitoring information
Sensitive data remains protected.
Advanced Options
Target Database Health Snapshot
Performs lightweight read-only health checks against configured target databases.
Typical information may include:
- Connectivity validation
- Database availability
- Response checks
- Runtime status indicators
No data modifications are performed.
Thread Dump
Captures Java thread information from the running OneDB application.
This option is intended for advanced troubleshooting and may assist in diagnosing:
- Application hangs
- Deadlocks
- High CPU usage
- Thread contention issues
Thread dumps are generally collected only when requested by OneDB Support.
Traffic Log Verbosity
Diagnostic Bundle generation supports configurable verbosity levels for:
- Listener Traffic Logs
- API Traffic Logs
Higher verbosity levels provide additional diagnostic information but may increase bundle size.
These options are typically enabled only during detailed troubleshooting sessions.
Generating a Diagnostic Bundle
- Open Operations → Diagnostic Bundle
- Select a preset (Basic or Advanced)
- Choose the desired Log Range
- Review or customize the selected components
- Enable any required advanced options
- Click Generate Diagnostic Bundle
OneDB will generate a downloadable diagnostic package that can be securely shared with support personnel for analysis.
Security Considerations
Diagnostic Bundles are designed with security in mind.
Before generating the package, OneDB automatically:
- Masks sensitive values
- Excludes passwords and secrets
- Removes protected configuration details
- Sanitizes diagnostic outputs where applicable
Administrators should still review organizational security policies before sharing diagnostic bundles externally.
Diagnostic Bundles are intended for troubleshooting purposes only and should be shared only with authorized personnel or trusted support providers.
