opentelemetry-erlang-contrib/instrumentation/opentelemetry_ecto/README.md

# OpentelemetryEcto

Telemetry handler that creates OpenTelemetry spans from Ecto query events. Because
Ecto emits telemetry events only after queries have finished, OpentelemetryEcto
estimates the start time of the span by subtracting the reported total duration
from the current timestamp.

After installing, set up the handler in your application's `start/2` callback before your
top-level supervisor starts, passing the Telemetry prefix of the Ecto repo you want to instrument.

```elixir
OpentelemetryEcto.setup([:blog, :repo])
```

See [the documentation for `OpentelemetryEcto.setup/2`](https://hexdocs.pm/opentelemetry_ecto/OpentelemetryEcto.html#setup/2) for additional options that
may be supplied.

## Installation

Add the package to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:opentelemetry_ecto, "~> 1.0"}
  ]
end
```

## Compatibility Matrix

| OpentelemetryEcto Version | OTel Version | Notes |
| :------------------------ | :----------- | :---- |
|                           |              |       |
| v0.1.0                    | <= v.0.5.0   |       |
| v1.0.0-rc.1               | v1.0.0-rc.1  |       |
| v1.0.0-rc.2               | v1.0.0-rc.2  |       |
| v1.0.0-rc.3               | v1.0.0-rc.3  |       |
| v1.0.0-rc.4               | v1.0.0-rc.4  |       |
| v1.0                      | v1.0         |       |