Skip to content

Commit a08b8e5

Browse files
pdgonzalez872svrnmopentelemetrybotcartermp
authored
Update getting-started.md with Bandit (#4518)
Co-authored-by: Severin Neumann <[email protected]> Co-authored-by: opentelemetrybot <[email protected]> Co-authored-by: Phillip Carter <[email protected]>
1 parent 9eab7c5 commit a08b8e5

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

content/en/docs/languages/erlang/getting-started.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@ We'll need a few other dependencies that Phoenix doesn't come with.
4747
OpenTelemetry Collector and/or to self-hosted or commercial services.
4848
- `opentelemetry_phoenix`: creates OpenTelemetry spans from the Elixir
4949
`:telemetry` events created by Phoenix.
50-
- `opentelemetry_cowboy`: creates OpenTelemetry spans from the Elixir
51-
`:telemetry` events created by the Cowboy web server (which is used by
52-
Phoenix).
50+
- web server dependencies: There are currently two options for web servers and
51+
each has their telemetry counterpart. Phoenix applications post 1.7.11 default
52+
to Bandit while pre 1.7.11 default to Cowboy. Both choices are valid. Use one
53+
of the below options based on the web server your Phoenix application uses:
54+
- `opentelemetry_cowboy`: creates OpenTelemetry spans from the Elixir
55+
`:telemetry` events created by the Cowboy web server
56+
- `opentelemetry_bandit`: creates OpenTelemetry spans from the Elixir
57+
`:telemetry` events created by the Bandit web server
5358

5459
```elixir
5560
# mix.exs
@@ -59,7 +64,10 @@ def deps do
5964
{:opentelemetry_api, "~> {{% param versions.otelApi %}}"},
6065
{:opentelemetry_exporter, "~> {{% param versions.otelExporter %}}"},
6166
{:opentelemetry_phoenix, "~> {{% param versions.otelPhoenix %}}"},
62-
{:opentelemetry_cowboy, "~> {{% param versions.otelCowboy %}}"},
67+
# for Cowboy
68+
{:opentelemetry_cowboy, "~> {{% param versions.otelCowboy %}}"}
69+
# for Bandit
70+
{:opentelemetry_bandit, "~> {{% version-from-registry instrumentation-erlang-bandit %}}"},
6371
]
6472
end
6573
```
@@ -70,8 +78,12 @@ The last two also need to be setup when your application starts:
7078
# application.ex
7179
@impl true
7280
def start(_type, _args) do
81+
# Depending on what webserver you are using, you will either use:
7382
:opentelemetry_cowboy.setup()
7483
OpentelemetryPhoenix.setup(adapter: :cowboy2)
84+
# or
85+
OpentelemetryBandit.setup()
86+
OpentelemetryPhoenix.setup(adapter: :bandit)
7587
end
7688
```
7789

0 commit comments

Comments
 (0)