opentelemetry-erlang-contrib/instrumentation/opentelemetry_oban
João Thallis 3a9ed422b6
Remove doc about function that is not being only a proxy (#253)
* Remove doc about function that is not being only a proxy

For `insert_all/2` it is creating a span: 8af382e26a/instrumentation/opentelemetry_oban/lib/opentelemetry_oban.ex (L107)

* Update instrumentation/opentelemetry_oban/README.md

---------

Co-authored-by: Bryan Naegele <bryannaegele@users.noreply.github.com>
2024-01-18 14:39:07 -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 Remove doc about function that is not being only a proxy (#253) 2024-01-18 14:39:07 -07:00
docker-compose.yml chore(deps): update postgres docker tag to v16 (#242) 2023-11-15 11:14:43 -07:00
mix.exs chore(deps): update dependency ex_doc to v0.31.1 (#233) 2024-01-17 11:27:19 -07:00
mix.lock chore(deps): update dependency ex_doc to v0.31.1 (#233) 2024-01-17 11:27:19 -07: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 and Oban.insert_all/4. These are currently not supported by OpentelemetryOban and are just proxied through to Oban.