Uploaded image for project: 'Percona Monitoring and Management'
  1. Percona Monitoring and Management
  2. PMM-2457

Improve External Exporter help documentation for duration interval

    XMLWordPrintable

    Details

      Description

      Hi,

      Help for adding external server specifies "duration" but it does not mention the format, so for example duration of "10" ends up with error message

      We should make sure help provide example of supported format 10s; 10m etc

      We should not assume user knows Prometheus conventions.

      root@clickhouse:~# pmm-admin add external:service clickhouse --interval 10 --service-port=9116
      Error: invalid argument "10" for "--interval" flag: time: missing unit in duration 10
      Usage: pmm-admin add external:service job_name [instance] --service-port=port [flags]
      
      Flags:
      --force skip reachability check, overwrite scrape job parameters
      -h, --help help for external:service
      --interval duration scrape interval
      --path string metrics path
      --scheme string protocol scheme for scrapes
      --timeout duration scrape timeout
      
      Global Flags:
      -c, --config-file string PMM config file (default "/usr/local/percona/pmm-client/pmm.yml")
      --service-port int service port
      --verbose verbose output
      
      invalid argument "10" for "--interval" flag: time: missing unit in duration 10

       Tasks

      1. Error message for --interval should be: Invalid duration scrape interval, missing unit in duration, for example 10s
      2. Usage instructions for --interval should be: duration scrape interval, in seconds. Include trailing 's', example –interval 10s or interval 1m

        Smart Checklist

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  pz Peter Zaitsev
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  4 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Time Tracking

                    Estimated:
                    Original Estimate - Not Specified
                    Not Specified
                    Remaining:
                    Remaining Estimate - 0 minutes
                    0m
                    Logged:
                    Time Spent - 1 day
                    1d