Get Started for Telemetry

RepoDB ships with opt-in, drop-in telemetry via RepoDb.Telemetry.Default. It wires up a default ITrace that captures every operation (Insert, Query, Update, Delete, etc.) and publishes it to an insights collector.

Installation

Install the library via NuGet using the Package Manager Console.

> Install-Package RepoDb.Telemetry.Default

Setting up Docker

Download the docker-compose.yml and .env files into any directory and run the command below:

cd c:/folder-location
docker compose up -d

Once the stack is up, the collector Collector API runs at http://localhost:5000 by default and the Grafana dashboard is at http://localhost:3000.

Everything runs with local defaults (RepoDB2026 as the shared password/API key) meant for trying things out, not production. Override them with environment variables in a .env file before deploying to production.

Enable Telemetry

Call the globalized setup method once at application startup.

GlobalConfiguration
    .Setup(new GlobalConfigurationOptions { UseRegisteredGlobalTraces = true })
    .UseDefaultTelemetry(
        host: "https://your-collector-host",
        apiKey: "YOUR_API_KEY",
        applicationName: "<YOUR_APPLICATION_NAME>",
        groupName: "<YOUR_APPLICATION_GROUP>");

That’s it, you are now done! Every operation across every connection in the application is now traced automatically.

UseRegisteredGlobalTraces = true is required. It tells the library to run every globally registered tracer (this one included) for every operation, without passing a trace argument to each call.

For more control, pass a DefaultTelemetryOption instead of individual arguments.