eecb238cff
By default a new trace is automatically started when a job is processed
by monitoring these events:
* `[:oban, :job, :start]` — at the point a job is fetched from the database and will execute
* `[:oban, :job, :stop]` — after a job succeeds and the success is recorded in the database
* `[:oban, :job, :exception]` — after a job fails and the failure is recorded in the database
To also record a span when a job is created and to link traces together
`Oban.insert/2` has to be replaced by `OpentelemetryOban.insert/2`.
Before:
```elixir
%{id: 1, in_the: "business", of_doing: "business"}
|> MyApp.Business.new()
|> Oban.insert()
```
After:
```elixir
%{id: 1, in_the: "business", of_doing: "business"}
|> MyApp.Business.new()
|> OpentelemetryOban.insert()
```
Co-authored-by: Tristan Sloughter <t@crashfast.com>
|
||
|---|---|---|
| .. | ||
| lib | ||
| test | ||
| .formatter.exs | ||
| .gitignore | ||
| .tool-versions | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
| mix.exs | ||
| mix.lock | ||
README.md
OpentelemetryOban
OpentelemetryOban uses telemetry handlers to
create OpenTelemetry spans from Oban events.
Installation
The package can be installed by adding opentelemetry_oban to your list of
dependencies in mix.exs:
def deps do
[
{:opentelemetry_oban, "~> 0.1"}
]
end
In your application start:
def start(_type, _args) do
OpentelemetryOban.setup()
# ...
end
Usage
By default a new trace is automatically started when a job is processed.
To also record a span when a job is created and to link traces together
Oban.insert/2 has to be replaced by OpentelemetryOban.insert/2.
Before:
%{id: 1, in_the: "business", of_doing: "business"}
|> MyApp.Business.new()
|> Oban.insert()
After:
%{id: 1, in_the: "business", of_doing: "business"}
|> MyApp.Business.new()
|> OpentelemetryOban.insert()
Oban also supports inserting jobs using Oban.insert/4, Oban.insert_all/2
and Oban.insert_all/4. These are currently not supported by OpentelemetryOban
and are just proxied through to Oban.