Ecto DevLogger 使用指南

Ecto DevLogger 使用指南

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

---

项目介绍

Ecto DevLogger 是一个专为 Elixir 项目中的 Ecto 查询设计的开发环境专用日志记录器。它优化了查询日志的展示方式，将绑定值内嵌到查询中，使得开发者能够轻松地复制并粘贴日志中的 SQL 到任何IDE执行调试，而无需手动转换常见的 Elixir 类型（如二进制 UUID、日期时间、十进制数、JSON 等）为字符串表示。此外，它还特别突出了数据库操作的时间，帮助开发者迅速识别出响应缓慢的查询。

---

项目快速启动

安装步骤

在你的 mix.exs 文件的 deps 部分添加以下依赖：

def deps do
  [
    {:ecto_dev_logger, "~> 0.13"}  # 当前推荐版本号请以实际为准
  ]
end

然后，在配置文件（通常是config/config.exs），为了启用此 logger，在开发环境下禁用默认的日志记录：

if config_env() == :dev do
  config :your_app, YourApp.Repo,
    log: false
end

最后，确保在你的应用程序启动时安装 Telemetry 处理器：

defmodule YourApp.Application do
  ...

  def start(_type, _args) do
    maybe_install_ecto_dev_logger()

    ...
  end

  defp maybe_install_ecto_dev_logger do
    if Code.ensure_loaded?(Ecto.DevLogger) do
      Ecto.DevLogger.install(YourApp.Repo)
    else
      :ok
    end
  end
end

这样设置之后，Ecto DevLogger 就会在开发环境中自动生效。

格式化查询示例

你可以通过设置 :before_inline_callback 来自定义查询的格式化方式。下面的例子展示了如何使用外部工具 pgFormatter 进行格式化：

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

    ...
  end

  defp format_sql_query(query) do
    System.shell(
      "echo #{inspect(query)} | pg_format -",
      env: [["SQL_QUERY", inspect(query)]],
      stderr_to_stdout: true
    )
    |> elem(0)
    |> String.trim()
  end
end

---

应用案例和最佳实践

在开发阶段，Ecto DevLogger 的主要优势在于提高调试效率。每当遇到复杂的查询或性能瓶颈时，利用其直接可运行的 SQL 日志，可以快速验证查询逻辑，无需额外的手动转换过程。最佳实践中，建议结合性能监控工具，观察慢查询，并运用 Ecto DevLogger 快速定位和优化这些问题查询。

---

典型生态项目

虽然本指南专注于 Ecto DevLogger，但在 Elixir 生态系统中，与之配合使用的可能包括监控框架如 telemetry, 数据库连接池管理如 poolboy 或专门的数据库适配器如 postgrex。Ecto DevLogger 的存在强化了对 Ecto 查询日志的理解和控制能力，但要实现完整的应用性能管理和优化，还需要综合考虑这些生态中的其他组件。

在集成 Ecto DevLogger 后，持续关注 Ecto 的查询模式和性能指标，对于提升应用整体的健壮性和响应速度至关重要。

---

以上是 Ecto DevLogger 的基本使用指南，根据具体应用场景调整配置，使它成为你日常开发的得力助手。

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