Packages
phoenix
1.3.2
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.8.0-rc.4
1.8.0-rc.3
1.8.0-rc.2
1.8.0-rc.1
1.8.0-rc.0
1.7.24
1.7.23
1.7.22
1.7.21
1.7.20
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.7.0-rc.3
1.7.0-rc.2
1.7.0-rc.1
1.7.0-rc.0
1.6.17
1.6.16
1.6.15
1.6.14
1.6.13
1.6.12
1.6.11
1.6.10
1.6.9
1.6.8
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.0
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-rc.3
1.4.0-rc.2
1.4.0-rc.1
1.4.0-rc.0
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-rc.3
1.3.0-rc.2
1.3.0-rc.1
1.3.0-rc.0
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc.1
1.2.0-rc.0
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.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.17.1
0.17.0
0.16.1
0.16.0
0.15.0
0.14.0
0.13.1
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.2
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.11
0.2.10
0.2.9
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0
Productive. Reliable. Fast. A productive web framework that does not compromise speed or maintainability.
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
lib/phoenix/logger.ex
defmodule Phoenix.Logger do
@moduledoc """
Instrumenter to handle logging of various instrumentation events.
## Parameter filtering
When logging parameters, Phoenix can filter out sensitive parameters
such as passwords and tokens. Parameters to be filtered can be
added via the `:filter_parameters` option:
config :phoenix, :filter_parameters, ["password", "secret"]
With the configuration above, Phoenix will filter any parameter
that contains the terms `password` or `secret`. The match is
case sensitive.
Phoenix's default is `["password"]`.
Phoenix can filter all parameters by default and selectively keep
parameters. This can be configured like so:
config :phoenix, :filter_parameters, {:keep, ["id", "order"]}
With the configuration above, Phoenix will filter all parameters,
except those that match exactly `id` or `order`. If a kept parameter
matches, all parameters nested under that one will also be kept.
"""
require Logger
import Phoenix.Controller
alias Phoenix.Socket
def phoenix_controller_call(:start, _compile, %{log_level: false}), do: :ok
def phoenix_controller_call(:start, %{module: module}, %{log_level: level, conn: conn}) do
Logger.log level, fn ->
controller = inspect(module)
action = conn |> action_name() |> Atom.to_string()
["Processing with ", controller, ?., action, ?/, ?2, ?\n,
" Parameters: ", params(conn.params), ?\n,
" Pipelines: ", inspect(conn.private[:phoenix_pipelines])]
end
:ok
end
def phoenix_controller_call(:stop, _time_diff, :ok), do: :ok
def phoenix_channel_join(:start, _compile, %{socket: socket, params: params}) do
log_join(socket.topic, socket, params)
end
def phoenix_channel_join(:stop, _compile, :ok), do: :ok
def phoenix_channel_receive(:start, _compile, meta) do
%{socket: socket, params: params, event: event} = meta
log_receive(socket.topic, event, socket, params)
end
def phoenix_channel_receive(:stop, _compile, :ok), do: :ok
@doc false
def filter_values(values, params \\ Application.get_env(:phoenix, :filter_parameters))
def filter_values(values, {:discard, params}), do: discard_values(values, params)
def filter_values(values, {:keep, params}), do: keep_values(values, params)
def filter_values(values, params), do: discard_values(values, params)
defp discard_values(%{__struct__: mod} = struct, _params) when is_atom(mod) do
struct
end
defp discard_values(%{} = map, params) do
Enum.into map, %{}, fn {k, v} ->
if is_binary(k) and String.contains?(k, params) do
{k, "[FILTERED]"}
else
{k, discard_values(v, params)}
end
end
end
defp discard_values([_|_] = list, params) do
Enum.map(list, &discard_values(&1, params))
end
defp discard_values(other, _params), do: other
defp keep_values(%{__struct__: mod}, _params) when is_atom(mod), do: "[FILTERED]"
defp keep_values(%{} = map, params) do
Enum.into map, %{}, fn {k, v} ->
if is_binary(k) and k in params do
{k, discard_values(v, [])}
else
{k, keep_values(v, params)}
end
end
end
defp keep_values([_|_] = list, params) do
Enum.map(list, &keep_values(&1, params))
end
defp keep_values(_other, _params), do: "[FILTERED]"
defp params(%Plug.Conn.Unfetched{}), do: "[UNFETCHED]"
defp params(params) do
params
|> filter_values()
|> inspect()
end
defp log_receive("phoenix" <> _, _event, _socket, _params), do: :ok
defp log_receive(topic, event, socket, params) do
channel_log(:log_handle_in, socket, fn ->
"INCOMING #{inspect event} on #{inspect topic} to #{inspect(socket.channel)}\n" <>
" Transport: #{inspect socket.transport}\n" <>
" Parameters: #{inspect filter_values(params)}"
end)
end
defp log_join("phoenix" <> _, _socket, _params), do: :ok
defp log_join(topic, socket, params) do
channel_log(:log_join, socket, fn ->
"JOIN #{inspect topic} to #{inspect(socket.channel)}\n" <>
" Transport: #{inspect socket.transport} (#{socket.vsn})\n" <>
" Serializer: #{inspect socket.serializer}\n" <>
" Parameters: #{inspect filter_values(params)}"
end)
end
defp channel_log(log_option, %Socket{private: private}, message_or_func) do
case Map.fetch(private, log_option) do
{:ok, false} -> :ok
{:ok, level} -> Logger.log(level, message_or_func)
end
:ok
end
end