Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refreshing docs #59

Merged
merged 2 commits into from
Jul 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/benchmarking_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 4 additions & 15 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/local_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/storing_results.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion samples/hello/hello.benchmarks.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion samples/local/local.benchmarks.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 1 addition & 2 deletions samples/netty/netty.benchmarks.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Crank.Controller/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1216,7 +1216,7 @@ public static async Task<JObject> 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));
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.Crank.Controller/benchmarks.schema.json
Original file line number Diff line number Diff line change
@@ -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",

Expand All @@ -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": "^(.*)$"
},
Expand Down