cmd/doctor: doctor command to help bug report etc

[Ziy1-Tan]

Issue number: #1803

Description

The following file will be created:

• cmd/doctor.go
• cmd/doctor_test.go

Features

It collects and displays info from multiple dimensions such as the running environment and system logs to report bugs, etc.

• System info collection: support collection of os, architecture, hardware, juicefs version, etc.
• Syslog collection: support automatic search for log location and filter logs according to the maximum number of records
• Pprof metric collection: Goroutine stack information, CPU performance statistics, memory allocation statistics, etc.
• Mount point config collection: support specifying mount point to obtain the config (filter sensitive info)
• Mount command collection: Collect juicefs mount commands and corresponding parameters

Use cases

$ juicefs doctor /mnt/jfs

# Result will be output to /var/log/
$ juicefs doctor --out-dir=/var/log /mnt/jfs

# Get log file up to last 1000 entries
$ juicefs doctor --out-dir=/var/log --collect-log --limit=1000 /mnt/jfs 

# Enable pprof collection
$ juicefs doctor --out-dir=/var/log --collect-log --limit=1000 --collect-pprof /mnt/jfs

How can this PR be tested?

The test files locate at cmd/doctor_test.go.

Basing the PR against the correct JuiceFS version

• This is a new feature and the PR is based against the latest JuiceFS development branch
• This is a bug fix and the PR is based against the earliest branch in which the bug can be reproduce

[CLAassistant]

All committers have signed the CLA.

[codecov-commenter]

Codecov Report

Base: 59.63% // Head: 59.13% // Decreases project coverage by -0.49% ⚠️

Coverage data is based on head (c2fdb03) compared to base (d4928e5).
Patch coverage: 17.40% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2360      +/-   ##
==========================================
- Coverage   59.63%   59.13%   -0.50%     
==========================================
  Files         138      140       +2     
  Lines       23508    24185     +677     
==========================================
+ Hits        14020    14303     +283     
- Misses       7659     8030     +371     
- Partials     1829     1852      +23     

Impacted Files	Coverage Δ
pkg/utils/utils_linux.go	0.00% <0.00%> (ø)
pkg/utils/utils_unix.go	26.31% <0.00%> (-12.15%)	⬇️
cmd/doctor.go	18.39% <18.39%> (ø)
cmd/main.go	46.32% <100.00%> (+1.24%)	⬆️
pkg/chunk/mem_cache.go	62.50% <0.00%> (-23.62%)	⬇️
pkg/chunk/disk_cache.go	75.24% <0.00%> (-3.96%)	⬇️
pkg/meta/base.go	65.37% <0.00%> (-3.43%)	⬇️
pkg/chunk/cached_store.go	73.71% <0.00%> (-2.30%)	⬇️
cmd/sync.go	55.27% <0.00%> (-1.20%)	⬇️
pkg/meta/sql.go	63.51% <0.00%> (-1.00%)	⬇️
... and 28 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
5 Code Smells

No Coverage information
0.0% Duplication