add inspector command for system inspection

[frrist]

Description

This PR makes progress towards completing #2652 by adding the following commands:

USAGE
  go-filecoin inspect - Show info about the filecoin node

  go-filecoin inspect

SUBCOMMANDS
  go-filecoin inspect config  - Print in memory config information.
  go-filecoin inspect disk    - Print filesystem usage information.
  go-filecoin inspect memory  - Print memory usage information.
  go-filecoin inspect runtime - Print runtime diagnostic information.

Use 'go-filecoin inspect --help' for more information about this command.

Disk: Prints out information about the filesystem

$ go-filecoin inspect disk
{
  "FSType": "61267",
  "Free": 860286201856,
  "Total": 809074733056
}

Memory: Prints out information about system memory.

$ go-filecoin inspect memory
{
  "Swap": 0,
  "Virtual": 10323220000
}

Runtime: Prints out information about your golang runtime.

$ go-filecoin inspect runtime
{
  "Arch": "amd64",
  "Compiler": "gc",
  "GoMaxProcs": 8,
  "NumCGoCalls": 11,
  "NumGoRoutines": 90,
  "NumProc": 8,
  "OS": "linux",
  "Version": "go1.12.1"
}

Environment: Prints out information about your filecoin nodes environment.

$ go-filecoin inspect environment
{
  "FIL_API": "",
  "FIL_PATH": "",
  "GOPATH": "/home/frrist"
}

Config: Prints out information about your filecoin nodes in memory config.

go-filecoin inspect config
{
  "api": {
    "accessControlAllowCredentials": false,
    "accessControlAllowMethods": [
      "GET",
      "POST",
      "PUT"
    ],
....omitted....
  "wallet": {
    "defaultAddress": "t1azpabiyccur7ojhicilqti3ddjvtkbopa42s7py"
  }
} 

[ZenGround0]

Blocking: This won't work if a user specified home directory with the --repodir flag, you should parse that arg, import repo and use repo.GetRepoDir(repoDirArgString) function as in other commands. Also this way the env var stuff is taken care of for you.

[ZenGround0]

Approved after blocking comment is addressed. The thing that worries me most about this command is the proliferation of abstractions on the CLI. It seems like the existence of this command, particularly the networking subcommand implies we should be rearranging existing commands underneath it like go-filecoin stats, go-filecoin id. In general this set of functionality helps more than it harms as most of the functionality introduced is needed and does not exist in another form on the CLI.

I do not support completing the rest of #2652 as it is written right now (config, network, filecoin) without rethinking existing commands or understanding how the rest of the proposed commands fit into the CLI as a whole. With this in mind I am imagining diag sys becoming the top level command with disk, env, mem, net and runtime subcommands.

[mishmosh]

Are diag and sys fairly universal command names? If not, could they be renamed to be more human-readable?

[frrist]

@mishmosh I was originally borrowing from the naming convention used by go-ipfs, however I have altered this in attempt to be a bit more descriptive. The PR description now reflects this.

@ZenGround0 I have re-written this inlight of your review to use plumbing, I think stats could be moved under the inspect command -- could you give this a second?

[travisperson]

Just some linting comments as it's currently broken till #2650 lands

[travisperson]

RuntimeInfor

[travisperson]

EnvironmentInfo contains

[travisperson]

Need a doc comment

[anorth]

Thank you! Please follow up with an update to the GitHub bug issue template so we can see this in action.

I think this is a nice clean example of something that does not need to be part of plumbing: it's not a core interface/component to be used by lots of higher level things. The alternative here is to put the inspector service on the command Env directly (runAPIAndWait in daemon.go) and bypass plumbing.

LGTM whether or not you do that here.

[anorth]

Do we want an inspect all so there's a one-liner for our bug reports?

[frrist]

The alternative here is to put the inspector service on the command Env

This is a much better idea imo, I have modified it to do such.

Do we want an inspect all so there's a one-liner for our bug reports?

Done:

go-filecoin inspect all | jq
{
  "Config": {
    "api": {
      "accessControlAllowCredentials": false,
      "accessControlAllowMethods": [
        "GET",
        "POST",
        "PUT"
      ],
      "accessControlAllowOrigin": [
        "http://localhost:8080",
        "https://localhost:8080",
        "http://127.0.0.1:8080",
        "https://127.0.0.1:8080"
      ],
      "address": "/ip4/127.0.0.1/tcp/3453"
    },
    "bootstrap": {
      "addresses": [],
      "minPeerThreshold": 0,
      "period": "1m"
    },
    "datastore": {
      "path": "badger",
      "type": "badgerds"
    },
    "heartbeat": {
      "beatPeriod": "3s",
      "beatTarget": "",
      "nickname": "",
      "reconnectPeriod": "10s"
    },
    "metrics": {
      "prometheusEnabled": false,
      "prometheusEndpoint": "/ip4/0.0.0.0/tcp/9400",
      "reportInterval": "5s"
    },
    "mining": {
      "autoSealIntervalSeconds": 120,
      "minerAddress": "empty",
      "storagePrice": "0"
    },
    "mpool": {
      "maxNonceGap": "100",
      "maxPoolSize": 10000
    },
    "net": "",
    "sectorbase": {
      "rootdir": ""
    },
    "swarm": {
      "address": "/ip4/0.0.0.0/tcp/6000"
    },
    "wallet": {
      "defaultAddress": "t1ciamdwkjhbt7fjqm4chc3logy76cjbjey75qfia"
    }
  },
  "Disk": {
    "FSType": "61267",
    "Free": 856211677184,
    "Total": 805000208384
  },
  "Environment": {
    "FIL_API": "",
    "FIL_PATH": "",
    "GOPATH": "/home/frrist"
  },
  "Memory": {
    "Swap": 0,
    "Virtual": 10331684000
  },
  "Runtime": {
    "Arch": "amd64",
    "Compiler": "gc",
    "GoMaxProcs": 8,
    "NumCGoCalls": 9,
    "NumGoRoutines": 87,
    "NumProc": 8,
    "OS": "linux",
    "Version": "go1.12.1"
  }
}

[frrist]

Please follow up with an update to the GitHub bug issue template so we can see this in action.

Sounds good, will do this once it merges