Skip to content

Commit

Permalink
Update documentation on telemetry:span/3 (#117)
Browse files Browse the repository at this point in the history
  • Loading branch information
vanvoljg authored Oct 26, 2022
1 parent b904a76 commit dc1cf9e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/telemetry.erl
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,9 @@ execute([_ | _] = EventName, Measurements, Metadata) when is_map(Measurements) a
%%
%% When providing `StartMetadata' and `StopMetadata', these values will be sent independently to `start' and
%% `stop' events. If an exception occurs, exception metadata will be merged onto the `StartMetadata'. In general,
%% `StopMetadata' should only provide values that are additive to `StartMetadata' so that handlers, such as those
%% used for metrics, can rely entirely on the `stop' event.
%% it is <strong>highly recommended</strong> that `StopMetadata' should include the values from `StartMetadata'
%% so that handlers, such as those used for metrics, can rely entirely on the `stop' event. Failure to include
%% all of `StartMetadata' in `StopMetadata' can add significant complexity to event handlers.
%%
%% A default span context is added to event metadata under the `telemetry_span_context' key if none is provided by
%% the user in the `StartMetadata'. This context is useful for tracing libraries to identify unique
Expand Down

0 comments on commit dc1cf9e

Please sign in to comment.