opentelemetry-erlang-contrib/instrumentation/opentelemetry_oban
rlopzc 66326e7f42
Update Oban's README.md (#222)
The published version is 1.0.0

https://hex.pm/packages/opentelemetry_oban
2023-11-09 16:53:32 -07:00
..
lib chore: add sc to oban (#138) 2022-12-14 16:48:27 -07:00
test Improve test matrix and add support for Elixir 1.15 and OTP 26 (#188) 2023-08-25 14:11:23 -06:00
.formatter.exs Add opentelemetry integration to Oban (#6) 2021-12-08 08:41:36 -07:00
.gitignore Add opentelemetry integration to Oban (#6) 2021-12-08 08:41:36 -07:00
CHANGELOG.md publish latest updates (#127) 2022-11-16 19:07:23 -07:00
LICENSE Add opentelemetry integration to Oban (#6) 2021-12-08 08:41:36 -07:00
README.md Update Oban's README.md (#222) 2023-11-09 16:53:32 -07:00
docker-compose.yml Otel 1.0.0-rc.4 updates (#54) 2021-12-28 16:39:06 -07:00
mix.exs Make exdocs settings a bit more similar between different packages (#168) 2023-04-30 12:10:03 -06:00
mix.lock Improve test matrix and add support for Elixir 1.15 and OTP 26 (#188) 2023-08-25 14:11:23 -06:00

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, "~> 1.0"}
  ]
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.