From b786bf81ef001733ba530269109722f61e95c3b7 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 10 Oct 2025 11:28:53 -0700 Subject: [PATCH 1/2] .NET Aspire -> Aspire --- .../includes/ai-templates-github-models.md | 6 ++--- docs/architecture/maui/introduction.md | 4 ++-- docs/azure/index.yml | 4 ++-- docs/breadcrumb/toc.yml | 2 +- docs/core/apps.md | 2 +- .../diagnostics/observability-otlp-example.md | 2 +- .../diagnostics/observability-with-otel.md | 24 +++++++++---------- docs/core/extensions/generic-host.md | 2 +- docs/core/extensions/service-discovery.md | 2 +- docs/core/project-sdk/msbuild-props.md | 2 +- docs/core/project-sdk/overview.md | 4 ++-- docs/core/testing/unit-testing-mstest-sdk.md | 4 ++-- docs/core/whats-new/dotnet-10/overview.md | 4 ++-- docs/core/whats-new/dotnet-8/overview.md | 4 ++-- docs/core/whats-new/dotnet-9/overview.md | 4 ++-- docs/csharp/index.yml | 12 ++-------- .../includes/aspire-service-defaults.md | 4 ++-- .../includes/aspire-telemetry-overview.md | 6 ++--- .../networking/telemetry/metrics.md | 14 +++++------ .../networking/telemetry/tracing.md | 14 +++++------ docs/index.yml | 24 +++++-------------- docs/standard/glossary.md | 2 +- docs/welcome.md | 2 +- 23 files changed, 64 insertions(+), 84 deletions(-) diff --git a/docs/ai/quickstarts/includes/ai-templates-github-models.md b/docs/ai/quickstarts/includes/ai-templates-github-models.md index dfe02bce798a7..7c63af8f3c224 100644 --- a/docs/ai/quickstarts/includes/ai-templates-github-models.md +++ b/docs/ai/quickstarts/includes/ai-templates-github-models.md @@ -91,7 +91,7 @@ To authenticate to GitHub models from your code, you'll need to [create a GitHub The **AI Chat Web App** is almost ready to go as soon as it's created. However, you need to configure the app to use the personal access token you set up for GitHub Models. By default, the app template searches for this value in the project's local .NET user secrets. You can manage user secrets using either the Visual Studio UI or the .NET CLI. > [!NOTE] -> If you enabled .NET Aspire for your app, skip to the [.NET Aspire configuration](#net-aspire-configuration) section. +> If you enabled Aspire for your app, skip to the [Aspire configuration](#aspire-configuration) section. ## [Visual Studio](#tab/configure-visual-studio) @@ -117,9 +117,9 @@ The **AI Chat Web App** is almost ready to go as soon as it's created. However, --- -### .NET Aspire configuration +### Aspire configuration -To use the **AI Chat Web App** template with .NET Aspire orchestration, add the following configurations: +To use the **AI Chat Web App** template with Aspire orchestration, add the following configurations: #### [Visual Studio](#tab/configure-visual-studio-aspire) diff --git a/docs/architecture/maui/introduction.md b/docs/architecture/maui/introduction.md index 76e081f056b5e..6bd3ae73d4e6f 100644 --- a/docs/architecture/maui/introduction.md +++ b/docs/architecture/maui/introduction.md @@ -60,7 +60,7 @@ Below is a high-level overview of the architecture of the sample application. The sample application ships with: -- .NET Aspire App Hosting & Orchestration +- Aspire App Hosting & Orchestration - An Blazor web application developed with ASP.NET Core. - A multi-platform app developed with .NET MAUI, which supports iOS, Android, macOS via Mac Catalyst, and Windows. @@ -71,7 +71,7 @@ The sample application includes the following backend services: - An ordering microservice, which is a domain-driven service that uses domain-driven design patterns. - A basket microservice, which is a data-driven CRUD service that uses Redis Cache. -These backend services are implemented as microservices using ASP.NET Core, and are deployed as unique containers with .NET Aspire. Collectively, these backend services are referred to as the eShop reference application. Client apps communicate with the backend services through a Representational State Transfer (REST) web interface. For more information about microservices and containers, see [Containerized microservices](micro-services.md). +These backend services are implemented as microservices using ASP.NET Core, and are deployed as unique containers with Aspire. Collectively, these backend services are referred to as the eShop reference application. Client apps communicate with the backend services through a Representational State Transfer (REST) web interface. For more information about microservices and containers, see [Containerized microservices](micro-services.md). ## Multi-Platform app diff --git a/docs/azure/index.yml b/docs/azure/index.yml index cb7b699619bd2..e060bfa25ba5e 100644 --- a/docs/azure/index.yml +++ b/docs/azure/index.yml @@ -74,10 +74,10 @@ conceptualContent: links: - itemType: overview url: /dotnet/aspire/get-started/aspire-overview - text: Build cloud native apps using .NET Aspire + text: Build cloud native apps using Aspire - itemType: quickstart url: /dotnet/aspire/get-started/build-your-first-aspire-app?tabs=visual-studio - text: Build your first .NET Aspire app + text: Build your first Aspire app - itemType: quickstart text: Run and debug a microservice in Kubernetes url: /azure/dev-spaces/quickstart-netcore-visualstudio diff --git a/docs/breadcrumb/toc.yml b/docs/breadcrumb/toc.yml index 10381bab969e8..37e641f2aaf05 100644 --- a/docs/breadcrumb/toc.yml +++ b/docs/breadcrumb/toc.yml @@ -25,7 +25,7 @@ items: - name: Azure tocHref: /dotnet/azure/ topicHref: /dotnet/azure/index - - name: .NET Aspire + - name: Aspire tocHref: /dotnet/aspire/ topicHref: /dotnet/aspire/index - name: Orleans diff --git a/docs/core/apps.md b/docs/core/apps.md index 7e7f33702777d..8c5f33369b1cb 100644 --- a/docs/core/apps.md +++ b/docs/core/apps.md @@ -11,7 +11,7 @@ ms.custom: "updateeachrelease" ## Cloud apps -* [.NET Aspire](/dotnet/aspire) +* [Aspire](/dotnet/aspire) * [Serverless functions](/azure/azure-functions/functions-create-first-function-vs-code?pivots=programming-language-csharp) * [Web and microservices](/aspnet/core/introduction-to-aspnet-core#recommended-learning-path) diff --git a/docs/core/diagnostics/observability-otlp-example.md b/docs/core/diagnostics/observability-otlp-example.md index da49d7df305d2..46e37cc776293 100644 --- a/docs/core/diagnostics/observability-otlp-example.md +++ b/docs/core/diagnostics/observability-otlp-example.md @@ -10,7 +10,7 @@ ms.custom: sfi-image-nochange This is one of a series of examples to illustrate [.NET observability with OpenTelemetry](./observability-with-otel.md). -In addition to being a standard part of .NET Aspire, the Aspire Dashboard is available as a [standalone docker container](/dotnet/aspire/fundamentals/dashboard/standalone?tabs=powershell), which provides an OTLP endpoint telemetry can be sent to, and it will visualize the logs, metrics and traces. Using the dashboard in this way has no dependency on .NET Aspire, it will visualize telemetry from any application sending it telemetry via OTLP. It works equally well for applications written in Java, GoLang, Python etc. provided that they can send their telemetry to an OTLP endpoint. +In addition to being a standard part of Aspire, the Aspire Dashboard is available as a [standalone docker container](/dotnet/aspire/fundamentals/dashboard/standalone?tabs=powershell), which provides an OTLP endpoint telemetry can be sent to, and it will visualize the logs, metrics and traces. Using the dashboard in this way has no dependency on Aspire, it will visualize telemetry from any application sending it telemetry via OTLP. It works equally well for applications written in Java, GoLang, Python etc. provided that they can send their telemetry to an OTLP endpoint. Using the Aspire Dashboard has less configuration and setup steps than using Open Source solutions such as [Prometheus, Grafana and Jaeger](./observability-prgrja-example.md), but unlike those tools, the Aspire Dashboard is intended as a developer visualization tool, and not for production monitoring. diff --git a/docs/core/diagnostics/observability-with-otel.md b/docs/core/diagnostics/observability-with-otel.md index 349ab0c50fb32..277939a086f7a 100644 --- a/docs/core/diagnostics/observability-with-otel.md +++ b/docs/core/diagnostics/observability-with-otel.md @@ -95,27 +95,27 @@ This topic is continued with a couple of example walkthroughs for using OpenTele - [Example: Use OpenTelemetry with Azure Monitor and Application Insights](./observability-applicationinsights.md) - [Example: Use OpenTelemetry with Prometheus, Grafana, and Jaeger](./observability-prgrja-example.md) -## OpenTelemetry in .NET Aspire +## OpenTelemetry in Aspire -[.NET Aspire](/dotnet/aspire/get-started/aspire-overview) is a set of extensions to .NET to make it easy to create and work with distributed applications. One of the benefits of using .NET Aspire is that telemetry is built in, using the OpenTelemetry libraries for .NET. The default project templates for .NET Aspire contain a `ServiceDefaults` project, part of which is to setup and configure OTel. The Service Defaults project is referenced and initialized by each service in a .NET Aspire solution. +[Aspire](/dotnet/aspire/get-started/aspire-overview) is a set of extensions to .NET to make it easy to create and work with distributed applications. One of the benefits of using Aspire is that telemetry is built in, using the OpenTelemetry libraries for .NET. The default project templates for Aspire contain a `ServiceDefaults` project, part of which is to setup and configure OTel. The Service Defaults project is referenced and initialized by each service in an Aspire solution. -The Service Defaults project template includes the OTel SDK, ASP.NET, HttpClient and Runtime Instrumentation packages, and those are configured in the [`Extensions.cs`](https://github.com/dotnet/aspire/blob/main/src/Aspire.ProjectTemplates/templates/aspire-servicedefaults/9.5/Extensions.cs) file. For exporting telemetry .NET Aspire includes the OTLP exporter by default so that it can provide telemetry visualization using the Aspire Dashboard. +The Service Defaults project template includes the OTel SDK, ASP.NET, HttpClient and Runtime Instrumentation packages, and those are configured in the [`Extensions.cs`](https://github.com/dotnet/aspire/blob/main/src/Aspire.ProjectTemplates/templates/aspire-servicedefaults/9.5/Extensions.cs) file. For exporting telemetry, Aspire includes the OTLP exporter by default so that it can provide telemetry visualization using the Aspire Dashboard. -The Aspire Dashboard is designed to bring telemetry observation to the local debug cycle, which enables developers to not only ensure that the applications are producing telemetry, but also use that telemetry to diagnose those applications locally. Being able to observe the calls between services is proving to be just as useful at debug time as in production. The .NET Aspire dashboard is launched automatically when you F5 the `AppHost` Project from Visual Studio or `dotnet run` the `AppHost` project. +The Aspire Dashboard is designed to bring telemetry observation to the local debug cycle, which enables developers to not only ensure that the applications are producing telemetry, but also use that telemetry to diagnose those applications locally. Being able to observe the calls between services is proving to be just as useful at debug time as in production. The Aspire dashboard is launched automatically when you F5 the `AppHost` Project from Visual Studio or `dotnet run` the `AppHost` project. [![Aspire Dashboard](./media/aspire-dashboard-thumb.png)](./media/aspire-dashboard.png#lightbox) -For more details on .NET Aspire see: +For more details on Aspire see: - [Aspire Overview](/dotnet/aspire/get-started/aspire-overview) - [Telemetry in Aspire](/dotnet/aspire/fundamentals/telemetry) - [Aspire Dashboard](/dotnet/aspire/fundamentals/dashboard/explore) -### Reusing Service Defaults project without .NET Aspire Orchestration +### Reuse Service Defaults project without Aspire Orchestration -Probably the easiest way to configure OTel for ASP.NET projects is to use the Aspire Service Defaults project, even if not using the rest of .NET Aspire such as the AppHost for orchestration. The Service Defaults project is available as a project template via Visual Studio or `dotnet new`. It configures OTel and sets up the OTLP exporter. You can then use the [OTel environment variables](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Exporter.OpenTelemetryProtocol#exporter-configuration) to configure the OTLP endpoint to send telemetry to, and provide the resource properties for the application. +Probably the easiest way to configure OTel for ASP.NET projects is to use the Aspire Service Defaults project, even if not using the rest of Aspire such as the AppHost for orchestration. The Service Defaults project is available as a project template via Visual Studio or `dotnet new`. It configures OTel and sets up the OTLP exporter. You can then use the [OTel environment variables](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Exporter.OpenTelemetryProtocol#exporter-configuration) to configure the OTLP endpoint to send telemetry to, and provide the resource properties for the application. -The steps to use *ServiceDefaults* outside .NET Aspire are: +The steps to use *ServiceDefaults* outside Aspire are: - Add the *ServiceDefaults* project to the solution using Add New Project in Visual Studio, or use `dotnet new aspire-servicedefaults --output ServiceDefaults`. - Reference the *ServiceDefaults* project from your ASP.NET application. In Visual Studio use **Add** > **Project Reference** and select the *ServiceDefaults* project. @@ -132,8 +132,8 @@ app.MapGet("/", () => "Hello World!"); app.Run(); ``` -Service Defaults can setup the following additional functionality if required via `AddServiceDefaults()` or the specific functions: +Service Defaults can set up the following additional functionality, if required, via `AddServiceDefaults()` or the specific functions: -- Health checks with `/health` and `/alive` endpoints -- Service discovery which will be a no-op without the rest of .NET Aspire -- Configuring resilience for HttpClient which will retry the request in the case of failures +- Health checks with `/health` and `/alive` endpoints. +- Service discovery, which will be a no-op without the rest of Aspire. +- Configuring resilience for `HttpClient`, which retries requests in the case of failures. diff --git a/docs/core/extensions/generic-host.md b/docs/core/extensions/generic-host.md index 98afc87bc354f..0db8eae6e3766 100644 --- a/docs/core/extensions/generic-host.md +++ b/docs/core/extensions/generic-host.md @@ -131,7 +131,7 @@ When you call either : A builder for creating distributed apps. For more information, see [.NET Aspire](/dotnet/aspire). +- : A builder for creating distributed apps. For more information, see [Aspire](/dotnet/aspire). - : A builder for web applications and services. For more information, see [ASP.NET Core](/aspnet/core). - : A builder for `IWebHost`. For more information, see [ASP.NET Core web host](/aspnet/core/fundamentals/host/web-host). diff --git a/docs/core/extensions/service-discovery.md b/docs/core/extensions/service-discovery.md index b143f7f546664..3a190d7aef8e3 100644 --- a/docs/core/extensions/service-discovery.md +++ b/docs/core/extensions/service-discovery.md @@ -153,4 +153,4 @@ If service discovery was added to the host using the `AddServiceDiscoveryCore` e ## See also -- [Service discovery in .NET Aspire](/dotnet/aspire/service-discovery/overview) +- [Service discovery in Aspire](/dotnet/aspire/service-discovery/overview) diff --git a/docs/core/project-sdk/msbuild-props.md b/docs/core/project-sdk/msbuild-props.md index 1e76372aa4056..b6b76abfbaf5a 100644 --- a/docs/core/project-sdk/msbuild-props.md +++ b/docs/core/project-sdk/msbuild-props.md @@ -1509,7 +1509,7 @@ For more information, see [Enable or disable extensions](../testing/unit-testing When you use the [MSTest project SDK](../testing/unit-testing-mstest-sdk.md), you can use the `EnableAspireTesting` property to bring in all the dependencies and default `using` directives you need for testing with `Aspire` and `MSTest`. This property is available in MSTest 3.4 and later versions. -For more information, see [Test with .NET Aspire](../testing/unit-testing-mstest-sdk.md#test-with-net-aspire). +For more information, see [Test with Aspire](../testing/unit-testing-mstest-sdk.md#test-with-net-aspire). ### EnablePlaywright diff --git a/docs/core/project-sdk/overview.md b/docs/core/project-sdk/overview.md index 5827425149c38..657dc2dedadff 100644 --- a/docs/core/project-sdk/overview.md +++ b/docs/core/project-sdk/overview.md @@ -42,7 +42,7 @@ You can also author your own SDK that can be distributed via NuGet. ``` -The `Project/Sdk` attribute and `Sdk` element enable additive SDKs. Consider the following example, where the .NET Aspire SDK (`Aspire.AppHost.Sdk`) is added to the project atop the `Microsoft.NET.Sdk`: +The `Project/Sdk` attribute and `Sdk` element enable additive SDKs. Consider the following example, where the Aspire SDK (`Aspire.AppHost.Sdk`) is added to the project atop the `Microsoft.NET.Sdk`: ```xml @@ -53,7 +53,7 @@ The `Project/Sdk` attribute and `Sdk` element enable additive SDKs. Consider the ``` -In the preceding project file, both SDKs are used to resolve dependencies in an additive nature. For more information, see [.NET Aspire SDK](/dotnet/aspire/fundamentals/dotnet-aspire-sdk). +In the preceding project file, both SDKs are used to resolve dependencies in an additive nature. For more information, see [Aspire SDK](/dotnet/aspire/fundamentals/dotnet-aspire-sdk). To specify an SDK that comes from NuGet, include the version at the end of the name, or specify the name and version in the *global.json* file. diff --git a/docs/core/testing/unit-testing-mstest-sdk.md b/docs/core/testing/unit-testing-mstest-sdk.md index 026a397815c9e..713f8283a2762 100644 --- a/docs/core/testing/unit-testing-mstest-sdk.md +++ b/docs/core/testing/unit-testing-mstest-sdk.md @@ -178,9 +178,9 @@ You can also disable an extension that's coming from the selected profile. For e Outside of the selection of the runner and runner-specific extensions, `MSTest.Sdk` also provides additional features to simplify and enhance your testing experience. -### Test with .NET Aspire +### Test with Aspire -.NET Aspire is an opinionated, cloud-ready stack for building observable, production ready, distributed applications. .NET Aspire is delivered through a collection of NuGet packages that handle specific cloud-native concerns. For more information, see the [.NET Aspire docs](/dotnet/aspire/get-started/aspire-overview). +Aspire is an opinionated, cloud-ready stack for building observable, production ready, distributed applications. Aspire is delivered through a collection of NuGet packages that handle specific cloud-native concerns. For more information, see the [Aspire docs](/dotnet/aspire/get-started/aspire-overview). > [!NOTE] > This feature is available from MSTest.Sdk 3.4.0 diff --git a/docs/core/whats-new/dotnet-10/overview.md b/docs/core/whats-new/dotnet-10/overview.md index 12b375cd39ff5..f10a0d5596b7c 100644 --- a/docs/core/whats-new/dotnet-10/overview.md +++ b/docs/core/whats-new/dotnet-10/overview.md @@ -33,9 +33,9 @@ The .NET 10 SDK includes support for [Microsoft.Testing.Platform](../../testing/ For more information, see [What's new in the SDK for .NET 10](sdk.md). -## .NET Aspire +## Aspire -For information about what's new in .NET Aspire, see [.NET Aspire — what's new?](/dotnet/aspire/whats-new/). +For information about what's new in Aspire, see [Aspire — what's new?](/dotnet/aspire/whats-new/). ## ASP.NET Core diff --git a/docs/core/whats-new/dotnet-8/overview.md b/docs/core/whats-new/dotnet-8/overview.md index 4e2aa0349fcb4..84c911aef56cf 100644 --- a/docs/core/whats-new/dotnet-8/overview.md +++ b/docs/core/whats-new/dotnet-8/overview.md @@ -21,9 +21,9 @@ For information about what's new in the .NET SDK, code analysis, and diagnostics C# 12 shipped with the .NET 8 SDK. For more information, see [What's new in C# 12](../../../csharp/whats-new/csharp-12.md). -## .NET Aspire +## Aspire -.NET Aspire is an opinionated, cloud-ready stack for building observable, production ready, distributed applications.​ .NET Aspire is delivered through a collection of NuGet packages that handle specific cloud-native concerns, and is available in preview for .NET 8. For more information, see [.NET Aspire](/dotnet/aspire). +Aspire is an opinionated, cloud-ready stack for building observable, production ready, distributed applications.​ Aspire is delivered through a collection of NuGet packages that handle specific cloud-native concerns, and is available in preview for .NET 8. For more information, see [Aspire](/dotnet/aspire). ## ASP.NET Core diff --git a/docs/core/whats-new/dotnet-9/overview.md b/docs/core/whats-new/dotnet-9/overview.md index 7abf8cbf4c987..78bd4e7872d92 100644 --- a/docs/core/whats-new/dotnet-9/overview.md +++ b/docs/core/whats-new/dotnet-9/overview.md @@ -99,9 +99,9 @@ The latest release introduces significant new capabilities for tokenizers: - WordPiece - Bert (based on WordPiece) for Bert-supported models like optimum--all-MiniLM-L6-v2 -## .NET Aspire +## Aspire -.NET Aspire is a set of powerful tools, templates, and packages for building observable, production ready apps.​ .NET Aspire's latest release includes improvements to the dashboard and resource lifecycle management. It also adds new integrations and APIs for more flexibility during development. .NET Aspire 9 works with both .NET 9 and .NET 8 apps. For more information, see [What's new in .NET Aspire 9](/dotnet/aspire/whats-new/dotnet-aspire-9-release-candidate-1). +Aspire is a set of powerful tools, templates, and packages for building observable, production ready apps.​ Aspire's latest release includes improvements to the dashboard and resource lifecycle management. It also adds new integrations and APIs for more flexibility during development. Aspire 9 works with both .NET 9 and .NET 8 apps. For more information, see [What's new in Aspire 9](/dotnet/aspire/whats-new/dotnet-aspire-9-release-candidate-1). ## ASP.NET Core diff --git a/docs/csharp/index.yml b/docs/csharp/index.yml index 01074f06fd708..78df22d44e8d8 100644 --- a/docs/csharp/index.yml +++ b/docs/csharp/index.yml @@ -224,9 +224,9 @@ additionalContent: - url: ../azure/index.yml text: Azure for .NET developers - url: /dotnet/aspire - text: .NET Aspire + text: Aspire - url: /dotnet/aspire/get-started/quickstart-build-your-first-aspire-app - text: Build cloud-native apps with .NET Aspire + text: Build cloud-native apps with Aspire - url: ../azure/migration/app-service.md?preserve-view=true&view=azure-dotnet text: Migrate on-premises .NET web apps or services - url: ../azure/key-azure-services.md @@ -306,14 +306,6 @@ additionalContent: summary: API reference documentation for ASP.NET Core url: ../../api/index.md # Card - - title: ".NET Aspire API reference" - summary: Reference documentation for .NET Aspire - url: ../../api/index.md?view=dotnet-aspire-9.0&preserve-view=true - # Card - - title: "ML.NET API reference" - summary: API reference documentation for ML.NET - url: ../../api/index.md - # Card - title: ".NET Framework API reference" summary: API reference documentation for .NET Framework url: ../../api/index.md?view=netframework-4.8&preserve-view=true diff --git a/docs/fundamentals/networking/telemetry/includes/aspire-service-defaults.md b/docs/fundamentals/networking/telemetry/includes/aspire-service-defaults.md index 653c293128789..cf3513c2f7615 100644 --- a/docs/fundamentals/networking/telemetry/includes/aspire-service-defaults.md +++ b/docs/fundamentals/networking/telemetry/includes/aspire-service-defaults.md @@ -1,6 +1,6 @@ -The Aspire Service Defaults project provides an easy way to configure OTel for ASP.NET projects, *even if not using the rest of .NET Aspire* such as the AppHost for orchestration. The Service Defaults project is available as a project template via Visual Studio or `dotnet new`. It configures OTel and sets up the OTLP exporter. You can then use the [OTel environment variables](https://github.com/open-telemetry/opentelemetry-dotnet/tree/c94c422e31b2a5181a97b2dcf4bdc984f37ac1ff/src/OpenTelemetry.Exporter.OpenTelemetryProtocol#exporter-configuration) to configure the OTLP endpoint to send telemetry to, and provide the resource properties for the application. +The Aspire Service Defaults project provides an easy way to configure OTel for ASP.NET projects, *even if not using the rest of Aspire* such as the AppHost for orchestration. The Service Defaults project is available as a project template via Visual Studio or `dotnet new`. It configures OTel and sets up the OTLP exporter. You can then use the [OTel environment variables](https://github.com/open-telemetry/opentelemetry-dotnet/tree/c94c422e31b2a5181a97b2dcf4bdc984f37ac1ff/src/OpenTelemetry.Exporter.OpenTelemetryProtocol#exporter-configuration) to configure the OTLP endpoint to send telemetry to, and provide the resource properties for the application. -The steps to use *ServiceDefaults* outside .NET Aspire are: +The steps to use *ServiceDefaults* outside of Aspire are: 1. Add the *ServiceDefaults* project to the solution using Add New Project in Visual Studio, or use `dotnet new`: diff --git a/docs/fundamentals/networking/telemetry/includes/aspire-telemetry-overview.md b/docs/fundamentals/networking/telemetry/includes/aspire-telemetry-overview.md index c8f2739edf406..513ca6358297f 100644 --- a/docs/fundamentals/networking/telemetry/includes/aspire-telemetry-overview.md +++ b/docs/fundamentals/networking/telemetry/includes/aspire-telemetry-overview.md @@ -1,7 +1,7 @@ -A simple way to collect traces and metrics in ASP.NET applications is to use [.NET Aspire](/dotnet/aspire/get-started/aspire-overview). .NET Aspire is a set of extensions to .NET to make it easy to create and work with distributed applications. One of the benefits of using .NET Aspire is that telemetry is built in, using the OpenTelemetry libraries for .NET. +A simple way to collect traces and metrics in ASP.NET applications is to use [Aspire](/dotnet/aspire/get-started/aspire-overview). Aspire is a set of extensions to .NET to make it easy to create and work with distributed applications. One of the benefits of using Aspire is that telemetry is built in, using the OpenTelemetry libraries for .NET. -The default project templates for .NET Aspire contain a `ServiceDefaults` project. Each service in the .NET Aspire solution has a reference to the Service Defaults project. The services use it to set up and configure OTel. +The default project templates for Aspire contain a `ServiceDefaults` project. Each service in the Aspire solution has a reference to the Service Defaults project. The services use it to set up and configure OTel. The Service Defaults project template includes the OTel SDK, ASP.NET, HttpClient, and Runtime Instrumentation packages. These instrumentation components are configured in the [Extensions.cs](https://github.com/dotnet/aspire/blob/main/src/Aspire.ProjectTemplates/templates/aspire-servicedefaults/9.5/Extensions.cs) file. To support telemetry visualization in Aspire Dashboard, the Service Defaults project also includes the OTLP exporter by default. -Aspire Dashboard is designed to bring telemetry observation to the local debug cycle, which enables developers to ensure that the applications are producing telemetry. The telemetry visualization also helps to diagnose those applications locally. Being able to observe the calls between services is as useful at debug time as in production. The .NET Aspire dashboard is launched automatically when you F5 the `AppHost` Project from Visual Studio or `dotnet run` the `AppHost` project from command line. +Aspire Dashboard is designed to bring telemetry observation to the local debug cycle, which enables developers to ensure that the applications are producing telemetry. The telemetry visualization also helps to diagnose those applications locally. Being able to observe the calls between services is as useful at debug time as in production. The Aspire dashboard is launched automatically when you F5 the `AppHost` Project from Visual Studio or `dotnet run` the `AppHost` project from command line. diff --git a/docs/fundamentals/networking/telemetry/metrics.md b/docs/fundamentals/networking/telemetry/metrics.md index 4e525a9d66a4a..740c75332608b 100644 --- a/docs/fundamentals/networking/telemetry/metrics.md +++ b/docs/fundamentals/networking/telemetry/metrics.md @@ -25,7 +25,7 @@ There are several ways to collect networking metrics in .NET. - For a quick overview using a simple, self-contained example, see [Collect metrics with dotnet-counters](#collect-metrics-with-dotnet-counters). - For **production-time** metrics collection and monitoring, you can use [Grafana with OpenTelemetry and Prometheus](#view-metrics-in-grafana-with-opentelemetry-and-prometheus) or [Azure Monitor Application Insights](../../../core/diagnostics/observability-applicationinsights.md). However, these tools might be inconvenient to use at development time because of their complexity. -- For **development-time** metrics collection and troubleshooting, we recommend using [.NET Aspire](#collect-metrics-with-net-aspire), which provides a simple but extensible way to kickstart metrics and distributed tracing in your application and to diagnose issues locally. +- For **development-time** metrics collection and troubleshooting, we recommend using [Aspire](#collect-metrics-with-net-aspire), which provides a simple but extensible way to kickstart metrics and distributed tracing in your application and to diagnose issues locally. - It's also possible to [reuse the Aspire Service Defaults](#reuse-service-defaults-project-without-net-aspire-orchestration) project without the Aspire orchestration, which is a handy way to introduce the OpenTelemetry tracing and metrics configuration APIs into your ASP.NET project. ### Collect metrics with dotnet-counters @@ -63,21 +63,21 @@ dotnet-counters monitor --counters System.Net.Http,System.Net.NameResolution -n ![`dotnet-counters` output](media/dotnet-counters.png) -### Collect metrics with .NET Aspire +### Collect metrics with Aspire [!INCLUDE[Aspire Telemetry Overview](./includes/aspire-telemetry-overview.md)] #### Quick walkthrough -1. Create a **.NET Aspire 9 Starter App** by using `dotnet new`: +1. Create an **Aspire 9 Starter App** by using `dotnet new`: ```dotnetcli dotnet new aspire-starter-9 --output AspireDemo ``` - Or in Visual Studio, create a new project and select the **.NET Aspire 9 Starter App** template: + Or in Visual Studio, create a new project and select the **Aspire 9 Starter App** template: - ![Create a .NET Aspire 9 Starter App in Visual Studio](media/aspire-starter.png) + ![Create an Aspire 9 Starter App in Visual Studio](media/aspire-starter.png) 1. Open `Extensions.cs` in the `ServiceDefaults` project, and scroll to the `ConfigureOpenTelemetry` method. Notice the `AddHttpClientInstrumentation()` call subscribing to the networking meters. @@ -103,13 +103,13 @@ dotnet-counters monitor --counters System.Net.Http,System.Net.NameResolution -n [![Networking metrics in Aspire Dashboard](media/aspire-metrics-thumb.png)](media/aspire-metrics.png#lightbox) -For more information on .NET Aspire, see: +For more information on Aspire, see: - [Aspire Overview](/dotnet/aspire/get-started/aspire-overview) - [Telemetry in Aspire](/dotnet/aspire/fundamentals/telemetry) - [Aspire Dashboard](/dotnet/aspire/fundamentals/dashboard/explore) -### Reuse Service Defaults project without .NET Aspire orchestration +### Reuse Service Defaults project without Aspire orchestration [!INCLUDE[Aspire Service Defaults](./includes/aspire-service-defaults.md)] diff --git a/docs/fundamentals/networking/telemetry/tracing.md b/docs/fundamentals/networking/telemetry/tracing.md index 54fa688d35d78..ef125db3606a5 100644 --- a/docs/fundamentals/networking/telemetry/tracing.md +++ b/docs/fundamentals/networking/telemetry/tracing.md @@ -35,22 +35,22 @@ However, as an application developer, you would likely prefer to rely on the ric - To get a fundamental understanding on trace collection with OTel, see our guide on [collecting traces using OpenTelemetry](../../../core/diagnostics/distributed-tracing-collection-walkthroughs.md#collect-traces-using-opentelemetry). - For **production-time** trace collection and monitoring, you can use OpenTelemetry with [Prometheus, Grafana, and Jaeger](../../../core/diagnostics/observability-prgrja-example.md) or with [Azure Monitor and Application Insights](../../../core/diagnostics/observability-applicationinsights.md). However, these tools are quite complex and might be inconvenient to use at development time. -- For **development-time** trace collection and monitoring, we recommend using [.NET Aspire](#collect-traces-with-net-aspire) which provides a simple but extensible way to kickstart distributed tracing in your application and to diagnose issues locally. +- For **development-time** trace collection and monitoring, we recommend using [Aspire](#collect-traces-with-net-aspire) which provides a simple but extensible way to kickstart distributed tracing in your application and to diagnose issues locally. - It's also possible to [reuse the Aspire Service Defaults](#reuse-service-defaults-project-without-net-aspire-orchestration) project without the Aspire orchestration. This is a handy way to introduce and configure OpenTelemetry tracing and metrics in your ASP.NET projects. -### Collect traces with .NET Aspire +### Collect traces with Aspire [!INCLUDE[Aspire Telemetry Overview](./includes/aspire-telemetry-overview.md)] [![Aspire Dashboard](../../../core/diagnostics/media/aspire-dashboard-thumb.png)](../../../core/diagnostics/media/aspire-dashboard.png#lightbox) -For more information on .NET Aspire, see: +For more information on Aspire, see: - [Aspire Overview](/dotnet/aspire/get-started/aspire-overview) - [Telemetry in Aspire](/dotnet/aspire/fundamentals/telemetry) - [Aspire Dashboard](/dotnet/aspire/fundamentals/dashboard/explore) -### Reuse Service Defaults project without .NET Aspire Orchestration +### Reuse Service Defaults project without Aspire Orchestration [!INCLUDE[Aspire Service Defaults](./includes/aspire-service-defaults.md)] @@ -88,7 +88,7 @@ The following diagram illustrates the behavior of the spans and their relationsh This walkthrough uses a [.NET 9 Aspire Starter App](/dotnet/aspire/get-started/build-your-first-aspire-app) to demonstrate connection tracing, but it should be easy to set it up with [other monitoring tools](#collect-systemnet-traces) as well. The key step is to enable the ActivitySources. -1. Create a **.NET Aspire 9 Starter App** by using `dotnet new`: +1. Create an **Aspire 9 Starter App** by using `dotnet new`: ```dotnetcli dotnet new aspire-starter-9 --output ConnectionTracingDemo @@ -96,13 +96,13 @@ This walkthrough uses a [.NET 9 Aspire Starter App](/dotnet/aspire/get-started/b Or in Visual Studio: - ![Create a .NET Aspire 9 Starter App in Visual Studio](media/aspire-starter.png) + ![Create an Aspire 9 Starter App in Visual Studio](media/aspire-starter.png) 1. Open `Extensions.cs` in the `ServiceDefaults` project, and edit the `ConfigureOpenTelemetry` method adding the ActivitySources for connection in the tracing configuration callback: :::code language="csharp" source="snippets/tracing/ConnectionTracingDemo.ServiceDefaults/Extensions.cs" id="snippet_ConnectionTracing"::: -1. Start the solution. This should open the [.NET Aspire Dashboard](/dotnet/aspire/fundamentals/dashboard/overview). +1. Start the solution. This should open the [Aspire Dashboard](/dotnet/aspire/fundamentals/dashboard/overview). 1. Navigate to the Weather page of the `webfrontend` app to generate an `HttpClient` request towards `apiservice`. diff --git a/docs/index.yml b/docs/index.yml index 59be61d2d04a3..c07a5ed33bfd4 100644 --- a/docs/index.yml +++ b/docs/index.yml @@ -32,10 +32,6 @@ highlightedContent: itemType: overview url: ai/index.yml # Card - - title: .NET Aspire - itemType: overview - url: /dotnet/aspire - # Card - title: "Build .NET apps with C#" itemType: learn url: /training/paths/build-dotnet-applications-csharp @@ -125,7 +121,7 @@ conceptualContent: text: Build cloud-native .NET apps with Orleans - url: /dotnet/aspire/get-started/quickstart-build-your-first-aspire-app itemType: quickstart - text: Build cloud-native apps with .NET Aspire + text: Build cloud-native apps with Aspire - url: core/docker/build-container.md itemType: tutorial text: Containerize .NET apps with Docker @@ -298,7 +294,7 @@ additionalContent: - url: azure/index.yml text: Azure for .NET developers - url: /dotnet/aspire - text: .NET Aspire + text: Aspire - url: ./azure/migration/app-service.md?preserve-view=true&view=azure-dotnet text: Migrate on-premises .NET web apps or services - url: ./azure/key-azure-services.md @@ -359,22 +355,10 @@ additionalContent: summary: API reference documentation for .NET url: ../api/index.md?view=net-9.0 # Card - - title: ".NET Framework API reference" - summary: API reference documentation for .NET Framework - url: ../api/index.md?view=netframework-4.8&preserve-view=true - # Card - title: "ASP.NET Core API reference" summary: API reference documentation for ASP.NET Core url: ../api/index.md?view=view=aspnetcore-9.0&preserve-view=true # Card - - title: "ML.NET API reference" - summary: API reference documentation for ML.NET - url: ../api/index.md?view=ml-dotnet&preserve-view=true - # Card - - title: ".NET Aspire API reference" - summary: Reference documentation for .NET Aspire - url: ../api/index.md?view=dotnet-aspire-9.0&preserve-view=true - # Card - title: "C# language reference" summary: C# language reference and specification url: csharp/language-reference/index.yml @@ -386,6 +370,10 @@ additionalContent: - title: "Visual Basic language reference" summary: Visual Basic language reference and specification url: visual-basic/language-reference/index.md + # Card + - title: ".NET Framework API reference" + summary: API reference documentation for .NET Framework + url: ../api/index.md?view=netframework-4.8&preserve-view=true # footer (optional) footer: "Are you interested in contributing to the .NET docs? For more information, see our [contributor guide](/contribute/dotnet/dotnet-contribute)." diff --git a/docs/standard/glossary.md b/docs/standard/glossary.md index 52400145ca418..f3e4e043ee1ae 100644 --- a/docs/standard/glossary.md +++ b/docs/standard/glossary.md @@ -20,7 +20,7 @@ See [CoreRT](#corert) and [.NET Native](#net-native). A [workload](#workload)-specific API. Here are some examples: -- .NET Aspire +- Aspire - ASP.NET - ASP.NET Web API - Entity Framework (EF) diff --git a/docs/welcome.md b/docs/welcome.md index 25b010e2e63b3..54da27453c9a5 100644 --- a/docs/welcome.md +++ b/docs/welcome.md @@ -57,7 +57,7 @@ This documentation is completely [open source](https://github.com/dotnet/docs). - [.NET runtime](https://github.com/dotnet/runtime) - [.NET SDK](https://github.com/dotnet/sdk) - [.NET extensions](https://github.com/dotnet/extensions) -- [.NET Aspire](https://github.com/dotnet/aspire) +- [Aspire](https://github.com/dotnet/aspire) - [Roslyn (C# and Visual Basic) Compiler Platform and IDE Tools](https://github.com/dotnet/roslyn) - [.NET code analyzers](https://github.com/dotnet/roslyn-analyzers) - [F# Compiler and IDE Tools](https://github.com/dotnet/fsharp) From 65b1c2e18e9dc57ba26ffc20b6c42ced2e27392a Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 10 Oct 2025 14:01:45 -0700 Subject: [PATCH 2/2] fix build warnings --- docs/core/project-sdk/msbuild-props.md | 2 +- docs/fundamentals/networking/telemetry/metrics.md | 4 ++-- docs/fundamentals/networking/telemetry/tracing.md | 4 ++-- docs/index.yml | 4 ++++ 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/core/project-sdk/msbuild-props.md b/docs/core/project-sdk/msbuild-props.md index b6b76abfbaf5a..ab35dd0f8a409 100644 --- a/docs/core/project-sdk/msbuild-props.md +++ b/docs/core/project-sdk/msbuild-props.md @@ -1509,7 +1509,7 @@ For more information, see [Enable or disable extensions](../testing/unit-testing When you use the [MSTest project SDK](../testing/unit-testing-mstest-sdk.md), you can use the `EnableAspireTesting` property to bring in all the dependencies and default `using` directives you need for testing with `Aspire` and `MSTest`. This property is available in MSTest 3.4 and later versions. -For more information, see [Test with Aspire](../testing/unit-testing-mstest-sdk.md#test-with-net-aspire). +For more information, see [Test with Aspire](../testing/unit-testing-mstest-sdk.md#test-with-aspire). ### EnablePlaywright diff --git a/docs/fundamentals/networking/telemetry/metrics.md b/docs/fundamentals/networking/telemetry/metrics.md index 740c75332608b..d8eb57bea50fb 100644 --- a/docs/fundamentals/networking/telemetry/metrics.md +++ b/docs/fundamentals/networking/telemetry/metrics.md @@ -25,8 +25,8 @@ There are several ways to collect networking metrics in .NET. - For a quick overview using a simple, self-contained example, see [Collect metrics with dotnet-counters](#collect-metrics-with-dotnet-counters). - For **production-time** metrics collection and monitoring, you can use [Grafana with OpenTelemetry and Prometheus](#view-metrics-in-grafana-with-opentelemetry-and-prometheus) or [Azure Monitor Application Insights](../../../core/diagnostics/observability-applicationinsights.md). However, these tools might be inconvenient to use at development time because of their complexity. -- For **development-time** metrics collection and troubleshooting, we recommend using [Aspire](#collect-metrics-with-net-aspire), which provides a simple but extensible way to kickstart metrics and distributed tracing in your application and to diagnose issues locally. -- It's also possible to [reuse the Aspire Service Defaults](#reuse-service-defaults-project-without-net-aspire-orchestration) project without the Aspire orchestration, which is a handy way to introduce the OpenTelemetry tracing and metrics configuration APIs into your ASP.NET project. +- For **development-time** metrics collection and troubleshooting, we recommend using [Aspire](#collect-metrics-with-aspire), which provides a simple but extensible way to kickstart metrics and distributed tracing in your application and to diagnose issues locally. +- It's also possible to [reuse the Aspire Service Defaults](#reuse-service-defaults-project-without-aspire-orchestration) project without the Aspire orchestration, which is a handy way to introduce the OpenTelemetry tracing and metrics configuration APIs into your ASP.NET project. ### Collect metrics with dotnet-counters diff --git a/docs/fundamentals/networking/telemetry/tracing.md b/docs/fundamentals/networking/telemetry/tracing.md index ef125db3606a5..afc82e50e26ce 100644 --- a/docs/fundamentals/networking/telemetry/tracing.md +++ b/docs/fundamentals/networking/telemetry/tracing.md @@ -35,8 +35,8 @@ However, as an application developer, you would likely prefer to rely on the ric - To get a fundamental understanding on trace collection with OTel, see our guide on [collecting traces using OpenTelemetry](../../../core/diagnostics/distributed-tracing-collection-walkthroughs.md#collect-traces-using-opentelemetry). - For **production-time** trace collection and monitoring, you can use OpenTelemetry with [Prometheus, Grafana, and Jaeger](../../../core/diagnostics/observability-prgrja-example.md) or with [Azure Monitor and Application Insights](../../../core/diagnostics/observability-applicationinsights.md). However, these tools are quite complex and might be inconvenient to use at development time. -- For **development-time** trace collection and monitoring, we recommend using [Aspire](#collect-traces-with-net-aspire) which provides a simple but extensible way to kickstart distributed tracing in your application and to diagnose issues locally. -- It's also possible to [reuse the Aspire Service Defaults](#reuse-service-defaults-project-without-net-aspire-orchestration) project without the Aspire orchestration. This is a handy way to introduce and configure OpenTelemetry tracing and metrics in your ASP.NET projects. +- For **development-time** trace collection and monitoring, we recommend using [Aspire](#collect-traces-with-aspire) which provides a simple but extensible way to kickstart distributed tracing in your application and to diagnose issues locally. +- It's also possible to [reuse the Aspire Service Defaults](#reuse-service-defaults-project-without-aspire-orchestration) project without the Aspire orchestration. This is a handy way to introduce and configure OpenTelemetry tracing and metrics in your ASP.NET projects. ### Collect traces with Aspire diff --git a/docs/index.yml b/docs/index.yml index c07a5ed33bfd4..8a30b9bde4abf 100644 --- a/docs/index.yml +++ b/docs/index.yml @@ -32,6 +32,10 @@ highlightedContent: itemType: overview url: ai/index.yml # Card + - title: Aspire + itemType: overview + url: /dotnet/aspire + # Card - title: "Build .NET apps with C#" itemType: learn url: /training/paths/build-dotnet-applications-csharp