CHANGELOG.md

v0.0.16 - binaries release (next branch)

• client: new feature scheduler (-schedule flag): nspeed get -schedule 1s,1s url will connect to url, wait 1s, download for 1s, then stop. General format is: -schedule h0,w0,h1,w1,...,hN[,wN] = hold h0, work for w0 , hold h1, work w1,...,hold hN, work wN is present or till end of content/timeout. Global timeout (defaut none) and command timeout (defaut 8 seconds) always take priority: nspeed get -schedule 1s,20s url won't last 21s but only 8s. For now the -schedule flag is incompatible with the -repeat flag and scheduling steps are not reported in verbose/debug/trace logs.
• ui: Added matcha test.
• bug fixes (tcp client, repeat)
• chores: Updated dependencies (quic-go, psutils, x/net).

v0.0.15 - binaries release (next branch)

• client & server: new -mtu size flag to set the initialize packet size (quic-go related only)
• client: new flag repeat flag -r n allow to repeat the command n times. The client we'll try to reuse the connection if possible.
• bench: breaking change HTTP/1.1 benchmark names are now consistent with HTTP/2 (h1g is with tls, h1cg without)
• bench: -id are now names of the benchmarks
• bench: new meta benchs: http and quic
• from command: new template feature. use repeated -var a=b flag(s) to define a variable and its value. Use variables with Go template syntax in content: {{.a}} will become b or nothing is a is not defined. Full go text template features are available. See https://pkg.go.dev/text/template
• general: -id values now support double-quoted values (-id "my id")
• using go 1.24.1
• general: -pre or post delays implemented for then
• general: new flag -buffer value allows to set the buffer size used for i/o operations (-1 for max value, 0 for Go default)
• ui: preview of ui, for now it's just a CLI/terminal in web page
• charting: moved from chartjs to echarts. -html now produces working graphs. use -rate for graphing series.
• charting: use nspeed ui -viewer special UI mode to open the json charts viewer (equiv: -html : from -json file)

v0.0.14 (next branch)

• breaking change: global flag -color removed. Colors are now on by default, use the new flag -nocolor to disable them.
• major internal refactoring of packages. more packages open source'd to this repo.
• cmd/getroute demo program for nspeed.app/network package

v0.0.13

• deps: updated psutil to v4 to fix Darwin builds

v0.0.12

• fix: self certificate expiration date
• fix: bench typo

v0.0.11

• new protocol: raw quic connection are now also available for server, get, post, put commands. Add -P quic to use quic instead of http. this is a wip/experimental feature , see https://pkg.go.dev/golang.org/x/net/quic
• new protocol: raw tcp connection are now also available for server, get, post, put commands. Add -P tcp to use tcp instead of http. TLS can be used or not.
• new protocol: raw quic-go connection are now also available for server, get, post, put commands. Add -P quic-go to use quic-go instead of http
• new command: from uri (abbr. f) will read commands from the file/url (use - for stdin)
• new command: then [options] (abbr. t) execute previous command(s) before continuing.
• new command: bench (abbr b) (see corresponding bench section below)
• using semantic version (before it would have been v0.11 -> now it's v0.0.11)
• using goreleaser
• using Go 1.23
• Darwin (MacOS) build: -cpu now works
• using GOAMD64 levels: (see https://github.com/golang/go/wiki/MinimumRequirements#amd64 ). for now only level1 (_v1) is built.
• less info displayed with -version. Use -version full for more infos.
• breaking changes in behavior: 'infinite' commands (commands that usually never end like server and api) are stopped if combined with "short-lived" commands like get or put (for instance nspeed server get http://google.com/ will end after the get is finished. In previous version it would wait forever for a kill signal). If all commands are "infinite" then the program will not stop until killed (=daemon mode)
• cleaned out text output, reformatted cpu output. Verbose & debug messages now display the job name at the beginning of the line.
• new flags: -display-log-level and -display-log-time to toggle their respective fields.
• breaking change: the -tick duration flag is now a duration instead of an integer of seconds (default remain 1 second). It doesn't control the sampling rate of -cpu anymore (see -cpurate). The -tick rate is the rate of trace & debug messages.
• new flag: -rate duration used to set the frequency generating the time series data for json/html output Default is 1s.
• new flag: -cpurate duration used to set the cpu sampling rate (implies -cpu)
• new flag: -html filename to record the results to a html file. Use -rate duration to add time series. (wip. on local machine using : as filename will open directly the result in a web browser (no html file is created , it is just sent to the browser using a temporary web server))
• new flag: -json filename to record the results to a json file. Use -rate duration to add time series.
• new flag: -dns-server address[:port] to specify a dns server (literal ip address with optional port)
• new flag: -ungroup show each stream result of a multi-streams command (see client below)
• new flag: -4/-6 to use IPv4 only or IPv6 only (doesn't override these options at the command level)

bench

• new bench command (abbrev b) : allow to launch loopback interface tests (server and get/put on a localhost server). see nspeed bench -h for available benchmarks.

server

• breaking changes: -t flag renamed to -m to be like curl.
• new flags: -http1.1 and -http2 to enforce the HTTP version used
• breaking change: the default port is now a random , available port instead of 7333. Use -p port to use a specific port.
• new flag: -id string to set a uniq id/name for this server (which then can be used in nspeed://name url scheme)
• An upload to a nspeed server (PUT and POST) now returns metrics data in json format in the response body
• a request of the root path ('/') will now return some informations in json (instead of "Not found (no regexp match)")
• A download from a nspeed server returns a special header named x-nspeed-guid which value is a short-lived unique identifier identifying this download. Sending a request to the server with that same header will return the metrics data in json of this download. The delay is 5 seconds (could change in the future or be configurable). See examples section in the README.md file.

Client

• the get command now accepts the -size to limit the number of bytes received (defaut is 0 = no limit)
• breaking changes: -http11 flag renamed to -http1.1
• breaking changes: -t flag renamed to -m to be on par with Curl.
• in conjunction with the new server -id flag, a special new url scheme nspeed:name is now supported to reference the url address of the corresponding server (draft)
• new flag: -connect-timeout maximum duration for the initial connection (=timeout before dial abort)
• new flag: -http2 to force using HTTP/2
• new flag: -id string to set a uniq id/name for this command
• multiple connections commands (-n number flag) are now summed and grouped in the report. Use the new global flag -ungroup to see each result for each connection.

ciphers

• fixed TLS version text messages

v0.10

general

• experimental support of HTTP/3 using quic-go ( see HTTP/3 section )
• internal optimization to buffer sizes and http/2 issues (tracking various Go HTTP/2 performance issue being addressed by the Go team)
• using Go 1.19. nspeed -version now also displays the Go version used to build the binary as well as OS/Arch information
• new -pre duration option: wait duration before starting command(s) (duration uses Go syntax: "2s" for 2 seconds for instance)
• new -post duration option: wait duration after all commands have ended
• new -info flag to display some os/hardware information
• new -text filename flag: report the results to a text file (use - for stdout which is the default)
• new -trace flag: display lot of debug/trace information (wip - mainly used for quic/http3 tracing)
• switch to psutil v3
• fix global timeout

API

• new endpoints: /stats/info and /stats/mem , see API.md
• new flags: -stats, -statsonly and -statsdebug: enable real time web UI stats view at /rl url path. statsonly disable all other api routes. statsdebug adds Go runtime specifics stats at url path: /debug/statsviz
• new flag: -browse : open the default web browser at /rl url

server

• new option -http3 to enable HTTP/3. Implies -self if no TLS cert & key files are provided.

Client

• breaking change: HTTP client can now do PUT or POST with corresponding matching command names. A new post command was added to do the POST HTTP method and the previously put command does now a 'PUT' method instead of a POST
• new option -http3 to enable HTTP/3 (this will force HTTP/3 if the server support it and fallback to HTTP/2 or HTTP/1.1 if not). Implies -self if no TLS cert & key files are provided.
• console output displays news information per job: final target IP, latency and protocol
• default to https:// if no scheme provided (nspeed get google.com is the same as nspeed get https://google.com)

ciphers

• updated for Go 1.17+ internal changes
• this command can no longer be called with other commands even with itself because of a global side-effect/trick. This command is not available thru the API.
• displays AES hardware support

HTTP/3

The implementation used is https://github.com/quic-go/quic-go. In trace mode (-trace) QLog trace files are generated in the current directory. They can be analyzed with https://qvis.quictools.info/

v0.9

general

• lots of internal refactoring (for the api/ui and a new internal scheduling/cancellation system)
• command names can be shortened as long as it is not ambiguous. For instance ge or just g can be used instead of get.
• added l[atency] and t[raceroute] command names (placeholder, these commands are not yet implemented)
• added api command (see below and API.md)

api

• a new api command allowing NSpeed to be controlled by a simple HTTP request (REST). The api command create a new API endpoint with default value (localhost,7333). The server command can also be an API endpoint with the new -api flag. See API.md for more information about the API.
• for now the api only return text strings. Later the a standard metrics format will be used.

client

• get and put mandatory arguments (-url and -url and -size respectively) can now be prefixed with a flag keyword allowing to change their order. for instance nspeed get -4 http://google.com is equivalent to nspeed get -url http://google.com -4
• IP version displayed in text results

server

• api flag: see the api command
• -dir path,serve static files from path. path is a local directory to serve content from (from /dir url ). The max duration parameter applies (-t) but not the max size parameter (-s).

ciphers

• "cypher" spelling replaced with "cipher" everywhere including the ciphers command ("cypher" is a minority spelling so less prone to be known or searched for)

v0.8

general

• a few typos fixes
• added -h2c mode to client & server to allow HTTP/2 Cleartext (H2C)

server

client

• -http11 flag to force HTTP 1.1 when connecting to HTTP/2 server

cyphers

• new command cyphers to list supported cyphers with that server (will test only TLS 1.2 and 1.3)

v0.7

general

• global flags:
  • -self: activate self-signed certificate for all clients (get & put)
  • -color : use colors in output (by default there will be no color at all)
  • -cpu : display cpu usage (every second). -debug & -verbose don't display cpu usage anymore
• news debug metrics: ReadCount,WriteCount (how many OS level Read & Write calls were performed) and AverageReadSize,AverageWriteSize (total volume/count)
• fix some usage messages

server

• -self flag: listen in https mode using a self-signed certificate
• bigger buffer when sending
• paths in url for upload (/p) & download (/g) removed. just use the root path / for both (see the updated README.md examples)
• download paths can now have an extension. For instance /10G.iso. The Content-Type header will be set accordingly to https://golang.org/pkg/mime/#TypeByExtension.
• query parameters:
  • ct query parameter added: set the returned content-type header, for instance: http://localhost:7333/1k.jpg?ct=text/plain will return a content-type of text/plain instead of image/jpeg ("ct" has precedence over the extension. With no precedence or ct parameter, the default content-type is application/octet-stream ).
  • chunk_size query parameter limited to 1 MiB (it's allocated once, this will be tuned later)
  • seed query parameter removed (this will return later)

client

• disable compression
• dns report is back in -verbose mode
• -self : same as global '-self' flag

known issues / caveats

• the self-signed cert only work for 'localhost, 127.0.0.1,::1'. Next vesion will allow test https over a LAN between trusted machines, meanwhile use -k flag with nspeed or curl.

#v0.6

general

• '-a' flag now always prefers IPv6 first
• major overhaul of displayed messages (zerolog package)
• display usage if no argument
• all commands can now be mixed together (*)
• by default now nspeed outputs less messages. "-verbose" displays these messages.new option "-debug" acts like v0.5 "-verbose" option.
• new '-log filename' flag to write result to a structured file (not finalized)
• colorized cpu with the -verbose option

server

-"-d duration" duration after which the server shutdown (duration must have at least one unit of: s,m or h or a combination 5h20m5s for instance) -"-n value" number of requests after which the server shutdown

client

• "-w duration" wait delay before starting the command

(*) The new flags allow to test with a single nspeed command, for instance:

nspeed server -n 2 get -w 1 -n 2 http://localhost:7333/g/1g

This will launch a server and it will answer to 2 requests then stop and a "get" client that will wait 1 second and perform 2 requests to the server.

v0.5

general

• better usage help text
• better formatting in verbose mode (-verbose)
• parsed units allow now decimal precision ("2.2g")

server

• "-h" host option changed to "-a" (since "-h" is standard for help)
• default host is now "localhost"
• "-4" and "-6" options to use IPv4 or IPv6 only (must be consistent with "-a")
• the "-s" option can now parse units of bytes like the client (for instance: "-s 1g" for 1GB, "-s 1G" for 1GiB)
• the "-t" now parse seconds only instead of requiring a unit (consistent with client)
• route '/p' is also accepted instead of redirecting to '/p/'
• added name & version in a http response header

get & put

• "-4" and "-6" options are now working
• "-k" option to ignore certificate validation
• "-a host|interface|ip" option

known issues / caveats

• server: the default host is now 'localhost' which leads to bind only to IPv4 (Go bug: golang/go#9334). A temporary workaround is to launch a second server instance with the -6 flag: nspeed server server -6 will listen to localhost on IPv4 and IPv6. A fix will be implemented soon. Some OS can fail to resolve 'localhost' to ::1 even if they have IPv6 configured. In that case use "-a ::1" explicitly (nspeed server server -a ::1)
• put/post: redirect(s) happen after the upload which normal behavior for a HTTP POST/PUT.
• performance inconsistencies on Windows
• '-a "" ' doesn't parse on Windows, workaround: use '-a=""'
• server: '-a interface_name' bind to the first candidate address (ipv6/ipv4/link-local) found for that interface. It's not the same behavior as a bind with SO_BINDTODEVICE (which is platform specific).
• client: '-a interface_name' use the first candidate address (ipv6/ipv4/link-local) found for that interface. It doesn't perfom a source address selection depending on the destination.

v0.4 - 2021/04/09

first alpha

v0.3 - 2020/08/18

technical preview

v0.2 - 2020/08/05

technical preview

v0.1 - 2020/03/21

technical preview