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 (13,906 stars) (2,725 forks)batch import
P3exp/novicehelp wantedkind/enhancementstatus/acceptedstatus/ready

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

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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programmingBasic knowledge of IPFS and system commands
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the current implementation of `ipfs diag sys` in the repository (likely in `cmd/ipfs/diag.go`). Review the linked PR #7408 for previous discussion on removing interface addresses. The goal is to add system information such as uname output (Linux: `uname a`, MacOS: `sw vers`). Consider creating a new function to gather this info and integrate it into the diag sys JSON output.
enhance 'ipfs diag sys' output · ipfs/kubo#7458 | Good First Issue