Details

    • Type: Improvement
    • Status: Done
    • Priority: Medium
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 2.0.0-rc1
    • Component/s: PMM Admin
    • Labels:
      None

      Description

      Current help output:

      -> pmm-admin --help
      usage: pmm-admin [<flags>] <command> [<args> ...]
      
      Version 2.0.0-dev.
      
      Flags:
        -h, --help                   Show context-sensitive help (also try --help-long and --help-man).
            --version                Show application version.
            --server-url=SERVER-URL  PMM Server URL.
            --server-insecure-tls    Skip PMM Server TLS certificate validation.
            --debug                  Enable debug logging.
            --trace                  Enable trace logging (implies debug).
            --json                   Enable JSON output.
      
      Commands:
        help [<command>...]
          Show help.
      
        list [<flags>]
          Show Services and Agents running on this Node.
      
        status
          Show information about local pmm-agent.
      
        inventory add agent mongodb-exporter [<flags>] [<pmm-agent-id>] [<service-id>] [<username>]
          Add mongodb_exporter to inventory.
      
        inventory add agent mysqld-exporter [<flags>] [<pmm-agent-id>] [<service-id>] [<username>]
          Add mysqld_exporter to inventory.
      
        inventory add agent node-exporter [<flags>] [<pmm-agent-id>]
          add Node exporter to inventory.
      
        inventory add agent pmm-agent [<flags>] [<runs-on-node-id>]
          add PMM agent to inventory.
      
        inventory add agent postgres-exporter [<flags>] [<pmm-agent-id>] [<service-id>] [<username>]
          Add postgres_exporter to inventory.
      
        inventory add agent qan-mongodb-profiler-agent [<flags>] [<pmm-agent-id>] [<service-id>] [<username>]
          add QAN MongoDB profiler agent to inventory.
      
        inventory add agent qan-mysql-perfschema-agent [<flags>] [<pmm-agent-id>] [<service-id>] [<username>]
          add QAN MySQL perf schema agent to inventory.
      
        inventory add node container [<flags>] [<name>]
          Add container node to inventory.
      
        inventory add node generic [<flags>] [<name>]
          Add generic node to inventory.
      
        inventory add service mongodb [<flags>] [<name>] [<node-id>] [<address>] [<port>]
          Add MongoDB service to inventory.
      
        inventory add service mysql [<flags>] [<name>] [<node-id>] [<address>] [<port>]
          Add MySQL service to inventory.
      
        inventory add service postgresql [<flags>] [<name>] [<node-id>] [<address>] [<port>]
          Add PostgreSQL service to inventory.
      
        inventory remove agent [<agent-id>]
          Remove agent from inventory.
      
        inventory remove node [<node-id>]
          Remove node from inventory.
      
        inventory remove service [<service-id>]
          Remove service from inventory.
      
        add mongodb [<flags>] [<address>] [<name>]
          Add MongoDB to monitoring.
      
        add mysql [<flags>] [<address>] [<name>]
          Add MySQL to monitoring.
      
        add postgresql [<flags>] [<address>] [<name>]
          Add PostgreSQL to monitoring.
      
        register [<flags>] [<node-address>] [<node-type>] [<node-name>]
          Register current Node at PMM Server.
      
        remove [<flags>] [<service-type>] [<service-name>]
          Remove Service from monitoring.
      

      We should hide inventory commands by default:

      …
      
      Commands:
        help [<command>...]
          Show help.
        add mongodb [<flags>] [<address>] [<name>] [<node-address>] [<node-type>]
          Add MongoDB to monitoring  
      
        add mysql [<flags>] [<address>] [<name>] [<node-address>] [<node-type>]        
          Add MySQL to monitoring  
      
        add postgresql [<flags>] [<address>] [<name>] [<node-address>] [<node-type>]   
          Add PostgreSQL to monitoring  
      
        add proxysql [<flags>] [<address>] [<name>] [<node-address>] [<node-type>]
          Add ProxySQL to monitoring
      
        list [<flags>]
          Show Services and Agents running on this Node.
      
        status
          Show information about local pmm-agent.
      
        register [<flags>] [<node-address>] [<node-type>] [<node-name>]
          Register current Node at PMM Server.
      
        remove [<flags>] [<service-type>] [<service-name>]
          Remove Service from monitoring.
      

      We should do so by using kingpin help templates. E.g. when a new top-level command is added, there (preferably) should not be a need to update help template manually.

       

      pmm-admin inventory --help

       Should display help about inventory  commands 

       

        Smart Checklist

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  alexey.palazhchenko Alexey Palazhchenko
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Time Tracking

                    Estimated:
                    Original Estimate - Not Specified
                    Not Specified
                    Remaining:
                    Remaining Estimate - Not Specified
                    Not Specified
                    Logged:
                    Time Spent - 1 hour, 9 minutes
                    1h 9m