Page MenuHomePhorge
Files F114167

No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/lib/tesla/middleware/telemetry.ex b/lib/tesla/middleware/telemetry.ex
index e282225..e1914fc 100644
--- a/lib/tesla/middleware/telemetry.ex
+++ b/lib/tesla/middleware/telemetry.ex
@@ -1,113 +1,116 @@
if Code.ensure_loaded?(:telemetry) do
defmodule Tesla.Middleware.Telemetry do
@behaviour Tesla.Middleware
@moduledoc """
Emits events using the `:telemetry` library to expose instrumentation.
### Example usage
```
defmodule MyClient do
use Tesla
- plug Tesla.Middleware.Telemetry, prefix: [:my_client]
+ plug Tesla.Middleware.Telemetry
end
- :telemetry.attach("my-tesla-telemetry", [:my_client, :tesla, :request, stop], fn event, measurements, meta, config ->
+ :telemetry.attach("my-tesla-telemetry", [:tesla, :request, stop], fn event, measurements, meta, config ->
# Do something with the event
end)
```
### Options
- * `:event_prefix` - a list of atoms to prefix to the telemetry event. Defaults to `[]`
+ * `:event_prefix` - a list of atoms to prefix to the telemetry event name. This can be set if you need to distinguish events from different clients. Defaults to `[]`
## Telemetry Events
* `[:tesla, :request, :start]` - emitted at the beginning of the request.
* Measurement: `%{time: System.monotonic_time}`
* Metadata: `%{env: Tesla.Env.t}`
* `[:tesla, :request, :stop]` - emitted at the end of the request.
* Measurement: `%{duration: native_time}`
* Metadata: `%{env: Tesla.Env.t}`
* `[:tesla, :request, :error]` - emitted at the end of the request when there is an error.
* Measurement: `%{duration: native_time}`
* Metadata: `%{env: Tesla.Env.t, reason: term}`
* `[:tesla, :request, :exception]` - emitted at the end of the request when an exception is raised.
* Measurement: `%{duration: native_time}`
* Metadata: `%{env: Tesla.Env.t, exception: Exception.t, stacktrace: Exception.stacktrace}`
+
+ ### Legacy Telemetry Events
+
* `[:tesla, :request]` - This event is emitted for backwards compatibility only and should be considered deprecated.
- This event can be disabled by setting `config :tesla, Tesla.Middleware.Telemetry, disable_legacy_event: true` in your config.
+ This event can be disabled by setting `config :tesla, Tesla.Middleware.Telemetry, disable_legacy_event: true` in your config. Be sure to run `mix deps.compile --force tesla` after changing this setting to ensure the change is picked up.
Please check the [telemetry](https://hexdocs.pm/telemetry/) for the further usage.
"""
@disable_legacy_event Application.get_env(:tesla, Tesla.Middleware.Telemetry,
disable_legacy_event: false
)[:disable_legacy_event]
@doc false
def call(env, next, opts) do
prefix = Keyword.get(opts, :event_prefix, [])
start_time = System.monotonic_time()
emit_start(env, start_time, prefix)
result =
try do
Tesla.run(env, next)
rescue
e ->
stacktrace = System.stacktrace()
metadata = %{env: env, exception: e, stacktrace: stacktrace}
:telemetry.execute(
prefix ++ [:tesla, :request, :exception],
%{duration: System.monotonic_time() - start_time},
metadata
)
reraise e, stacktrace
end
- emit_stop(result, start_time, prefix, env)
+ duration = System.monotonic_time() - start_time
+
+ emit_stop(env, duration, prefix, result)
result
end
defp emit_start(env, start_time, prefix) do
:telemetry.execute(prefix ++ [:tesla, :request, :start], %{time: start_time}, %{
env: env
})
end
- defp emit_stop(result, start_time, prefix, req_env) do
- duration = System.monotonic_time() - start_time
-
+ defp emit_stop(req_env, duration, prefix, result) do
case result do
{:ok, env} ->
:telemetry.execute(
prefix ++ [:tesla, :request, :stop],
%{duration: duration},
%{env: env}
)
{:error, error} ->
:telemetry.execute(
prefix ++ [:tesla, :request, :error],
%{duration: duration},
%{env: req_env, reason: error}
)
end
if !@disable_legacy_event do
# retained for backwards compatibility - remove in 2.0
:telemetry.execute([:tesla, :request], %{request_time: duration}, %{result: result})
end
end
end
end

File Metadata

Mime Type
text/x-diff
Expires
Mon, Nov 25, 9:43 PM (1 d, 8 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
40081
Default Alt Text
(4 KB)

Event Timeline