ipfs/kubo

enhance 'ipfs diag sys' output

Open

#7,458 opened on Jun 10, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (2,725 forks)batch import
P3exp/novicehelp wantedkind/enhancementstatus/acceptedstatus/ready

Repository metrics

Stars
 (13,906 stars)
PR merge metrics
 (Avg merge 4d 2h) (28 merged PRs in 30d)

Description

We like to extend the ipfs diag sys output to include more system information than just the platform, architecture, and the go version.

Currently, a typical output looks like this:

{
  "diskinfo": {
    "free_space": 18522890240,
    "fstype": "2435016766",
    "total_space": 14918279168
  },
  "environment": {
    "GOPATH": "",
    "IPFS_PATH": ""
  },
  "ipfs_commit": "",
  "ipfs_version": "0.6.0-dev",
  "memory": {
    "swap": 15964000,
    "virt": 5207176000
  },
  "net": {
    "interface_addresses": [
      "/ip4/127.0.0.1",
      "/ip4/192.168.8.2",
      "/ip6/::1",
      "/ip6/fe80::8c71:2b0e:6947:3090"
    ],
    "online": true
  },
  "runtime": {
    "arch": "amd64",
    "compiler": "gc",
    "gomaxprocs": 4,
    "numcpu": 4,
    "numgoroutines": 1864,
    "os": "linux",
    "version": "go1.14.4"
  }
}

@Stebalien likes to remove the interface_addresses from the output.

I like to add some more information, like those commands provide:

Linux:
uname -a; grep -Hv "^#" /etc/*release
BSD:
uname -a; uname -K
MacOS:
uname -a; sw_vers

This idea was discussed earlier in the PR https://github.com/ipfs/go-ipfs/pull/7408

Contributor guide

Research direction
Look at the current implementation of 'ipfs diag sys' command in the go ipfs codebase. Identify where system information is collected (likely in the diagnostics package). Then, implement additional system info retrieval following the examples given for Linux, BSD, and MacOS. Consider removing interface addresses as suggested by @Stebalien. Reference the earlier PR (#7408) for more context.
Tech stack
go
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60