Packages
timber
1.1.7
3.1.2
3.1.1
3.1.0
3.0.0
3.0.0-alpha.3
3.0.0-alpha.2
3.0.0-alpha.1
2.8.4
2.8.3
2.8.2
2.8.1
2.8.0
2.7.0
2.6.1
2.6.0
2.5.6
2.5.5
2.5.4
2.5.3
2.5.2
2.5.1
2.5.0
2.4.5
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.4
2.3.3
2.3.1
2.3.0
2.2.1
2.2.0
2.1.8
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
2.0.0-rc7
2.0.0-rc6
2.0.0-rc5
2.0.0-rc4
2.0.0-rc3
2.0.0-rc2
2.0.0-rc1
1.1.18
1.1.17
1.1.16
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.16
1.0.15
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.3.2
0.3.1
0.3.0
0.2.3
0.2.2
0.2.1
0.2.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
🌲 Great Elixir Logging Made Easy. Official Timber.io Integration.
Current section
Files
Jump to
Current section
Files
lib/timber/context.ex
defmodule Timber.Context do
@moduledoc """
The ContextEntry module formalizes the structure of context stack entries
Most users will not interact directly with this module and will instead use
the helper functions provided by the main `Timber` module. See the `Timber`
module for more information.
"""
alias Timber.Contexts
alias Timber.Utils.Map, as: UtilsMap
@type context_element ::
Contexts.CustomContext.t |
Contexts.HTTPContext.t |
Contexts.OrganizationContext.t |
Contexts.RuntimeContext.t |
Contexts.SystemContext.t |
Contexts.UserContext.t
@type t :: %{
optional(:custom) => Context.CustomContext.m,
optional(:http) => Context.HTTPContext.m,
optional(:organization) => Context.OrganizationContext.m,
optional(:runtime) => Context.RuntimeContext.m,
optional(:system) => Context.SystemContext.m,
optional(:user) => Context.UserContext.m
}
@doc false
def new(), do: %{}
@doc """
Takes an existing context element and inserts it into the global context.
"""
@spec add(t, context_element) :: t
def add(context, %Contexts.CustomContext{type: type} = context_element) when is_binary(type) do
new_context_element = %{context_element | type: String.to_atom(type)}
add(context, new_context_element)
end
def add(context, %Contexts.CustomContext{} = context_element) do
key = type(context_element)
api_map = to_api_map(context_element)
insert(context, key, api_map)
end
def add(existing_context_map, context_element) do
key = type(context_element)
context_element_map = to_api_map(context_element)
insert(existing_context_map, key, context_element_map)
end
# Inserts the context_element into the main context map
@spec insert(map, t, atom) :: map
defp insert(context, _key, new_context) when map_size(new_context) == 0 do
context
end
defp insert(%{custom: custom_context} = context, :custom, new_context) do
merged_custom_context = Map.merge(custom_context, new_context)
Map.put(context, :custom, merged_custom_context)
end
defp insert(context, key, new_context) do
Map.put(context, key, new_context)
end
# Converts a context_element into a map the Timber API expects.
@spec to_api_map(context_element) :: map
defp to_api_map(%Contexts.CustomContext{type: type, data: data}) do
%{type => data}
|> UtilsMap.recursively_drop_blanks()
end
defp to_api_map(%Contexts.OrganizationContext{id: id} = context_element) when is_integer(id) do
to_api_map(%{context_element | id: Integer.to_string(id)})
end
defp to_api_map(%Contexts.SystemContext{pid: pid} = context_element) when is_integer(pid) do
to_api_map(%{context_element | pid: Integer.to_string(pid)})
end
defp to_api_map(%Contexts.UserContext{id: id} = context_element) when is_integer(id) do
to_api_map(%{context_element | id: Integer.to_string(id)})
end
defp to_api_map(context_element) do
context_element
|> Map.from_struct()
|> UtilsMap.recursively_drop_blanks()
end
# Determines the key name for the context_element that the Timber API expects.
@spec type(context_element) :: atom
defp type(%Contexts.CustomContext{}), do: :custom
defp type(%Contexts.HTTPContext{}), do: :http
defp type(%Contexts.OrganizationContext{}), do: :organization
defp type(%Contexts.RuntimeContext{}), do: :runtime
defp type(%Contexts.SystemContext{}), do: :system
defp type(%Contexts.UserContext{}), do: :user
end