Skip to main content
Wings includes a built-in diagnostics command that collects system information, configuration details, and logs for troubleshooting.

Diagnostics Command

Usage

Description: Collects and reports information about the Wings instance to assist in debugging. Source: cmd/diagnostics.go:45-60

Command Flags

Available Flags: Source: cmd/diagnostics.go:56-57

Interactive Prompts

Configuration Questions

When running diagnostics, you’ll be prompted:
Source: cmd/diagnostics.go:70-87

Collected Information

Version Information

Includes:
  • Wings version
  • Docker version
  • Kernel version
  • Operating system
Source: cmd/diagnostics.go:98-109

Wings Configuration

Configuration Details:
  • Panel location (redacted by default)
  • API host and port
  • SSL configuration
  • SFTP configuration
  • Directory paths
  • System username
  • Current server time
  • Debug mode status
Source: cmd/diagnostics.go:111-134

Docker Information

Docker Details:
Includes:
  • Server version
  • Storage driver and status
  • System status
  • Logging driver
  • Cgroup driver
  • System warnings
Source: cmd/diagnostics.go:136-159, 210-224

Running Containers

Output: Standard docker ps output showing all running containers Source: cmd/diagnostics.go:161-166

Wings Logs

Default Lines: 200 (configurable with --log-lines) Location: {LogDirectory}/wings.log Source: cmd/diagnostics.go:169-181

Sensitive Data Redaction

Redaction Function

Source: cmd/diagnostics.go:253-258

Auto-Redaction

If endpoints are excluded, the following are automatically redacted:
Redacted Fields:
  • Panel location
  • API host
  • SSL certificate path
  • SSL key path
  • SFTP address
Source: cmd/diagnostics.go:183-192

Report Output

Report Format

Source: cmd/diagnostics.go:98-181, 260-263

Uploading Reports

Hastebin Upload

Process:
  1. POST report content to {hastebin}/documents
  2. Parse JSON response for document key
  3. Return shareable URL: {hastebin}/{key}
Source: cmd/diagnostics.go:226-251

Upload Confirmation

Source: cmd/diagnostics.go:198-207

Example Usage

Basic Diagnostics

Prompts:

Custom Configuration

Review Before Upload

If you choose to review:

Troubleshooting Use Cases

Docker Issues

The diagnostics report helps identify:
  • Docker version incompatibilities
  • Storage driver problems
  • Cgroup driver misconfigurations
  • Container networking issues

Configuration Problems

Review:
  • Incorrect directory paths
  • SSL certificate issues
  • SFTP configuration errors
  • Panel connection problems

Performance Issues

Examine:
  • Running container count
  • System resource usage
  • Docker warnings
  • Recent error logs

Installation Failures

Check:
  • Docker image pull failures
  • Network connectivity
  • System permissions
  • Available disk space

Security Considerations

Sensitive Information

Diagnostics may contain:
  • Server hostnames/IPs
  • File paths
  • Configuration values
  • Recent log entries
  • Error messages with details

Best Practices

  1. Review Before Sharing
    • Always review output before uploading
    • Redact endpoints when possible
    • Remove any sensitive log entries manually
  2. Exclude Logs if Necessary
    • Answer “No” to include logs prompt
    • Manually review log content first
    • Consider sharing partial logs
  3. Use Private Paste Services
    • Self-hosted hastebin instances
    • Password-protected pastes
    • Expiring links
  4. Limit Distribution
    • Only share with trusted support staff
    • Delete reports after issue resolution
    • Use private support channels

Output Headers

Header Format

Sections:
  • Versions
  • Wings Configuration
  • Docker: Info
  • Docker: Running Containers
  • Latest Wings Logs
Source: cmd/diagnostics.go:260-263