From 73ec62adbd03a06c764a144b71b9a15fa5f4a805 Mon Sep 17 00:00:00 2001 From: Stafford Williams Date: Fri, 5 Apr 2019 02:06:23 +1100 Subject: [PATCH] Added Crankier docs (#9044) Docs describing usage of Crankier --- .../perf/benchmarkapps/Crankier/Readme.md | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 src/SignalR/perf/benchmarkapps/Crankier/Readme.md diff --git a/src/SignalR/perf/benchmarkapps/Crankier/Readme.md b/src/SignalR/perf/benchmarkapps/Crankier/Readme.md new file mode 100644 index 0000000000..20f56cc720 --- /dev/null +++ b/src/SignalR/perf/benchmarkapps/Crankier/Readme.md @@ -0,0 +1,44 @@ +# Crankier + +Load testing for ASP.NET Core SignalR + +## Commands + +### local + +The `local` command launches a set of local worker clients to establish connections to your SignalR server. + +``` +> dotnet run -- help local + +Usage: local [options] + +Options: + --target-url The URL to run the test against. + --workers The number of workers to use. + --connections The number of connections per worker to use. + --send-duration The send duration to use. + --transport The transport to use (defaults to WebSockets). + --worker-debug Provide this switch to have the worker wait for the debugger. +``` + +Notes: + +* `TARGET_URL` needs to be the route to your hub exposed by `UseSignalr` in your application. +* `CONNECTION_COUNT` defaults to 10,000. +* `SEND_DURATION_IN_SECONDS` defaults to 300 +* `WORKER_COUNT` defaults to 1 + +#### Examples + +Attempt to make 10,000 connections to the `echo` hub using WebSockets and 10 workers: + +``` +dotnet run -- local --target-url https://localhost:5001/echo --workers 10 +``` + +Attempt to make 5,000 connections to the `echo` hub using Long Polling + +``` +dotnet run -- local --target-url https://localhost:5001/echo --connections 5000 --transport LongPolling +```