Skip to content

Latest commit

 

History

History

ClientAppsIntegration

README.md

languages products page_type name urlFragment description
csharp
dotnet
dotnet-aspire
sample
.NET Aspire Client Apps Integration
aspire-client-apps-integration
An example of working with client apps (WinForms, WPF, etc.) in a .NET Aspire app.

Working with client apps in a .NET Aspire application

This sample demonstrates working with client apps such as WinForms, WPF, etc., in a .NET Aspire app, such that the client app is launched along with the AppHost project, can resolve services via service discovery, and logs, traces, and metrics via OpenTelemetry to the dashboard.

Screenshot of the WinForms app running and the Aspire dashboard behind it showing traces emitted from the client app.

The app is based on the Aspire Starter App template, with the following additional elements:

  • ClientAppsIntegration.WinForms: This is a WinForms application that displays the results of calling the weather API service application.
  • ClientAppsIntegration.WPF: This is a WPF application that displays the results of calling the weather API service application.
  • ClientAppsIntegration.AppDefaults: This is a class library that defines the default configuration for orchestrated apps. It's a more general version of the typical ServiceDefaults class library that's included in Aspire apps. The ClientAppsIntegration.WinForms and ClientAppsIntegration.WPF projects reference this project and calls its AddAppDefaults() method.
  • ClientAppsIntegration.ServiceDefaults: This has been modified from the default ServiceDefaults template to be based on and extend the ClientAppsIntegration.AppDefaults class library. The ClientAppsIntegration.ApiService project references this project and calls its AddServiceDefaults() method.

Pre-requisites

Running the app

Using Visual Studio, open the solution file ClientAppsIntegration.sln and launch/debug the ClientAppsIntegration.AppHost project.

In the launched WinForms and WPF app, click on "Load Weather" button to have the app call the backend weather API and populate the grid with the results. To explore the error condition behavior, check the "Force Error" checkbox and click on the "Load Weather" button again.

In the Aspire dashboard, use the logs, traces, and metrics pages to see telemtry emitted from the client apps.