Skip to content

Allow atom :all as :tags option #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
hauleth wants to merge 1 commit into from
Closed

Allow atom :all as :tags option #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion lib/telemetry_metrics.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ defmodule Telemetry.Metrics do
| (:telemetry.event_measurements() -> number())
| (:telemetry.event_measurements(), :telemetry.event_metadata() -> number())
@type tag :: term()
@type tags :: [tag()]
@type tags :: [tag()] | :all
@type tag_values :: (:telemetry.event_metadata() -> :telemetry.event_metadata())
@type predicate_fun ::
(:telemetry.event_metadata() -> boolean())
Expand Down Expand Up @@ -672,6 +672,8 @@ defmodule Telemetry.Metrics do
end

@spec validate_tags!(term()) :: :ok | no_return()
defp validate_tags!(:all), do: :ok

defp validate_tags!(list) when is_list(list) do
:ok
end
Expand Down
10 changes: 10 additions & 0 deletions test/telemetry_metrics_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,16 @@ defmodule Telemetry.MetricsTest do
assert event_metadata == tag_values_fun.(event_metadata)
end

test "tags can use atom `:all` to mark that all metadata should be used" do
metric =
apply(Metrics, unquote(metric_type), [
"my.event.value",
[tags: :all]
])

assert :all == metric.tags
end

test "setting function as tag_values returns that function in metric spec" do
metric =
apply(Metrics, unquote(metric_type), [
Expand Down