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

42 lines
1.2 KiB
Markdown

# opentelemetry_cowboy
[![EEF Observability WG project](https://img.shields.io/badge/EEF-Observability-black)](https://github.com/erlef/eef-observability-wg)
[![Hex.pm](https://img.shields.io/hexpm/v/opentelemetry_cowboy)](https://hex.pm/packages/opentelemetry_cowboy)
![Build Status](https://github.com/open-telemetry/opentelemetry-erlang-contrib/workflows/Erlang/badge.svg)
Telemetry handler that creates Opentelemetry spans from cowboy events.
After installing, setup the handler in your application behaviour before your
top-level supervisor starts.
```erlang
opentelemetry_cowboy:setup()
```
See [cowboy_telemetry](https://github.com/beam-telemetry/cowboy_telemetry) for prerequisite setup.
There is no additional prerequisite setup for [plug_cowboy](https://hex.pm/packages/plug_cowboy) users.
## Installation
```erlang
{deps, [
{opentelemetry_cowboy, "~> 0.2"}
]}
```
```elixir
def deps do
[
{:opentelemetry_cowboy, "~> 0.2"}
]
end
```
## Compatibility Matrix
| opentelemetry_cowboy Version | Otel Version | Notes |
| :--------------------------- | :------------ | :---- |
| | | |
| v0.1.0 | v.1.0.0-rc.3 | |
| v0.2 | v.1.0 | |