You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -73,19 +73,19 @@ Ensure the `.NET Aspire SDK` component is checked in `Individual components`.
73
73
74
74
### Command line
75
75
76
-
1. The RTM nightly SDK is aware that the Aspire workload exists, but the real manifest is not installed by default. In order to install it, you'll need to update the workload in a directory that has a NuGet.config[^3] with the right feeds configured[^2] so that it can pull the latest manifest. Once you have created the NuGet.config file in your working directory, then you need to run the following command[^1]:
76
+
1. The RTM nightly SDK is aware that the .NET Aspire workload exists, but the real manifest is not installed by default. In order to install it, you'll need to update the workload in a directory that has a NuGet.config[^3] with the right feeds configured[^2] so that it can pull the latest manifest. Once you have created the NuGet.config file in your working directory, then you need to run the following command[^1]:
2. The above command will update the Aspire manifest in your SDK build, meaning it will already be setup for command-line and Visual Studio in-product acquisition (IPA) of the Aspire workload. In order to manually install the workload, you can run the following command[^1]:
82
+
2. The above command will update the .NET Aspire manifest in your SDK build, meaning it will already be setup for command-line and Visual Studio in-product acquisition (IPA) of the .NET Aspire workload. In order to manually install the workload, you can run the following command[^1]:
[^1]: The `--skip-sign-check` flag is required because the packages we build out of the Aspire repo are not yet signed.
88
+
[^1]: The `--skip-sign-check` flag is required because the packages we build out of the .NET Aspire repo are not yet signed.
89
89
[^2]: If you want to create a separate NuGet.config instead, these are the contents you need:
90
90
```xml
91
91
<?xml version="1.0" encoding="utf-8"?>
@@ -111,7 +111,7 @@ Ensure the `.NET Aspire SDK` component is checked in `Individual components`.
111
111
112
112
## Using command line using workload templates
113
113
114
-
- To create an empty Aspire project[^3], run the following command::
114
+
- To create an empty .NET Aspire project[^3], run the following command::
115
115
116
116
```shell
117
117
dotnet new aspire
@@ -123,7 +123,7 @@ Ensure the `.NET Aspire SDK` component is checked in `Individual components`.
123
123
dotnet new aspire-starter
124
124
```
125
125
126
-
[^3]: In order forthese commands to work, you must have already installed the Aspire workload by following the stepsin#Install-the-Aspire-dotnet-workload section.
126
+
[^3]: In order forthese commands to work, you must have already installed the .NET Aspire workload by following the stepsin#Install-the-Aspire-dotnet-workload section.
127
127
128
128
You need to create a `NuGet.config` file in the root directory of your project with the contents above.
Copy file name to clipboardexpand all lines: docs/open-telemetry-architecture.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Aspire OpenTelemetry architecture
1
+
# .NET Aspire OpenTelemetry architecture
2
2
3
-
One of Aspire's objectives is to ensure that apps are straightforward to debug and diagnose. By default, Aspire apps are configured to collect and export telemetry using [OpenTelemetry (OTEL)](https://opentelemetry.io/). Additionally, Aspire local development includes UI in the dashboard for viewing OTEL data. Telemetry just works and is easy to use.
3
+
One of .NET Aspire's objectives is to ensure that apps are straightforward to debug and diagnose. By default, .NET Aspire apps are configured to collect and export telemetry using [OpenTelemetry (OTEL)](https://opentelemetry.io/). Additionally, .NET Aspire local development includes UI in the dashboard for viewing OTEL data. Telemetry just works and is easy to use.
4
4
5
-
This document details how OpenTelemtry is used in Aspire apps.
5
+
This document details how OpenTelemtry is used in .NET Aspire apps.
6
6
7
7
## Telemetry types
8
8
@@ -18,7 +18,7 @@ When an OpenTelemetry SDK is configured in an app, it receives data from these A
18
18
19
19
The [.NET OpenTelemetry SDK](https://github.com/open-telemetry/opentelemetry-dotnet) offers features for gathering data from several .NET APIs, including `ILogger`, `Activity`, `Meter`, and `Instrument<T>`. It then facilitates the export of this telemetry data to a data store or reporting tool. The telemetry export mechanism relies on the [OpenTelemetry protocol (OTLP)](https://opentelemetry.io/docs/specs/otel/protocol/), which serves as a standardized approach for transmitting telemetry data through REST or gRPC.
20
20
21
-
.NET projects setup the .NET OpenTelemetry SDK using the _service defaults_ project. Aspire templates automatically create the service defaults, and Aspire apps call it at startup. The service defaults enable collecting and exporting telemetry for .NET apps.
21
+
.NET projects setup the .NET OpenTelemetry SDK using the _service defaults_ project. .NET Aspire templates automatically create the service defaults, and .NET Aspire apps call it at startup. The service defaults enable collecting and exporting telemetry for .NET apps.
22
22
23
23
## OpenTelemetry environment variables
24
24
@@ -32,24 +32,24 @@ Aspire apps launch with environment variables that configure the name and ID of
32
32
33
33
The environment variables are automatically set in local development.
34
34
35
-
## Aspire local development
35
+
## .NET Aspire local development
36
36
37
-
The Aspire dashboard provides UI for viewing the telemetry of apps. Telemetry data is sent to the dashboard using OTLP, and the dashboard implements an OTLP server to receive telemetry data and store it in memory. The dashboard UI presents telemetry stored in memory.
37
+
The .NET Aspire dashboard provides UI for viewing the telemetry of apps. Telemetry data is sent to the dashboard using OTLP, and the dashboard implements an OTLP server to receive telemetry data and store it in memory. The dashboard UI presents telemetry stored in memory.
38
38
39
39
Aspire debugging workflow:
40
40
41
-
* Developer starts the Aspire app with debugging, presses <kbd>F5</kbd>.
42
-
* Aspire dashboard and developer control plane (DCP) start.
41
+
* Developer starts the .NET Aspire app with debugging, presses <kbd>F5</kbd>.
42
+
*.NET Aspire dashboard and developer control plane (DCP) start.
43
43
* App configuration is run in the _AppHost_ project.
44
44
* OTEL environment variables are automatically added to .NET projects during app configuration.
45
45
* DCP provides the name (`OTEL_SERVICE_NAME`) and ID (`OTEL_RESOURCE_ATTRIBUTES`) of the app in exported telemetry.
46
46
* The OTLP endpoint is an HTTP/2 port started by the dashboard. This endpoint is set in the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable on each project. That tells projects to export telemetry back to the dashboard.
47
47
* Small export intervals (`OTEL_BSP_SCHEDULE_DELAY`, `OTEL_BLRP_SCHEDULE_DELAY`, `OTEL_METRIC_EXPORT_INTERVAL`) so data is quickly available in the dashboard. Small values are used in local development to prioritize dashboard responsiveness over efficiency.
48
48
* The DCP starts configured projects, containers, and executables.
49
49
* Once started, apps send telemetry to the dashboard.
50
-
* Dashboard displays near real-time telemetry of all Aspire apps.
50
+
* Dashboard displays near real-time telemetry of all .NET Aspire apps.
51
51
52
-
## Aspire deployment
52
+
## .NET Aspire deployment
53
53
54
54
Aspire deployment environments should configure OTEL environment variables that make sense for their environment. For example, `OTEL_EXPORTER_OTLP_ENDPOINT` should be configured to the environment's local OTLP collector or monitoring service.
Copy file name to clipboardexpand all lines: docs/specs/manifest-spec.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
# Manifest Specification for Aspire's Distributed Application Model
1
+
# Manifest Specification for .NET Aspire's Distributed Application Model
2
2
3
-
This is a specification for the manifest file for Aspire's Distributed Application Model. The purpose of the manifest file is to allow developers to export definitions of components that comprise their distributed application model and their dependencies so that other tools can process it to facilitate deployment into target runtime environments.
3
+
This is a specification for the manifest file for .NET Aspire's Distributed Application Model. The purpose of the manifest file is to allow developers to export definitions of components that comprise their distributed application model and their dependencies so that other tools can process it to facilitate deployment into target runtime environments.
4
4
5
5
The format of the manifest file itself does not pre-suppose a particular target environment but this document will make reference to specific cloud providers and technologies for illustrative purposes.
6
6
7
7
## Basic model
8
8
9
-
The Aspire distributed application model is comprised components which are typically deployed together as a unit. For example there may be a front-end ASP.NET Core application which calls into one or more backend services which in turn may depend on relational databases or caches. Consider the following sample (taken from the eShop light example):
9
+
The .NET Aspire distributed application model is comprised components which are typically deployed together as a unit. For example there may be a front-end ASP.NET Core application which calls into one or more backend services which in turn may depend on relational databases or caches. Consider the following sample (taken from the eShop light example):
Install the Aspire Azure Table storage library with [NuGet][nuget]:
14
+
Install the .NET Aspire Azure Table storage library with [NuGet][nuget]:
15
15
16
16
```dotnetcli
17
17
dotnet add package Aspire.Azure.Data.Tables
@@ -40,7 +40,7 @@ See the [Azure.Data.Tables documentation](https://github.com/Azure/azure-sdk-for
40
40
41
41
## Configuration
42
42
43
-
The Aspire Azure Table storage library provides multiple options to configure the Azure Table connection based on the requirements and conventions of your project. Note that either a `ServiceUri` or a `ConnectionString` is a required to be supplied.
43
+
The .NET Aspire Azure Table storage library provides multiple options to configure the Azure Table connection based on the requirements and conventions of your project. Note that either a `ServiceUri` or a `ConnectionString` is a required to be supplied.
@@ -40,7 +40,7 @@ See the [Azure.Messaging.ServiceBus documentation](https://github.com/Azure/azur
40
40
41
41
## Configuration
42
42
43
-
The Aspire Azure Service Bus library provides multiple options to configure the Azure Service Bus connection based on the requirements and conventions of your project. Note that either a `Namespace` or a `ConnectionString` is a required to be supplied.
43
+
The .NET Aspire Azure Service Bus library provides multiple options to configure the Azure Service Bus connection based on the requirements and conventions of your project. Note that either a `Namespace` or a `ConnectionString` is a required to be supplied.
44
44
45
45
### Use a connection string
46
46
@@ -78,7 +78,7 @@ Alternatively, a connection string can be used.
78
78
79
79
### Use configuration providers
80
80
81
-
The Aspire Azure Service Bus library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `AzureMessagingServiceBusSettings` and `ServiceBusClientOptions` from configuration by using the `Aspire:Azure:Messaging:ServiceBus` key. Example `appsettings.json` that configures some of the options:
81
+
The .NET Aspire Azure Service Bus library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `AzureMessagingServiceBusSettings` and `ServiceBusClientOptions` from configuration by using the `Aspire:Azure:Messaging:ServiceBus` key. Example `appsettings.json` that configures some of the options:
Copy file name to clipboardexpand all lines: src/Components/Aspire.Azure.Security.KeyVault/README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Retrieves secrets from Azure Key Vault to use in your application. Registers a [
11
11
12
12
### Install the package
13
13
14
-
Install the Aspire Azure Key Vault library with [NuGet][nuget]:
14
+
Install the .NET Aspire Azure Key Vault library with [NuGet][nuget]:
15
15
16
16
```dotnetcli
17
17
dotnet add package Aspire.Azure.Security.KeyVault
@@ -59,7 +59,7 @@ See the [Azure.Security.KeyVault.Secrets documentation](https://github.com/Azure
59
59
60
60
## Configuration
61
61
62
-
The Aspire Azure Key Vault library provides multiple options to configure the Azure Key Vault connection based on the requirements and conventions of your project. Note that the `VaultUri` is required to be supplied.
62
+
The .NET Aspire Azure Key Vault library provides multiple options to configure the Azure Key Vault connection based on the requirements and conventions of your project. Note that the `VaultUri` is required to be supplied.
63
63
64
64
### Use a connection string
65
65
@@ -81,7 +81,7 @@ And then the vault URI will be retrieved from the `ConnectionStrings` configurat
81
81
82
82
### Use configuration providers
83
83
84
-
The Aspire Azure Key Vault library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `AzureSecurityKeyVaultSettings` and `SecretClientOptions` from configuration by using the `Aspire:Azure:Security:KeyVault` key. Example `appsettings.json` that configures some of the options:
84
+
The .NET Aspire Azure Key Vault library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `AzureSecurityKeyVaultSettings` and `SecretClientOptions` from configuration by using the `Aspire:Azure:Security:KeyVault` key. Example `appsettings.json` that configures some of the options:
0 commit comments