.NET with OpenTelemetry Collector

Overview

• Use OpenTelemetry to collect traces and metrics and Serilog to collect log's messages; then all of them will only export to OpenTelemetry Collector (OTEL collector in short).

• The collector then exports to

  • Zipkin and/or Jaeger for tracings
  • Prometheus for metrics
  • Loki for log's messages

• All of them are visualized on Grafana

Quick Start

1. Starting infrastructure from docker compose

docker compose -f ./local/infra/docker-compose.observability.yaml up -d

2. Starting service by using tye

tye run ./local/tye/tye.yaml --dashboard

3. Observe

• Making some requests to http://localhost:6002/hello or execute via Visual Studio

• Access grafana at http://localhost:3000 to explore 4 datasources: Jaeger, Zipkin, Prometheus & Loki

Development

Register & configure

• Refer to ObservabilityRegistration.cs

• There are the following methods that named as its functionality

  • AddTracing
  • AddMetrics
  • AddSerilog

• There is only one public method which is AddObservability. This is used in Program.cs

var webApplicationBuilder = WebApplication.CreateBuilder(args);

webApplicationBuilder.AddObservability();

// Other lines of code

---

Give a Star! 🌟

If you liked this project or if it helped you, please give a star ⭐ for this repository. Thank you!!!

---

Resources

• Tye: Service Discovery

• Automatic Instrumentation of Containerized .NET Applications With OpenTelemetry

• Containerize a .NET app with dotnet publish

• Built-In Container Support for .NET 7 – Dockerize .NET Applications without Dockerfile!

• Install the .NET SDK or the .NET Runtime on Alpine