Blueprint-Service

This project will introduce the hexagonal architecture for an all new service. In the following you will find a documentation how to do it.

What's included in the blueprint

In the following you will find all the external resources which are included and set up in the blueprint.

• Serilog
• Loki
• Prometheus
• Grafana
• Swagger

All of these resources were configured by the included WireWaste ServiceCommons library.

Serilog

To produce meaning full logs, we implemented Serilog to the blueprint. Serilog could be manged via the appsettings in the blueprint.

Prometheus

Prometheus will receive all metrics from the service.

Loki

Loki will receive all logs from the service.

Grafana

Grafana will print the logs saved in loki and metrics saved in prometheus.

Swagger

Swagger will produce api documentation.

Configure new service

To configure a new service like the blueprint, you have to implement the following steps:

1. Add in section <PropertyGroup></PropertyGroup> the block <GenerateDocumentationFile>true</GenerateDocumentationFile> to the .csproj file of the api service.
2. Fork the blueprint
3. Change the name of the solution
4. Change the hostname and port in docker-compose.yml and prometheus.yml to the name of the service