Benchmark cli

[butonic]

For stress testing and analysis we added a two cli benchmark commands to gather different statistics or to put a system under load. use the cli help

$ ocis/bin/ocis benchmark syscalls help
NAME:
   ocis benchmark syscalls - test how fast syscalls are

USAGE:
   ocis benchmark syscalls [command options] [arguments...]

CATEGORY:
   benchmark

OPTIONS:
   --path value        Path to test
   --iterations value  Number of iterations to execute (default: "100")
   --help, -h          show help

$ ocis/bin/ocis benchmark client help
NAME:
   ocis benchmark client - Start a client that continuously makes web requests and prints stats. The options mimic curl, but URL must be at the end.

USAGE:
   ocis benchmark client [command options] [arguments...]

CATEGORY:
   benchmark

OPTIONS:
   --request value, -X value                              Specifies a custom request method to use when communicating with the HTTP server. (default: "PROPFIND")
   --user value, -u value                                 Specify the user name and password to use for server authentication. (default: "admin:admin")
   --insecure, -k                                         Skip the TLS verification step and proceed without checking. (default: false)
   --data value, -d value                                 Sends the specified data in a request to the HTTP server.
   --header value, -H value [ --header value, -H value ]  Extra header to include in information sent.
   --bearer-token-command value                           Command to execute for a bearer token, e.g. 'oidc-token OCIS'. When set, disables basic auth.
   --every value                                          Aggregate stats every time this amount of seconds has passed. (default: 0)
   --jobs value, -j value                                 Number of parallel clients to start. (default: 1)
   --help, -h                                             show help

Examples

PROPFIND the demo instance with the default admin account

$ ocis/bin/ocis benchmark client https://cloud.ocis.test/remote.php/webdav
req 1 took 1.413333631s and returned status 207
req 2 took 252.108027ms and returned status 207
req 3 took 265.227102ms and returned status 207
req 4 took 249.377407ms and returned status 207
...

upload file

$ ocis/bin/ocis benchmark client --request PUT --data "foo" https://cloud.ocis.test/remote.php/webdav
/foo.txt
req 1 took 173.764124ms and returned status 201
req 2 took 166.867289ms and returned status 204
req 3 took 172.991281ms and returned status 204
req 4 took 166.175506ms and returned status 204
...

trust self signed certificates, start 36 concurrent clients, aggregate stats every 3 sec

$ ocis/bin/ocis benchmark client --bearer-token-command "oidc-token admin-ocis-owncloud-test" -k -j 36 --every 3 https://cloud.ocis.test/remote.php/webdav/foo.txt 
364 req at 268.969301ms/req
538 req at 190.677261ms/req
548 req at 195.940286ms/req
282 req at 330.920992ms/req
486 req at 246.011642ms/req
...

TODO

• allow {templates} in data und url parameters ... can use the client number, request number, a random string, or a callback?
• add throttle?

[update-docs]

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

[mmattel]

Shall we add this in the admin documentation? I mean, it is already visible here and on the command line help, so it can be found. But we could proactively help admins when it comes to benchmark their environment (and compare it to others).

[ownclouders]

💥 Acceptance test Core-API-Tests-ocis-storage-5 failed. Further test are cancelled...

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
4 Code Smells

0.0% Coverage
0.0% Duplication