Documentation ¶
Overview ¶
ndt7-prometheus-exporter is an ndt7 non-interactive prometheus exporting client
Usage:
ndt7-prometheus-exporter
The default behavior is for ndt7-client to discover a suitable server using Measurement Lab's locate service. This behavior may be overridden using either the `-server` or `-service-url` flags.
The `-server <name>` flag specifies the server `name` for performing the ndt7 test. This option overrides `-service-url`.
The `-service-url <url>` flag specifies a complete URL that specifies the scheme (e.g. "ws"), server name and port, protocol (e.g. /ndt/v7/download), and HTTP parameters. By default, upload and download measurements are run automatically. The `-service-url` specifies only one measurement direction.
The `-no-verify` flag allows to skip TLS certificate verification.
The `-scheme <scheme>` flag allows to override the default scheme, i.e., "wss", with another scheme. The only other supported scheme is "ws" and causes ndt7 to run unencrypted.
The `-timeout <string>` flag specifies the time after which the whole test is interrupted. The `<string>` is a string suitable to be passed to time.ParseDuration, e.g., "15s". The default is a large enough value that should be suitable for common conditions.
The `-port` flag starts an HTTP server to export summary results in a form that can be consumed by Prometheus (http://prometheus.io).
The `-profile` flag defines the file where to write a CPU profile that later you can pass to `go tool pprof`. See https://blog.golang.org/pprof.
Additionally, passing any unrecognized flag, such as `-help`, will cause ndt7-client to print a brief help message.