FastTechFoods.Observability 2.7.0

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. 
dotnet add package FastTechFoods.Observability --version 2.7.0
                    


                    

                
NuGet\Install-Package FastTechFoods.Observability -Version 2.7.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="FastTechFoods.Observability" Version="2.7.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="FastTechFoods.Observability" Version="2.7.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="FastTechFoods.Observability" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add FastTechFoods.Observability --version 2.7.0
                    


                    

                
#r "nuget: FastTechFoods.Observability, 2.7.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package FastTechFoods.Observability@2.7.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=FastTechFoods.Observability&version=2.7.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=FastTechFoods.Observability&version=2.7.0
                    


                            Install as a Cake Tool

FastTechFoods.Observability

NuGet Build Status

Biblioteca de observabilidade para aplicações .NET, focada em telemetria, tracing, métricas e integração facilitada com OpenTelemetry.

✨ Características

  • Integração com OpenTelemetry: Suporte a traces, métricas e logs.
  • Exportação para múltiplos destinos: Console, OTLP (OpenTelemetry Protocol), Prometheus, entre outros.
  • Configuração Simples: Pensado para microserviços e aplicações modernas .NET.
  • Instrumentação automática: Para ASP.NET Core, HTTP e EntityFramework Core.
  • Suporte ao Prometheus: Métricas exportadas automaticamente para Prometheus.
  • HealthChecks integrados: Monitoramento da saúde da aplicação.
  • Serilog integrado: Logging estruturado com OpenTelemetry.
  • Pronto para uso em produção.

🚀 Instalação

Via NuGet:

dotnet add package FastTechFoods.Observability

🛠️ Como Usar

Configuração Básica (Método Simples)

using FastTechFoods.Observability;

var builder = WebApplication.CreateBuilder(args);

// Configuração básica com parâmetros
builder.Services.AddFastTechFoodsObservability(
    serviceName: "MeuServicoAPI",
    serviceVersion: "1.0.0",
    otlpEndpoint: "http://localhost:4317"
);

var app = builder.Build();

app.Run();

Configuração Avançada com HealthChecks

using FastTechFoods.Observability;
using MeuProjeto.Data;

var builder = WebApplication.CreateBuilder(args);

// Configuração completa com HealthChecks
builder.Services.AddFastTechFoodsObservabilityAndHealthChecks<MeuDbContext>(
    builder.Configuration
);

var app = builder.Build();

// Configurar endpoints de HealthChecks e Prometheus
app.UseFastTechFoodsHealthChecksUI();

app.Run();

Configuração apenas do Prometheus

using FastTechFoods.Observability;

var builder = WebApplication.CreateBuilder(args);

// Apenas métricas do Prometheus
builder.Services.AddFastTechFoodsPrometheus(
    serviceName: "MeuServicoAPI",
    serviceVersion: "1.0.0"
);

var app = builder.Build();

// Endpoint para métricas do Prometheus
app.UseFastTechFoodsPrometheus();

app.Run();

Configuração via appsettings.json

{
  "Observability": {
    "ServiceName": "MeuServicoAPI",
    "ServiceVersion": "1.0.0",
    "OtlpEndpoint": "http://localhost:4317"
  }
}

Consulte a documentação dos métodos de configuração para customizações avançadas.

📦 Exportadores Suportados

  • Console
  • OTLP (gRPC/HTTP)
  • Prometheus (métricas)
  • Jaeger (via OTLP)
  • Serilog com OpenTelemetry
  • Outros facilmente configuráveis via OpenTelemetry

🎯 Instrumentações Suportadas

  • ASP.NET Core (requests, responses, timing)
  • HTTP Client (outbound calls)
  • EntityFramework Core (database operations)
  • Métricas customizadas via OpenTelemetry

📊 Endpoints Disponíveis

  • /metrics - Métricas do Prometheus
  • /health - Status da aplicação
  • /health-ui - Interface web para HealthChecks

🔧 Métodos de Extensão Disponíveis

Para IServiceCollection:

  • AddFastTechFoodsObservability() - Configuração básica
  • AddFastTechFoodsObservabilityAndHealthChecks<TDbContext>() - Configuração completa
  • AddFastTechFoodsPrometheus() - Apenas Prometheus

Para IApplicationBuilder:

  • UseFastTechFoodsHealthChecksUI() - UI de HealthChecks + Prometheus
  • UseFastTechFoodsPrometheus() - Apenas endpoint do Prometheus

📝 Exemplos de Configuração

Configuração OTLP para Jaeger

builder.Services.AddFastTechFoodsObservability(
    serviceName: "MeuServicoAPI",
    serviceVersion: "1.0.0",
    otlpEndpoint: "http://jaeger:14268/api/traces"
);

Configuração com Prometheus e Grafana

// No Program.cs
builder.Services.AddFastTechFoodsPrometheus(builder.Configuration);

var app = builder.Build();
app.UseFastTechFoodsPrometheus();

// Métricas estarão disponíveis em http://localhost:5000/metrics

Configuração completa com Docker Compose

version: '3.8'
services:
  meuservico:
    image: meuservico:latest
    ports:
      - "5000:5000"
    environment:
      - Observability__ServiceName=MeuServicoAPI
      - Observability__ServiceVersion=1.0.0
      - Observability__OtlpEndpoint=http://jaeger:14268/api/traces
  
  prometheus:
    image: prom/prometheus
    ports:
      - "9090:9090"
    volumes:
      - ./prometheus.yml:/etc/prometheus/prometheus.yml
  
  grafana:
    image: grafana/grafana
    ports:
      - "3000:3000"

🧩 Requisitos

  • .NET 9.0 ou superior
  • Pacotes OpenTelemetry 1.11.x ou superior
  • Para Prometheus: endpoint /metrics deve estar acessível
  • Para HealthChecks: EntityFramework Core (opcional)

🤝 Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para abrir Issues ou Pull Requests.

📄 Licença

Este projeto está licenciado sob a licença MIT.

📢 Observações

  • Para uso com .NET 9, utilize versões do OpenTelemetry a partir de 1.11.x e ajuste o TargetFramework conforme necessário.

Desenvolvido por FastTechFoods 🥡

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.7.0 457 7/21/2025
2.6.0 28 7/19/2025
2.5.0 41 7/12/2025
2.4.0 131 7/8/2025
2.3.0 132 7/8/2025
2.2.0 115 7/8/2025
2.1.0 111 7/8/2025
2.0.0 108 7/5/2025
1.1.0 119 7/8/2025
1.0.0 52 7/5/2025