Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
SaifAqqad committed Jul 27, 2024
1 parent ce4484a commit 4b11e01
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 23 deletions.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,8 @@
A standalone runner for the .NET [Aspire Dashboard](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/standalone) which can display OpenTelemetry data (traces,
metrics, and logs) from any application.

The runner can be used as a [dotnet tool](./src/AspireRunner.Tool/README.md) or as part of an [ASP.NET Core application](./src/AspireRunner.AspNetCore/README.md), it will automatically download the dashboard if it's not installed, and will run and manage the dashboard process.

> [!NOTE]
> The runner will prioritize using the dashboard bundled with the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli), if it's installed.
> [!IMPORTANT]
> While the runner itself targets .NET 6 and later, the dashboard requires the .NET 8 runtime (or later) to run.
>
> Meaning that the runner can be used as part of a .NET 6 application, but you'll still need the .NET 8 runtime to run the dashboard.
The runner can be used as a [dotnet tool](./src/AspireRunner.Tool/README.md) or as part of an [ASP.NET Core application](./src/AspireRunner.AspNetCore/README.md), it will
automatically download the dashboard if it's not installed, and will run and manage the dashboard process.

## [AspireRunner.Tool](./src/AspireRunner.Tool/README.md)

Expand All @@ -22,7 +14,7 @@ Provides a quick and easy to use CLI for downloading and running the Dashboard

### Installation

```bash
```console
dotnet tool install -g AspireRunner.Tool
```

Expand Down
30 changes: 23 additions & 7 deletions src/AspireRunner.AspNetCore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,40 @@ var builder = WebApplication.CreateBuilder(args);
if (builder.Environment.IsDevelopment())
{
// bind from configuration (appsettings.json, etc)
builder.Services.AddAspireDashboard(config => {
config.Otlp.EndpointUrl = "https://localhost:33554";

// Or bind from configuration (appsettings.json, etc)
builder.Configuration.GetSection("AspireDashboard").Bind(config);
});
}

//...
// or pass an options instance
builder.Services.AddAspireDashboard(new AspireDashboardOptions
{
Frontend = new FrontendOptions
{
EndpointUrls = "https://localhost:5020"
},
Otlp = new OtlpOptions
{
EndpointUrl = "https://localhost:4317"
},
Runner = new RunnerOptions
{
AutoDownload = true
}
});
}

var app = builder.Build();

//...
// ...
await app.RunAsync();
```

> [!NOTE]
> The runner will prioritize using the dashboard bundled with
> the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli), if it's installed.
> the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli) if it's installed, otherwise, The runner will
> download the dashboard to the user's `.dotnet` directory (`~/.dotnet/.AspireRunner`).
> [!IMPORTANT]
> While the runner itself targets .NET 6 (and later), the dashboard requires the .NET 8/9 runtime to run.
Expand Down
7 changes: 5 additions & 2 deletions src/AspireRunner.Core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@

This package contains the core functionality for running the Aspire Dashboard.

The runner can be used as a [dotnet tool](https://www.nuget.org/packages/AspireRunner.Tool) or with the [ASP.NET Core extension](https://www.nuget.org/packages/AspireRunner.AspNetCore) which runs and manages the dashboard process alongside any ASP.NET app.
The runner can be used as a [dotnet tool](https://www.nuget.org/packages/AspireRunner.Tool) or with
the [ASP.NET Core extension](https://www.nuget.org/packages/AspireRunner.AspNetCore) which runs and manages the dashboard process alongside any ASP.NET app.
<hr>

The dashboard can be used to display OpenTelemetry data (traces, metrics and logs) from any
application ([more info](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/overview))

> [!NOTE]
> The runner will prioritize using the dashboard bundled with the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli), if it's installed.
> The runner will prioritize using the dashboard bundled with
> the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli) if it's installed, otherwise, The runner will
> download the dashboard to the user's `.dotnet` directory (`~/.dotnet/.AspireRunner`).
> [!IMPORTANT]
> While the runner itself targets .NET 6 (and later), the dashboard requires the .NET 8/9 runtime to run.
Expand Down
9 changes: 6 additions & 3 deletions src/AspireRunner.Tool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

A dotnet tool for downloading and running the standalone [Aspire Dashboard](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/standalone)

The dashboard can display OpenTelemetry data (traces, metrics, and logs) from any application ([more info](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/overview)).
The dashboard can display OpenTelemetry data (traces, metrics, and logs) from any
application ([more info](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/overview)).

[![NuGet Version](https://img.shields.io/nuget/vpre/AspireRunner.Tool?style=flat&logo=nuget&color=%230078d4&link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2FAspireRunner.Tool)](https://www.nuget.org/packages/AspireRunner.Tool)

Expand All @@ -14,7 +15,7 @@ dotnet tool install -g AspireRunner.Tool

## Usage

```
```console
aspire-dashboard <options>

Options:
Expand Down Expand Up @@ -48,4 +49,6 @@ Options:
```

> [!NOTE]
> The runner will prioritize using the dashboard bundled with the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli), if it's installed.
> The runner will prioritize using the dashboard bundled with
> the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli) if it's installed, otherwise, The runner will
> download the dashboard to the user's `.dotnet` directory (`~/.dotnet/.AspireRunner`).

0 comments on commit 4b11e01

Please sign in to comment.