Elixir / Phoenix / Ecto:如何自定义SQL查询日志格式?

Question

在我的 Phoenix/Ecto 应用程序中，当我将日志级别设置为:debug时，我会看到 Ecto 发出的每个 SQL 查询的有用日志条目，如下所示：

[debug] QUERY OK source="users" db=1.9ms
SELECT u0."id", u0."full_name", u0."email", u0."uuid", u0."auth0_uid", u0."last_signed_in_at", u0."inserted_at", u0."updated_at" FROM "users" AS u0 WHERE (u0."id" = $1) LIMIT 1 [1]
[debug] QUERY OK source="projects" db=11.8ms
SELECT p0."id", p0."name", p0."uuid", p0."settings", p0."inserted_at", p0."updated_at" FROM "projects" AS p0 WHERE (p0."uuid" = $1) LIMIT 1 ["7qDjSk"]
[debug] QUERY OK source="project_admin_joins" db=1.9ms
SELECT p0."id", p0."project_id", p0."admin_id", p0."inserted_at", p0."updated_at", p0."project_id" FROM "project_admin_joins" AS p0 WHERE (p0."project_id" = $1) ORDER BY p0."project_id" [2]

但我很想调整一下这种格式的几件事：

• 每个 sql 查询生成两行日志输出。对我来说，将所有这些信息放在一行上很重要，因为这样可以更轻松地在日志管理服务(如 Papertrail)中查找事件。
• 理想情况下，我想去掉字段名称周围的引号，以便查询更易于直观扫描。

如何自定义 Ecto sql 查询日志的格式？

Answer 1

看起来没有自定义 Ecto 的日志记录格式这样的事情; 相反，我需要禁用内置日志记录并编写自己的日志记录函数。但这在 Ecto v2 和 Ecto v3 中的工作方式非常不同。

---

Ecto v2

在config.exs中，将 MyApp.Repo 配置为使用新的自定义记录器函数。该函数可以存在于任何地方，但就我而言，我将其放在MyApp.Repo.log_query/2

：

config :my_app, MyApp.Repo,
# ...
loggers: [{MyApp.Repo, :log_query, []}]

在lib/my_app/repo.ex中，定义log_query函数：(注意：在我的情况下，我已经硬编码了:debug日志级别。

...
require Logger
# Inspired by https://github.com/elixir-ecto/ecto/blob/v2.2.11/lib/ecto/log_entry.ex
def log_query(entry) do
Logger.log(:debug, fn ->
{ok, _} = entry.result
source = inspect(entry.source)
time_us = System.convert_time_unit(entry.query_time, :native, :microsecond)
time_ms = div(time_us, 100) / 10
# Strip out unnecessary quotes from the query for readability
query = Regex.replace(~r/(d.)"([^"]+)"/, entry.query, "\1\2")
params = inspect(entry.params, charlists: false)
"SQL query: #{ok} source=#{source} db=#{time_ms}ms   #{query}   params=#{params}"
end)
end

就是这样！确保您的日志级别设置正确，重新启动您的应用程序，您应该会看到所有 Ecto 查询都以这种新格式而不是旧格式记录。

---

Ecto v3

Ecto v3 鼓励您使用遥测事件，而不是那些讨厌的旧配置内容。

在lib/my_app/application.exMyApp.Application.start/2中，需要设置遥测事件。在Supervisor.start_link/2调用之前添加以下代码段：

# Subscribe to Ecto queries for logging
# See https://hexdocs.pm/ecto/Ecto.Repo.html#module-telemetry-events
# and https://github.com/beam-telemetry/telemetry
handler = &MyApp.Telemetry.handle_event/4
:ok = :telemetry.attach("my_app-ecto", [:my_app, :repo, :query], handler, %{})

然后定义遥测模块，该模块目前只有这一个事件处理程序。我在lib/my_app/telemetry.ex中保存了我的：

defmodule MyApp.Telemetry do
require Logger
# Thanks to https://hexdocs.pm/ecto/Ecto.Repo.html#module-telemetry-events
def handle_event([:my_app, :repo, :query], measurements, metadata, _config) do
Logger.log(:debug, fn ->
{ok, _} = metadata.result
source = inspect(metadata.source)
time = div(measurements.query_time, 100_000) / 10
# Strip out unnecessary quotes from the query for readability
query = Regex.replace(~r/(d.)"([^"]+)"/, metadata.query, "\1\2")
params = inspect(metadata.params, charlists: false)
"SQL query: #{ok} source=#{source} db=#{time}ms   #{query}   params=#{params}"
end)
end
end

在config/config.exs中，配置 MyApp.Repo 以禁用标准 Ecto 日志记录：

config :my_app, MyApp.Repo,
# ...
log: false

就是这样！确保您的日志级别设置正确，重新启动您的应用程序，您应该会看到所有 Ecto 查询都以这种新格式而不是旧格式记录。