From 0418d3804cdda839b8248ea9b7454e35a8c14136 Mon Sep 17 00:00:00 2001 From: Sebastien Ros Date: Wed, 15 Jul 2020 11:20:44 -0700 Subject: [PATCH 1/2] Refreshing docs --- docs/benchmarking_docker.md | 2 +- docs/getting_started.md | 19 ++++--------------- samples/hello/hello.benchmarks.yml | 2 +- samples/local/local.benchmarks.yml | 2 +- samples/netty/netty.benchmarks.yml | 3 +-- 5 files changed, 8 insertions(+), 20 deletions(-) diff --git a/docs/benchmarking_docker.md b/docs/benchmarking_docker.md index a0e0ced0a..082aa6959 100644 --- a/docs/benchmarking_docker.md +++ b/docs/benchmarking_docker.md @@ -15,7 +15,7 @@ It has a scenario called **netty** comprised of an _application_ job based on a ```yml imports: - - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Wrk/wrk.yml?token=AAI4T3NRKQTVLI2YOUJVCB2633AIM + - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Wrk/wrk.yml variables: localEndpoint: http://localhost:5010 diff --git a/docs/getting_started.md b/docs/getting_started.md index a0f9e0a87..db9fbc1cc 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -8,28 +8,17 @@ This tutorial shows how to benchmark a simple .NET web application using the __b 2. Install Crank via the following command: ```text - > dotnet tool install -g Microsoft.Crank.Controller --version "0.1.0-*" + dotnet tool install -g Microsoft.Crank.Controller --version "0.1.0-*" ``` ```text - > dotnet tool install -g Microsoft.Crank.Agent --version "0.1.0-*" - ``` - - NB: Preview versions can be installed by running this command line: - - ```text - > dotnet tool install -g Microsoft.Crank.Controller --version "0.1.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json - ``` - - ```text - > dotnet tool install -g Microsoft.Crank.Agent --version "0.1.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json + dotnet tool install -g Microsoft.Crank.Agent --version "0.1.0-*" ``` 3. Verify the installation was complete by running: ``` - > crank - No jobs were found. Are you missing the --scenario argument? + crank ``` ## Define the scenario @@ -40,7 +29,7 @@ It contains the scenario definitions, describing which applications need to be d ```yml imports: - - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml?token=AAI4T3LCX6ET4DCTDLUVJX263U2AK + - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml jobs: server: diff --git a/samples/hello/hello.benchmarks.yml b/samples/hello/hello.benchmarks.yml index 2afc4b70f..1ee24c2f9 100644 --- a/samples/hello/hello.benchmarks.yml +++ b/samples/hello/hello.benchmarks.yml @@ -1,5 +1,5 @@ imports: - - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml?token=AAI4T3I2FCYWGVT67SGEDVS643D3O + - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml jobs: server: diff --git a/samples/local/local.benchmarks.yml b/samples/local/local.benchmarks.yml index 9556df643..7e7d7b0fe 100644 --- a/samples/local/local.benchmarks.yml +++ b/samples/local/local.benchmarks.yml @@ -1,5 +1,5 @@ imports: - - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml?token=AAI4T3I2FCYWGVT67SGEDVS643D3O + - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml jobs: server: diff --git a/samples/netty/netty.benchmarks.yml b/samples/netty/netty.benchmarks.yml index 118610960..9d8e750c4 100644 --- a/samples/netty/netty.benchmarks.yml +++ b/samples/netty/netty.benchmarks.yml @@ -1,6 +1,5 @@ imports: - #- https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Wrk/wrk.yml?token=AAI4T3NRKQTVLI2YOUJVCB2633AIM - - https://raw.githubusercontent.com/aspnet/Benchmarks/master/src/WrkClient/wrk.yml + - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Wrk/wrk.yml variables: localEndpoint: http://localhost:5010 From aa63bd84c76eaa357c506291d52cba311d1d20cb Mon Sep 17 00:00:00 2001 From: Sebastien Ros Date: Wed, 15 Jul 2020 11:53:04 -0700 Subject: [PATCH 2/2] Using dotnet/crank urls --- docs/local_application.md | 2 +- docs/reference/architecture.md | 4 ++-- docs/storing_results.md | 2 +- src/Microsoft.Crank.Controller/Program.cs | 2 +- src/Microsoft.Crank.Controller/benchmarks.schema.json | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/local_application.md b/docs/local_application.md index d2283de4c..375114288 100644 --- a/docs/local_application.md +++ b/docs/local_application.md @@ -61,7 +61,7 @@ public static void Main(string[] args) Execute the following command: ``` -> crank --config /crank/samples/hello/hello.benchmarks.yml --scenario hello --profile local +crank --config /crank/samples/hello/hello.benchmarks.yml --scenario hello --profile local --application.options.displayOutput true ``` diff --git a/docs/reference/architecture.md b/docs/reference/architecture.md index 1cdaa5fcb..00d18d7a0 100644 --- a/docs/reference/architecture.md +++ b/docs/reference/architecture.md @@ -12,12 +12,12 @@ Jobs are individual units of execution. A job can be encapsulated by a Dockerfil ```yaml imports: - - https://raw.githubusercontent.com/aspnet/Benchmarks/master/src/BombardierClient/bombardier.yml + - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml jobs: server: source: - repository: https://github.com/aspnet/perf + repository: https://github.com/dotnet/crank branchOrCommit: master project: samples/hello/hello.csproj diff --git a/docs/storing_results.md b/docs/storing_results.md index 92353ddc6..a300a8b53 100644 --- a/docs/storing_results.md +++ b/docs/storing_results.md @@ -11,7 +11,7 @@ Some jobs can provide more information when the results are stored than on the c The following example executes the __hello__ sample benchmark and stores the results in a file named `results.json`. We assume the agent is running locally. ``` -> crank --config /crank/samples/hello/hello.benchmarks.yml --scenario hello --profile local --output results.json +crank --config /crank/samples/hello/hello.benchmarks.yml --scenario hello --profile local --output results.json ``` And the file should contain some content similar to this: diff --git a/src/Microsoft.Crank.Controller/Program.cs b/src/Microsoft.Crank.Controller/Program.cs index 6a006b4dc..9cd7c2b7a 100644 --- a/src/Microsoft.Crank.Controller/Program.cs +++ b/src/Microsoft.Crank.Controller/Program.cs @@ -1216,7 +1216,7 @@ public static async Task LoadConfigurationAsync(string configurationFil if (!validationResults.IsValid) { // Create a json debug file with the schema - localconfiguration.AddFirst(new JProperty("$schema", "https://raw.githubusercontent.com/aspnet/Benchmarks/master/src/BenchmarksDriver2/benchmarks.schema.json")); + localconfiguration.AddFirst(new JProperty("$schema", "https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Controller/benchmarks.schema.json")); var debugFilename = Path.Combine(Path.GetTempPath(), "crank-debug.json"); File.WriteAllText(debugFilename, localconfiguration.ToString(Formatting.Indented)); diff --git a/src/Microsoft.Crank.Controller/benchmarks.schema.json b/src/Microsoft.Crank.Controller/benchmarks.schema.json index b22762179..fee0700a4 100644 --- a/src/Microsoft.Crank.Controller/benchmarks.schema.json +++ b/src/Microsoft.Crank.Controller/benchmarks.schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "http://microsoft.com/aspnet/benchmarks", + "$id": "http://microsoft.com/dotnet/crank", "type": "object", "title": ".NET Benchmarks Labs JSON Schema", @@ -19,7 +19,7 @@ "title": "The github repository containing the source.", "default": "", "examples": [ - "https://github.com/aspnet/benchmarks.git" + "https://github.com/dotnet/crank.git" ], "pattern": "^(.*)$" },