DevInspector.AuditSDK 4.2.0

DevInspector.AuditSDK

SDK oficial do DevInspector para monitoramento, auditoria de erros, métricas de requisições e APM em aplicações C# e .NET.

Instalação

Você pode instalar o pacote via NuGet Package Manager ou CLI do .NET:

dotnet add package DevInspector.AuditSDK --version 4.2.0
Inicialização
Inicialize o SDK informando a API Key do seu projeto:
using DevInspector;

var audit = AuditCore.GetInstance();

audit.Init(
    apiKey: "SUA_API_KEY",
    environment: "production",
    release: "3.0.0"
);
Também é possível configurar o endpoint e o limite para identificação de operações lentas:
audit.Init(
    apiKey: "SUA_API_KEY",
    endpoint: "https://api.devinspector.com.br/api/ingest/track",
    environment: "production",
    release: "3.0.0",
    slowThresholdMs: 300
);
Captura de erros
try
{
    throw new Exception("Erro de teste");
}
catch (Exception ex)
{
    audit.CaptureException(ex);
}
Mensagens
audit.CaptureMessage("Aplicação iniciada");
Monitoramento de requisições
audit.CaptureRequest(
    method: "GET",
    url: "/api/users",
    statusCode: 200,
    durationMs: 125
);
APM e operações lentas
Para operações síncronas:
var result = audit.TraceOperation(
    "UserRepository.GetUsers",
    () =>
    {
        return repository.GetUsers();
    }
);
Para operações assíncronas:
var result = await audit.TraceOperationAsync(
    "UserRepository.GetUsers",
    async () =>
    {
        return await repository.GetUsersAsync();
    }
);
O limite padrão para operações lentas é de 300ms.
Você pode alterar esse limite durante a inicialização:
audit.Init(
    apiKey: "SUA_API_KEY",
    environment: "production",
    release: "3.0.0",
    slowThresholdMs: 500
);
Também é possível informar um limite específico para uma operação:
var result = audit.TraceOperation(
    "Database.Query",
    500,
    () =>
    {
        return repository.GetUsers();
    }
);
Rastreamento distribuído
O SDK 4.2.0 suporta:
requestId
traceId
spanId
Esses identificadores permitem relacionar erros, requisições e operações dentro do mesmo fluxo.
Em integrações HTTP, o contexto pode ser iniciado utilizando:
AuditCore.BeginRequest(
    requestId,
    traceId,
    spanId,
    url
);
Ao finalizar a requisição:
AuditCore.ClearRequest();
O contexto é armazenado utilizando AsyncLocal, permitindo seu isolamento durante operações assíncronas.
APM de banco de dados
Operações lentas podem ser registradas como eventos específicos de db_query:
audit.CaptureDbQuery(
    operation: "find",
    collection: "users",
    durationMs: 450
);
Isso permite que o DevInspector apresente as consultas de banco separadamente das mensagens e erros.
Ambiente e release
O SDK permite identificar o ambiente e a versão da aplicação:
audit.Init(
    apiKey: "SUA_API_KEY",
    environment: "production",
    release: "1.4.2"
);
Exemplos de ambientes:
development
staging
production
Captura automática de exceções
O SDK registra exceções não tratadas por meio do mecanismo global de exceções do .NET após a inicialização.
audit.Init(
    apiKey: "SUA_API_KEY",
    environment: "production"
);
Compatibilidade
.NET 8+
C#
ASP.NET Core
Aplicações console
Aplicações worker
APIs REST
Aplicações web
Segurança
A API Key deve ser mantida em variáveis de ambiente ou em um mecanismo seguro de configuração.
Evite colocar a API Key diretamente no código-fonte.
Exemplo:
var apiKey = Environment.GetEnvironmentVariable("DEVINSPECTOR_API_KEY");

audit.Init(
    apiKey: apiKey,
    environment: "production",
    release: "3.0.0"
);
DevInspector
O DevInspector permite monitorar:
Erros
Exceções
Requisições
Performance
Operações lentas
Consultas de banco de dados
Tracing
Ambiente
Release
Acesse:
https://www.devinspector.com.br/⁠�
Licença
MIT

**Eu recomendo esse README para o 3.0.0**, porque agora ele documenta de fato o que implementamos no `AuditCore.cs`, em vez de deixar o usuário do NuGet sem saber como utilizar APM, tracing e `db_query`.