Ecto Dev Logger 常见问题解决方案-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01164/article/details/144416722

Ecto Dev Logger 常见问题解决方案

ecto_dev_logger An alternative logger for Ecto queries 项目地址: https://gitcode.com/gh_mirrors/ec/ecto_dev_logger

项目基础介绍

Ecto Dev Logger 是一个针对 Ecto 查询的替代日志工具。它能够将查询中的绑定内联到 SQL 中，使得日志输出的 SQL 语句可以轻松地复制粘贴到 IDE 中进行调试，而不需要手动转换常见的 Elixir 术语到字符串表示（例如，二进制 UUID、DateTime、Decimal、json 等）。此外，它还能突出显示数据库执行时间，使得慢查询更为明显。

该项目主要使用 Elixir 语言编写。

新手常见问题及解决步骤

问题1：如何安装和配置 Ecto Dev Logger

问题描述： 新手在使用 Ecto Dev Logger 时不知道如何安装和配置。

解决步骤：

在项目的 mix.exs 文件中添加 Ecto Dev Logger 到依赖列表：
```
def deps do
  [
    {:ecto_dev_logger, "~> 0.14"}
  ]
end
```

在开发环境的配置文件中禁用默认的日志记录：

if config_env() == :dev do
  config :my_app, MyApp.Repo, log: false
end

在 MyApp.Application 模块中安装 Telemetry 处理器：

defmodule MyApp.Application do
  def start(_type, _args) do
    Ecto.DevLogger.install(MyApp.Repo)
  end
end

问题2：如何在生产环境中禁用 Ecto Dev Logger

问题描述： 用户希望在生产环境中禁用 Ecto Dev Logger，但不知道如何操作。

解决步骤：

在 mix.exs 文件中，将 Ecto Dev Logger 的依赖设置为仅在开发环境中安装：
```
def deps do
  [
    {:ecto_dev_logger, "~> 0.14", only: :dev}
  ]
end
```
确保在生产环境的配置文件中，日志配置是启用状态。

问题3：如何格式化查询日志

问题描述： 用户希望格式化查询日志以便更清晰地查看。

解决步骤：

在 MyApp.Application 模块中，使用 :before_inline_callback 选项设置格式化回调：

defmodule MyApp.Application do
  def start(_type, _args) do
    Ecto.DevLogger.install(MyApp.Repo, before_inline_callback: &__MODULE__.format_sql_query/1)
  end

  def format_sql_query(query) do
    case System.shell("echo #{query} | pg_format -", stderr_to_stdout: true) do
      {formatted_query, 0} -> String.trim_trailing(formatted_query)
      _ -> query
    end
  end
end