Skip to content

Commit 07ec3d6

Browse files
grzuyyordis
andauthored
docs(telemetry): fixes typos and errors in documented code examples (#562)
* docs(telemetry): fixes typos and errors in documented code examples * Update utilities/opentelemetry_telemetry/lib/opentelemetry_telemetry.ex Co-authored-by: Yordis Prieto <[email protected]> * docs(telemetry): ignores unused var in code example * Update utilities/opentelemetry_telemetry/lib/opentelemetry_telemetry.ex Co-authored-by: Yordis Prieto <[email protected]> * docs(telemetry): bind kind * docs(telemetry): mix format moduledoc code * docs(telemetry): fixes binding name * Update utilities/opentelemetry_telemetry/lib/opentelemetry_telemetry.ex Co-authored-by: Yordis Prieto <[email protected]> --------- Co-authored-by: Yordis Prieto <[email protected]>
1 parent 6224db7 commit 07ec3d6

File tree

1 file changed

+32
-25
lines changed

1 file changed

+32
-25
lines changed

utilities/opentelemetry_telemetry/lib/opentelemetry_telemetry.ex

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,39 +22,46 @@ defmodule OpentelemetryTelemetry do
2222
2323
### Example Telemetry Event Handlers
2424
25-
```
26-
def handle_event(_event,
27-
%{system_time: start_time},
28-
metadata,
29-
%{type: :start, tracer_id: tracer_id, span_name: name}) do
25+
```elixir
26+
def handle_event(
27+
_event,
28+
%{system_time: start_time},
29+
metadata,
30+
%{type: :start, tracer_id: tracer_id, span_name: name}
31+
) do
3032
start_opts = %{start_time: start_time}
3133
OpentelemetryTelemetry.start_telemetry_span(tracer_id, name, metadata, start_opts)
3234
:ok
3335
end
3436
35-
def handle_event(_event,
36-
%{duration: duration},
37-
metadata,
38-
%{type: :stop, tracer_id: tracer_id}) do
39-
OpentelemetryTelemetry.set_current_telemetry_span(tracer_id, metadata)
40-
OpenTelemetry.Tracer.set_attribute(:duration, duration)
41-
OpentelemetryTelemetry.end_telemetry_span(tracer_id, metadata)
42-
:ok
37+
def handle_event(
38+
_event,
39+
%{duration: duration},
40+
metadata,
41+
%{type: :stop, tracer_id: tracer_id}
42+
) do
43+
OpentelemetryTelemetry.set_current_telemetry_span(tracer_id, metadata)
44+
OpenTelemetry.Tracer.set_attribute(:duration, duration)
45+
OpentelemetryTelemetry.end_telemetry_span(tracer_id, metadata)
46+
:ok
4347
end
4448
45-
def handle_event(_event,
46-
%{duration: duration},
47-
%{kind: kind, reason: reason, stacktrace: stacktrace} = metadata,
48-
%{type: :exception, tracer_id: tracer_id}) do
49-
ctx = OpentelemetryTelemetry.set_current_telemetry_span(tracer_id, metadata),
50-
status = Opentelemetry.status(:error, to_string(reason, :utf8))
51-
OpenTelemetry.Span.record_exception(ctx, kind, reason, stacktrace, [duration: duration])
52-
OpenTelemetry.Tracer.set_status(status)
53-
OpentelemetryTelemetry.end_telemetry_span(tracer_id, metadata)
54-
:ok
55-
end
56-
def handle_event(_event, _measurements, _metadata, _config), do: :ok
49+
def handle_event(
50+
_event,
51+
_measurements,
52+
%{kind: kind, reason: reason, stacktrace: stacktrace} = metadata,
53+
%{type: :exception, tracer_id: tracer_id}
54+
) do
55+
ctx = OpentelemetryTelemetry.set_current_telemetry_span(tracer_id, metadata)
56+
OpenTelemetry.Span.record_exception(ctx, reason, stacktrace)
57+
58+
OpenTelemetry.Tracer.set_status(OpenTelemetry.status(:error, Exception.format_banner(kind, reason, stacktrace)))
5759
60+
OpentelemetryTelemetry.end_telemetry_span(tracer_id, metadata)
61+
:ok
62+
end
63+
64+
def handle_event(_event, _measurements, _metadata, _config), do: :ok
5865
```
5966
6067
### Limitations

0 commit comments

Comments
 (0)