opentelemetry-erlang-contrib/instrumentation/opentelemetry_dataloader
Patrik Stenmark ddf0706bf1
Make exdocs settings a bit more similar between different packages (#168)
* Add source_url_pattern to be able to use the "link to source" button
* Add README.md as an "extra" where it wasn't already
* Add a `main` setting. They all have a very obvious main module. Set
  that as `main`, so a user is shown this immediately instead of a list
  of usually only this module.
2023-04-30 12:10:03 -06:00
..
config Add Dataloader instrumentation library (#137) 2023-04-05 10:34:49 -06:00
lib Add Dataloader instrumentation library (#137) 2023-04-05 10:34:49 -06:00
priv/test_repo/migrations Add Dataloader instrumentation library (#137) 2023-04-05 10:34:49 -06:00
test Add Dataloader instrumentation library (#137) 2023-04-05 10:34:49 -06:00
.formatter.exs Add Dataloader instrumentation library (#137) 2023-04-05 10:34:49 -06:00
.gitignore Add Dataloader instrumentation library (#137) 2023-04-05 10:34:49 -06:00
README.md Add Dataloader instrumentation library (#137) 2023-04-05 10:34:49 -06:00
docker-compose.yml Add Dataloader instrumentation library (#137) 2023-04-05 10:34:49 -06:00
mix.exs Make exdocs settings a bit more similar between different packages (#168) 2023-04-30 12:10:03 -06:00
mix.lock Add Dataloader instrumentation library (#137) 2023-04-05 10:34:49 -06:00

README.md

OpentelemetryDataloader

Telemetry handler that creates Opentelemetry spans from Dataloader events.

After installing, setup the handler in your application behaviour before your top-level supervisor starts.

OpentelemetryDataloader.setup()

Installation

If available in Hex, the package can be installed by adding opentelemetry_dataloader to your list of dependencies in mix.exs:

def deps do
  [
    {:opentelemetry_dataloader, "~> 1.0.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/opentelemetry_dataloader.