diff --git a/Client.Wasm/Components/StudentCard.razor b/Client.Wasm/Components/StudentCard.razor index 661f118..10ea29e 100644 --- a/Client.Wasm/Components/StudentCard.razor +++ b/Client.Wasm/Components/StudentCard.razor @@ -4,10 +4,10 @@ - Номер №X "Название лабораторной" - Вариант №Х "Название варианта" - Выполнена Фамилией Именем 65ХХ - Ссылка на форк + Номер №1 "Кэширование" + Вариант №27 "Транспортное средство" + Выполнила Лаврук Маргарита 6512 + Ссылка на форк diff --git a/Client.Wasm/Properties/launchSettings.json b/Client.Wasm/Properties/launchSettings.json index 0d824ea..60120ec 100644 --- a/Client.Wasm/Properties/launchSettings.json +++ b/Client.Wasm/Properties/launchSettings.json @@ -12,7 +12,7 @@ "http": { "commandName": "Project", "dotnetRunMessages": true, - "launchBrowser": true, + "launchBrowser": false, "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}", "applicationUrl": "http://localhost:5127", "environmentVariables": { @@ -22,7 +22,7 @@ "https": { "commandName": "Project", "dotnetRunMessages": true, - "launchBrowser": true, + "launchBrowser": false, "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}", "applicationUrl": "https://localhost:7282;http://localhost:5127", "environmentVariables": { @@ -31,7 +31,7 @@ }, "IIS Express": { "commandName": "IISExpress", - "launchBrowser": true, + "launchBrowser": false, "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" diff --git a/Client.Wasm/wwwroot/appsettings.json b/Client.Wasm/wwwroot/appsettings.json index d1fe7ab..2859870 100644 --- a/Client.Wasm/wwwroot/appsettings.json +++ b/Client.Wasm/wwwroot/appsettings.json @@ -6,5 +6,5 @@ } }, "AllowedHosts": "*", - "BaseAddress": "" + "BaseAddress": "https://localhost:7283/api/vehicle" } diff --git a/CloudDevelopment.sln b/CloudDevelopment.sln index cb48241..5d0b142 100644 --- a/CloudDevelopment.sln +++ b/CloudDevelopment.sln @@ -5,6 +5,12 @@ VisualStudioVersion = 17.14.36811.4 MinimumVisualStudioVersion = 10.0.40219.1 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Client.Wasm", "Client.Wasm\Client.Wasm.csproj", "{AE7EEA74-2FE0-136F-D797-854FD87E022A}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VehicleVault.AppHost", "VehicleVault\VehicleVault.AppHost\VehicleVault.AppHost.csproj", "{675E2979-6231-45C9-A79D-E8D1BE095D7E}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VehicleVault.ServiceDefaults", "VehicleVault\VehicleVault.ServiceDefaults\VehicleVault.ServiceDefaults.csproj", "{2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VehicleVault.Api", "VehicleVault.Api\VehicleVault.Api.csproj", "{EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -15,6 +21,18 @@ Global {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Debug|Any CPU.Build.0 = Debug|Any CPU {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|Any CPU.ActiveCfg = Release|Any CPU {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|Any CPU.Build.0 = Release|Any CPU + {675E2979-6231-45C9-A79D-E8D1BE095D7E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {675E2979-6231-45C9-A79D-E8D1BE095D7E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {675E2979-6231-45C9-A79D-E8D1BE095D7E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {675E2979-6231-45C9-A79D-E8D1BE095D7E}.Release|Any CPU.Build.0 = Release|Any CPU + {2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}.Release|Any CPU.Build.0 = Release|Any CPU + {EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/README.md b/README.md index dcaa5eb..8e632c2 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,45 @@ -# Современные технологии разработки программного обеспечения -[Таблица с успеваемостью](https://docs.google.com/spreadsheets/d/1an43o-iqlq4V_kDtkr_y7DC221hY9qdhGPrpII27sH8/edit?usp=sharing) +# Лабораторная работа №1 «Кэширование» -## Задание -### Цель -Реализация проекта микросервисного бекенда. +## Описание -### Задачи -* Реализация межсервисной коммуникации, -* Изучение работы с брокерами сообщений, -* Изучение архитектурных паттернов, -* Изучение работы со средствами оркестрации на примере .NET Aspire, -* Повторение основ работы с системами контроля версий, -* Интеграционное тестирование. +Реализация сервиса генерации данных о транспортных средствах с кэшированием ответов в Redis. +Оркестрация проектов при помощи .NET Aspire. -### Лабораторные работы -
-1. «Кэширование» - Реализация сервиса генерации контрактов, кэширование его ответов -
- -В рамках первой лабораторной работы необходимо: -* Реализовать сервис генерации контрактов на основе Bogus, -* Реализовать кеширование при помощи IDistributedCache и Redis, -* Реализовать структурное логирование сервиса генерации, -* Настроить оркестрацию Aspire. - -
-
-2. «Балансировка нагрузки» - Реализация апи гейтвея, настройка его работы -
- -В рамках второй лабораторной работы необходимо: -* Настроить оркестрацию на запуск нескольких реплик сервиса генерации, -* Реализовать апи гейтвей на основе Ocelot, -* Имплементировать алгоритм балансировки нагрузки согласно варианту. +## Технологии -
-
-
-3. «Интеграционное тестирование» - Реализация файлового сервиса и объектного хранилища, интеграционное тестирование бекенда -
+- .NET 8 +- .NET Aspire 9.5 +- Bogus — генерация фейковых данных +- Redis — распределённое кэширование (`IDistributedCache`) +- Blazor WebAssembly — клиентское приложение +- Blazorise — UI-компоненты +- OpenTelemetry — структурное логирование и трассировка -В рамках третьей лабораторной работы необходимо: -* Добавить в оркестрацию объектное хранилище, -* Реализовать файловый сервис, сериализующий сгенерированные данные в файлы и сохраняющий их в объектном хранилище, -* Реализовать отправку генерируемых данных в файловый сервис посредством брокера, -* Реализовать интеграционные тесты, проверяющие корректность работы всех сервисов бекенда вместе. +## Характеристики генерируемого объекта -
-
-
-4. (Опционально) «Переход на облачную инфраструктуру» - Перенос бекенда в Yandex Cloud -
- -В рамках четвертой лабораторной работы необходимо перенестиервисы на облако все ранее разработанные сервисы: -* Клиент - в хостинг через отдельный бакет Object Storage, -* Сервис генерации - в Cloud Function, -* Апи гейтвей - в Serverless Integration как API Gateway, -* Брокер сообщений - в Message Queue, -* Файловый сервис - в Cloud Function, -* Объектное хранилище - в отдельный бакет Object Storage, +| № | Характеристика | Тип данных | Источник Bogus | +|---|---|---|---| +| 1 | Идентификатор в системе | `int` | Параметр запроса | +| 2 | VIN-номер | `string` | `Vehicle.Vin()` | +| 3 | Производитель | `string` | `Vehicle.Manufacturer()` | +| 4 | Модель | `string` | `Vehicle.Model()` | +| 5 | Год выпуска | `int` | `Random.Int(1960, текущий год)` | +| 6 | Тип корпуса | `string` | `Vehicle.Type()` | +| 7 | Тип топлива | `string` | `Vehicle.Fuel()` | +| 8 | Цвет корпуса | `string` | `Commerce.Color()` | +| 9 | Пробег | `double` | `Random.Double(0, 1000000)` | +| 10 | Дата последнего техобслуживания | `DateOnly` | Между годом выпуска и текущей датой | -
-
+### Кэширование -## Задание. Общая часть -**Обязательно**: -* Реализация серверной части на [.NET 8](https://learn.microsoft.com/ru-ru/dotnet/core/whats-new/dotnet-8/overview). -* Оркестрация проектов при помощи [.NET Aspire](https://learn.microsoft.com/ru-ru/dotnet/aspire/get-started/aspire-overview). -* Реализация сервиса генерации данных при помощи [Bogus](https://github.com/bchavez/Bogus). -* Реализация тестов с использованием [xUnit](https://xunit.net/?tabs=cs). -* Создание минимальной документации к проекту: страница на GitHub с информацией о задании, скриншоты приложения и прочая информация. +- Ключ кэша: `vehicle:{id}` +- Время жизни: настраивается в `appsettings.json` (`Cache:ExpirationMinutes`, по умолчанию 5 минут) +- При ошибке чтения/записи кэша — логируется warning, запрос обрабатывается без кэша -**Факультативно**: -* Перенос бекенда на облачную инфраструктуру Yandex Cloud +## API -Внимательно прочитайте [дискуссии](https://github.com/itsecd/cloud-development/discussions/1) о том, как работает автоматическое распределение на ревью. -Сразу корректно называйте свои pr, чтобы они попали на ревью нужному преподавателю. - -По итогу работы в семестре должна получиться следующая информационная система: -
-C4 диаграмма -Современные_технологии_разработки_ПО_drawio -
- -## Варианты заданий -Номер варианта задания присваивается в начале семестра. Изменить его нельзя. Каждый вариант имеет уникальную комбинацию из предметной области, базы данных и технологии для общения сервиса генерации данных и сервера апи. - -[Список вариантов](https://docs.google.com/document/d/1WGmLYwffTTaAj4TgFCk5bUyW3XKbFMiBm-DHZrfFWr4/edit?usp=sharing) -[Список предметных областей и алгоритмов балансировки](https://docs.google.com/document/d/1PLn2lKe4swIdJDZhwBYzxqFSu0AbY2MFY1SUPkIKOM4/edit?usp=sharing) - -## Схема сдачи - -На каждую из лабораторных работ необходимо сделать отдельный [Pull Request (PR)](https://docs.github.com/en/pull-requests). - -Общая схема: -1. Сделать форк данного репозитория -2. Выполнить задание -3. Сделать PR в данный репозиторий -4. Исправить замечания после code review -5. Получить approve - -## Критерии оценивания - -Конкурентный принцип. -Так как задания в первой лабораторной будут повторяться между студентами, то выделяются следующие показатели для оценки: -1. Скорость разработки -2. Качество разработки -3. Полнота выполнения задания - -Быстрее делаете PR - у вас преимущество. -Быстрее получаете Approve - у вас преимущество. -Выполните нечто немного выходящее за рамки проекта - у вас преимущество. -Не укладываетесь в дедлайн - получаете минимально возможный балл. - -### Шкала оценивания - -- **3 балла** за качество кода, из них: - - 2 балла - базовая оценка - - 1 балл (но не более) можно получить за выполнение любого из следующих пунктов: - - Реализация факультативного функционала - - Выполнение работы раньше других: первые 5 человек из каждой группы, которые сделали PR и получили approve, получают дополнительный балл - -## Вопросы и обратная связь по курсу - -Чтобы задать вопрос по лабораторной, воспользуйтесь [соответствующим разделом дискуссий](https://github.com/itsecd/cloud-development/discussions/categories/questions) или заведите [ишью](https://github.com/itsecd/cloud-development/issues/new). -Если у вас появились идеи/пожелания/прочие полезные мысли по преподаваемой дисциплине, их можно оставить [здесь](https://github.com/itsecd/cloud-development/discussions/categories/ideas). +``` +GET /api/vehicle?id={id} +``` +Возвращает JSON с данными транспортного средства. При повторном запросе с тем же `id` — данные берутся из кэша Redis. diff --git a/VehicleVault.Api/Entities/Vehicle.cs b/VehicleVault.Api/Entities/Vehicle.cs new file mode 100644 index 0000000..f04911c --- /dev/null +++ b/VehicleVault.Api/Entities/Vehicle.cs @@ -0,0 +1,57 @@ +namespace VehicleVault.Api.Entities; + +/// +/// Транспортное средство +/// +public class Vehicle +{ + /// + /// Идентификатор в системе + /// + public int SystemId { get; set; } + + /// + /// VIN-номер + /// + public required string Vin { get; set; } + + /// + /// Производитель + /// + public required string Manufacturer { get; set; } + + /// + /// Модель + /// + public required string Model { get; set; } + + /// + /// Год выпуска + /// + public int Year { get; set; } + + /// + /// Тип корпуса + /// + public required string BodyType { get; set; } + + /// + /// Тип топлива + /// + public required string FuelType { get; set; } + + /// + /// Цвет корпуса + /// + public required string BodyColor { get; set; } + + /// + /// Пробег + /// + public double Mileage { get; set; } + + /// + /// Дата последнего техобслуживания + /// + public DateOnly LastServiceDate { get; set; } +} diff --git a/VehicleVault.Api/Program.cs b/VehicleVault.Api/Program.cs new file mode 100644 index 0000000..9b4f3d2 --- /dev/null +++ b/VehicleVault.Api/Program.cs @@ -0,0 +1,31 @@ +using VehicleVault.Api.Services; + +var builder = WebApplication.CreateBuilder(args); + +builder.AddServiceDefaults(); +builder.AddRedisDistributedCache("cache"); + +builder.Services.AddSingleton(); +builder.Services.AddSingleton(); + +var allowedOrigins = builder.Configuration.GetSection("Cors:AllowedOrigins").Get() ?? []; + +builder.Services.AddCors(options => +{ + options.AddDefaultPolicy(policy => + { + policy.WithOrigins(allowedOrigins) + .AllowAnyHeader() + .WithMethods("GET"); + }); +}); + +var app = builder.Build(); + +app.MapDefaultEndpoints(); +app.UseCors(); + +app.MapGet("api/vehicle", async (int id, IVehicleCacheService vehicleService) => + await vehicleService.GetOrGenerate(id)); + +app.Run(); diff --git a/VehicleVault.Api/Properties/launchSettings.json b/VehicleVault.Api/Properties/launchSettings.json new file mode 100644 index 0000000..304fa87 --- /dev/null +++ b/VehicleVault.Api/Properties/launchSettings.json @@ -0,0 +1,38 @@ +{ + "$schema": "http://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:12998", + "sslPort": 44340 + } + }, + "profiles": { + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:5260", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:7283;http://localhost:5260", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + } + } +} diff --git a/VehicleVault.Api/Services/IVehicleCacheService.cs b/VehicleVault.Api/Services/IVehicleCacheService.cs new file mode 100644 index 0000000..2c234b6 --- /dev/null +++ b/VehicleVault.Api/Services/IVehicleCacheService.cs @@ -0,0 +1,14 @@ +using VehicleVault.Api.Entities; + +namespace VehicleVault.Api.Services; + +/// +/// Сервис транспортных средств с кэшированием +/// +public interface IVehicleCacheService +{ + /// + /// Получение или генерация транспортного средства по идентификатору + /// + public Task GetOrGenerate(int id); +} diff --git a/VehicleVault.Api/Services/IVehicleGeneratorService.cs b/VehicleVault.Api/Services/IVehicleGeneratorService.cs new file mode 100644 index 0000000..b8964bc --- /dev/null +++ b/VehicleVault.Api/Services/IVehicleGeneratorService.cs @@ -0,0 +1,14 @@ +using VehicleVault.Api.Entities; + +namespace VehicleVault.Api.Services; + +/// +/// Сервис генерации данных транспортного средства +/// +public interface IVehicleGeneratorService +{ + /// + /// Генерация транспортного средства по идентификатору + /// + public Vehicle Generate(int id); +} diff --git a/VehicleVault.Api/Services/VehicleCacheService.cs b/VehicleVault.Api/Services/VehicleCacheService.cs new file mode 100644 index 0000000..9ea3f82 --- /dev/null +++ b/VehicleVault.Api/Services/VehicleCacheService.cs @@ -0,0 +1,82 @@ +using Microsoft.Extensions.Caching.Distributed; +using System.Text.Json; +using VehicleVault.Api.Entities; + +namespace VehicleVault.Api.Services; + +/// +/// Сервис транспортных средств с кэшированием +/// +/// Генератор транспортных средств +/// Распределённый кэш +/// Конфигурация приложения +/// Логгер +public class VehicleCacheService( + IVehicleGeneratorService vehicleGenerator, + IDistributedCache distributedCache, + IConfiguration appConfiguration, + ILogger logger) : IVehicleCacheService +{ + private readonly TimeSpan _entryLifetime = TimeSpan.FromMinutes(appConfiguration.GetValue("Cache:ExpirationMinutes", 5)); + + /// + public async Task GetOrGenerate(int id) + { + var key = $"vehicle:{id}"; + + var existing = await TryGetFromCache(key); + if (existing is not null) + return existing; + + logger.LogInformation("Cache miss for id {Id}, generating new vehicle", id); + var result = vehicleGenerator.Generate(id); + await TrySaveToCache(key, result); + + return result; + } + + /// + /// Попытка получить транспортное средство из кэша + /// + /// Ключ записи + /// Транспортное средство или null + private async Task TryGetFromCache(string key) + { + try + { + var data = await distributedCache.GetStringAsync(key); + if (data is null) + return null; + + logger.LogInformation("Cache hit for key {Key}", key); + return JsonSerializer.Deserialize(data); + } + catch (Exception ex) + { + logger.LogWarning(ex, "Failed to retrieve from cache by key {Key}", key); + return null; + } + } + + /// + /// Попытка сохранить транспортное средство в кэш + /// + /// Ключ записи + /// Транспортное средство + private async Task TrySaveToCache(string key, Vehicle vehicle) + { + try + { + var serialized = JsonSerializer.Serialize(vehicle); + await distributedCache.SetStringAsync(key, serialized, new DistributedCacheEntryOptions + { + AbsoluteExpirationRelativeToNow = _entryLifetime + }); + logger.LogInformation("Saved to cache with key {Key}", key); + } + catch (Exception ex) + { + logger.LogWarning(ex, "Failed to save to cache by key {Key}", key); + } + } +} diff --git a/VehicleVault.Api/Services/VehicleGeneratorService.cs b/VehicleVault.Api/Services/VehicleGeneratorService.cs new file mode 100644 index 0000000..2781c83 --- /dev/null +++ b/VehicleVault.Api/Services/VehicleGeneratorService.cs @@ -0,0 +1,30 @@ +using Bogus; +using VehicleVault.Api.Entities; + +namespace VehicleVault.Api.Services; + +/// +/// Реализация сервиса генерации данных транспортного средства +/// +public class VehicleGeneratorService : IVehicleGeneratorService +{ + private readonly Faker _faker = new Faker() + .RuleFor(v => v.Vin, f => f.Vehicle.Vin()) + .RuleFor(v => v.Manufacturer, f => f.Vehicle.Manufacturer()) + .RuleFor(v => v.Model, f => f.Vehicle.Model()) + .RuleFor(v => v.Year, f => f.Random.Int(1960, DateTime.Now.Year)) + .RuleFor(v => v.BodyType, f => f.Vehicle.Type()) + .RuleFor(v => v.FuelType, f => f.Vehicle.Fuel()) + .RuleFor(v => v.BodyColor, f => f.Commerce.Color()) + .RuleFor(v => v.Mileage, f => Math.Round(f.Random.Double(0, 1000000), 3)) + .RuleFor(v => v.LastServiceDate, (f, v) => + DateOnly.FromDateTime(f.Date.Between(new DateTime(v.Year, 1, 1), DateTime.Now))); + + /// + public Vehicle Generate(int id) + { + var vehicle = _faker.Generate(); + vehicle.SystemId = id; + return vehicle; + } +} diff --git a/VehicleVault.Api/VehicleVault.Api.csproj b/VehicleVault.Api/VehicleVault.Api.csproj new file mode 100644 index 0000000..8dcb8da --- /dev/null +++ b/VehicleVault.Api/VehicleVault.Api.csproj @@ -0,0 +1,18 @@ + + + + net8.0 + enable + enable + + + + + + + + + + + + diff --git a/VehicleVault.Api/appsettings.Development.json b/VehicleVault.Api/appsettings.Development.json new file mode 100644 index 0000000..0c208ae --- /dev/null +++ b/VehicleVault.Api/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/VehicleVault.Api/appsettings.json b/VehicleVault.Api/appsettings.json new file mode 100644 index 0000000..e7350ac --- /dev/null +++ b/VehicleVault.Api/appsettings.json @@ -0,0 +1,18 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*", + "Cache": { + "ExpirationMinutes": 5 + }, + "Cors": { + "AllowedOrigins": [ + "http://localhost:5127", + "https://localhost:7282" + ] + } +} diff --git a/VehicleVault/VehicleVault.AppHost/AppHost.cs b/VehicleVault/VehicleVault.AppHost/AppHost.cs new file mode 100644 index 0000000..a4202cd --- /dev/null +++ b/VehicleVault/VehicleVault.AppHost/AppHost.cs @@ -0,0 +1,13 @@ +var builder = DistributedApplication.CreateBuilder(args); + +var cache = builder.AddRedis("cache") + .WithRedisInsight(); + +var api = builder.AddProject("vehiclevault-api") + .WithReference(cache) + .WaitFor(cache); + +builder.AddProject("client-wasm") + .WaitFor(api); + +builder.Build().Run(); diff --git a/VehicleVault/VehicleVault.AppHost/Properties/launchSettings.json b/VehicleVault/VehicleVault.AppHost/Properties/launchSettings.json new file mode 100644 index 0000000..e61ad6b --- /dev/null +++ b/VehicleVault/VehicleVault.AppHost/Properties/launchSettings.json @@ -0,0 +1,29 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "profiles": { + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:17060;http://localhost:15002", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21017", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22019" + } + }, + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:15002", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:19170", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20000" + } + } + } +} diff --git a/VehicleVault/VehicleVault.AppHost/VehicleVault.AppHost.csproj b/VehicleVault/VehicleVault.AppHost/VehicleVault.AppHost.csproj new file mode 100644 index 0000000..b73474a --- /dev/null +++ b/VehicleVault/VehicleVault.AppHost/VehicleVault.AppHost.csproj @@ -0,0 +1,23 @@ + + + + + + Exe + net8.0 + enable + enable + e8350e86-dfa1-4c37-9efc-069d9ff7570f + + + + + + + + + + + + + diff --git a/VehicleVault/VehicleVault.AppHost/appsettings.Development.json b/VehicleVault/VehicleVault.AppHost/appsettings.Development.json new file mode 100644 index 0000000..0c208ae --- /dev/null +++ b/VehicleVault/VehicleVault.AppHost/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/VehicleVault/VehicleVault.AppHost/appsettings.json b/VehicleVault/VehicleVault.AppHost/appsettings.json new file mode 100644 index 0000000..31c092a --- /dev/null +++ b/VehicleVault/VehicleVault.AppHost/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning", + "Aspire.Hosting.Dcp": "Warning" + } + } +} diff --git a/VehicleVault/VehicleVault.ServiceDefaults/Extensions.cs b/VehicleVault/VehicleVault.ServiceDefaults/Extensions.cs new file mode 100644 index 0000000..b72c875 --- /dev/null +++ b/VehicleVault/VehicleVault.ServiceDefaults/Extensions.cs @@ -0,0 +1,127 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Diagnostics.HealthChecks; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Diagnostics.HealthChecks; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.ServiceDiscovery; +using OpenTelemetry; +using OpenTelemetry.Metrics; +using OpenTelemetry.Trace; + +namespace Microsoft.Extensions.Hosting; + +// Adds common Aspire services: service discovery, resilience, health checks, and OpenTelemetry. +// This project should be referenced by each service project in your solution. +// To learn more about using this project, see https://aka.ms/dotnet/aspire/service-defaults +public static class Extensions +{ + private const string HealthEndpointPath = "/health"; + private const string AlivenessEndpointPath = "/alive"; + + public static TBuilder AddServiceDefaults(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.ConfigureOpenTelemetry(); + + builder.AddDefaultHealthChecks(); + + builder.Services.AddServiceDiscovery(); + + builder.Services.ConfigureHttpClientDefaults(http => + { + // Turn on resilience by default + http.AddStandardResilienceHandler(); + + // Turn on service discovery by default + http.AddServiceDiscovery(); + }); + + // Uncomment the following to restrict the allowed schemes for service discovery. + // builder.Services.Configure(options => + // { + // options.AllowedSchemes = ["https"]; + // }); + + return builder; + } + + public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Logging.AddOpenTelemetry(logging => + { + logging.IncludeFormattedMessage = true; + logging.IncludeScopes = true; + }); + + builder.Services.AddOpenTelemetry() + .WithMetrics(metrics => + { + metrics.AddAspNetCoreInstrumentation() + .AddHttpClientInstrumentation() + .AddRuntimeInstrumentation(); + }) + .WithTracing(tracing => + { + tracing.AddSource(builder.Environment.ApplicationName) + .AddAspNetCoreInstrumentation(tracing => + // Exclude health check requests from tracing + tracing.Filter = context => + !context.Request.Path.StartsWithSegments(HealthEndpointPath) + && !context.Request.Path.StartsWithSegments(AlivenessEndpointPath) + ) + // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) + //.AddGrpcClientInstrumentation() + .AddHttpClientInstrumentation(); + }); + + builder.AddOpenTelemetryExporters(); + + return builder; + } + + private static TBuilder AddOpenTelemetryExporters(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]); + + if (useOtlpExporter) + { + builder.Services.AddOpenTelemetry().UseOtlpExporter(); + } + + // Uncomment the following lines to enable the Azure Monitor exporter (requires the Azure.Monitor.OpenTelemetry.AspNetCore package) + //if (!string.IsNullOrEmpty(builder.Configuration["APPLICATIONINSIGHTS_CONNECTION_STRING"])) + //{ + // builder.Services.AddOpenTelemetry() + // .UseAzureMonitor(); + //} + + return builder; + } + + public static TBuilder AddDefaultHealthChecks(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Services.AddHealthChecks() + // Add a default liveness check to ensure app is responsive + .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]); + + return builder; + } + + public static WebApplication MapDefaultEndpoints(this WebApplication app) + { + // Adding health checks endpoints to applications in non-development environments has security implications. + // See https://aka.ms/dotnet/aspire/healthchecks for details before enabling these endpoints in non-development environments. + if (app.Environment.IsDevelopment()) + { + // All health checks must pass for app to be considered ready to accept traffic after starting + app.MapHealthChecks(HealthEndpointPath); + + // Only health checks tagged with the "live" tag must pass for app to be considered alive + app.MapHealthChecks(AlivenessEndpointPath, new HealthCheckOptions + { + Predicate = r => r.Tags.Contains("live") + }); + } + + return app; + } +} diff --git a/VehicleVault/VehicleVault.ServiceDefaults/VehicleVault.ServiceDefaults.csproj b/VehicleVault/VehicleVault.ServiceDefaults/VehicleVault.ServiceDefaults.csproj new file mode 100644 index 0000000..1b6e209 --- /dev/null +++ b/VehicleVault/VehicleVault.ServiceDefaults/VehicleVault.ServiceDefaults.csproj @@ -0,0 +1,22 @@ + + + + net8.0 + enable + enable + true + + + + + + + + + + + + + + +