Skip to main content

Logs

Logs are essential for monitoring your NuNet Appliance, troubleshooting issues, and understanding what's happening with your deployments. The NuNet Appliance provides access to different types of logs, each serving a specific purpose.

Types of Logs​

DMS Logs​

DMS logs are the logs from the Device Management Service (DMS) that provide detailed information about what is happening within the DMS itself. These logs are very low-level and contain technical information about:

  • DMS service operations and processes
  • Network connectivity and peer connections
  • Capability management and UCAN token operations
  • Orchestration and scheduling activities
  • Internal system events and errors
  • Performance metrics and resource management

DMS logs are primarily needed for troubleshooting technical issues with the DMS service itself. They help diagnose problems with:

  • Network connectivity issues
  • Capability and permission problems
  • Orchestration failures
  • Service crashes or unexpected behavior
  • Performance degradation

These logs are typically used by advanced users and support teams when investigating complex technical problems. They contain detailed diagnostic information that can help identify the root cause of issues.

Application Logs​

Application logs are the logs from the applications you have deployed or are trying to deploy. These logs show what is happening within your deployed applications and containers. You can monitor:

  • Application startup and initialization
  • Runtime behavior and execution flow
  • Application-specific errors and exceptions
  • Output from your application (stdout/stderr)
  • Container execution status
  • Application performance and resource usage

Application logs are essential for understanding how your deployed workloads are performing. They help you:

  • Debug application-specific issues
  • Monitor application health and status
  • Track application output and results
  • Identify errors within your deployed code
  • Verify that applications are running correctly

These logs are particularly useful when troubleshooting deployment issues, as they show what's happening inside your containers and applications rather than at the infrastructure level.

Appliance Logs​

Appliance logs are logs specific to the NuNet Appliance itself. These logs contain information about:

  • Appliance initialization and startup
  • VirtualBox integration and VM operations
  • Appliance system services
  • Dashboard operations and user interactions
  • Appliance configuration changes
  • System-level events and errors

Appliance logs help you understand what's happening at the appliance level, separate from the DMS or deployed applications. They are useful for:

  • Troubleshooting appliance startup issues
  • Understanding appliance configuration problems
  • Diagnosing dashboard or UI-related issues
  • Monitoring appliance system health
  • Identifying appliance-specific errors

Accessing Logs​

You can access logs through the NuNet Appliance dashboard:

  1. Navigate to Logs: Go to the Logs section in your dashboard navigation
  2. Select Log Type: Choose the type of logs you want to view:
    • DMS Logs
    • Application Logs (for specific deployments)
    • Appliance Logs
  3. Filter and Search: Use filters to narrow down log entries by:
    • Time range
    • Log level (info, warning, error, debug)
    • Specific keywords or patterns
    • Deployment or service name

Copying and Sharing Logs for Troubleshooting​

When you encounter issues and need help, you'll often need to share logs with the support team or community. Here's how to copy and share logs effectively:

How to Copy Logs​

  1. Select Log Entries

    • Navigate to the logs you need to share
    • Select the relevant log entries by:
      • Clicking and dragging to select text
      • Using keyboard shortcuts (Cmd+C / Ctrl+C)
      • Using the "Copy" button if available in the log viewer

  2. Copy Full Log Sections

    • For comprehensive troubleshooting, copy entire log sections
    • Include log entries from before the issue occurred
    • Include entries during and after the issue
    • Copy at least 50-100 lines of context around errors

  3. Copy Multiple Log Types

    • If the issue spans multiple systems, copy relevant sections from:
      • DMS logs (for infrastructure issues)
      • Application logs (for deployment issues)
      • Appliance logs (for appliance-specific issues)

Best Practices for Sharing Logs​

When sharing logs for troubleshooting:

  1. Include Context

    • Provide a brief description of what you were trying to do
    • Mention when the issue occurred
    • Include any error messages you see in the UI

  2. Share Relevant Time Periods

    • Include logs from the time period when the issue occurred
    • Don't share logs that are too old or unrelated
    • Focus on the timeframe around the problem

  3. Sanitize Sensitive Information

    • Remove or redact any sensitive information such as:
      • API keys or tokens
      • Passwords or credentials
      • Personal information
      • Private IP addresses (if sharing publicly)
    • Replace sensitive data with placeholders like [REDACTED] or [API_KEY]

  4. Use Proper Formatting

    • When sharing in forums or support tickets:
      • Use code blocks or markdown formatting
      • Preserve log formatting and timestamps
      • Don't modify or edit log content

  5. Include System Information

    • Along with logs, provide:
      • Appliance version
      • DMS version
      • Operating system
      • Deployment configuration (if relevant)

Where to Share Logs​

You can share logs through:

  1. Support Channels

    • Technical support tickets
    • GitLab issues (for bug reports)
    • See Support Process for details

  2. Community Forums

    • Community discussion forums
    • Discord or other community channels
    • Remember to sanitize sensitive information

  3. Bug Reports

    • When reporting bugs, include relevant logs
    • Follow the Support Process guidelines

Log Management Tips​

Regular Monitoring​

  • Check Logs Regularly: Monitor logs periodically to catch issues early
  • Set Up Alerts: If possible, configure alerts for critical errors
  • Review Application Logs: Regularly check application logs to ensure deployments are running correctly

Log Retention​

  • Understand Retention Policies: Be aware of how long logs are retained
  • Export Important Logs: Save important log sections before they expire
  • Archive Troubleshooting Logs: Keep logs from resolved issues for reference

Performance Considerations​

  • Filter Logs Efficiently: Use filters to reduce log volume when searching
  • Focus on Errors: Prioritize error and warning level logs for troubleshooting
  • Avoid Excessive Logging: Be mindful of log volume in your applications