39、深入探索 Elixir 系统的构建、运行与分析

深入探索 Elixir 系统的构建、运行与分析

1. 构建与启动系统

在构建系统时，基础镜像的选择至关重要。这里使用的基础镜像是 Debian，而非 Elixir 或 Erlang，并且要确保与构建镜像使用相同的基础操作系统，否则可能因不兼容导致系统崩溃。

以下是构建最终镜像的步骤：
1. 从构建阶段复制 OTP 版本。
2. 配置区域设置。
3. 定义默认启动命令，例如选择 start_iex 命令，以便连接到运行中的 shell。

以下是相关代码示例：

ENV LANG="en_US.UTF-8"
ENV LANGUAGE="en_US:en"
ENV LC_ALL="en_US.UTF-8"
CMD ["/todo/bin/todo", "start_iex"]

构建镜像的命令如下：

docker build . -t elixir-in-action/todo

启动容器的命令：

docker run \
--rm -it \
--name todo_system \
-p "5454:5454" \
elixir-in-action/todo

现在可以与系统进行本地交互，例如添加条目和查询条目：

curl -d "" "http://localhost:5454/add_entry?list=bob&date=2023-12-19&title=Dentist"
curl "http://localhost:5454/entries?list=bob&date=2023-12-19"

2. 系统分析概述

即使系统构建完成并投入生产，工作也并未结束。系统可能会出现问题、代码未优化以及资源消耗过多等情况。由于系统具有高度并发和分布式的特点，发现和理解出现的问题并非易事。以下是一些常用的分析技术：

分析技术	描述
调试	标准的逐步调试在高度并发系统中并不适用，应采用日志记录和跟踪等策略。
日志记录	使用 Elixir 的 logger 应用程序记录各种信息，帮助理解系统问题。
与系统交互	可以连接到运行中的节点，发送消息、停止或重启进程、获取系统和进程信息。
跟踪	可以开启与进程和函数调用相关的跟踪，分析系统行为。

3. 调试技巧

在 Erlang 中，标准的逐步调试并非常用方法，因为高度并发系统中同时发生的事情太多，经典调试会面临诸多问题。以下是一些更合适的调试策略：
- 日志记录和跟踪 ：这是理解高度并发系统的关键。Elixir 的 logger 应用程序可自动捕获 OTP 兼容进程崩溃时的错误和堆栈跟踪信息。
- IO.inspect ：在开发时，可用于快速确定问题原因。它会打印表达式的结果并返回该结果，不会影响程序行为。例如：

result = some_function() |> IO.inspect()

• dbg 宏 ：与 IO.inspect 类似，但能打印更详细的信息，如管道链的中间结果。

result = dbg(some_function())

• pry ：允许在 iex shell 中临时停止执行，检查系统状态。具体使用方法可参考 IEx.pry/0 文档。

此外，自动化测试、基准测试和性能分析工具也很有用，如 :timer.tc/1 函数、Erlang/OTP 自带的 cprof、eprof 和 fprof 工具，以及 Elixir 中的 mix 任务：
- mix profile.cprof
- mix profile.eprof
- mix profile.fprof

还有各种基准测试库，如 Benchee。

4. 日志记录

在生产环境中，不应再依赖 IO.inspect 或 dbg 调用，而应使用 Elixir 的 logger 应用程序记录信息。当生成 Mix 项目时，该依赖会自动包含。日志信息默认输出到控制台，如果以版本形式启动系统，标准输出将转发到版本根文件夹下的日志文件夹。

可以编写自定义的日志处理程序，如写入 syslog 或发送日志报告到其他机器。更多详细信息可参考 logger 文档和 Erlang 日志指南。

5. 与系统交互

Erlang 运行时的一个重要优势是可以连接到运行中的节点并以多种方式与之交互：
- 发送消息给进程。
- 停止或重启进程（包括监督者）或 OTP 应用程序。
- 强制 VM 重新加载模块代码。

还可以使用内置函数收集系统和进程信息，例如：
- :erlang.system_info/1 ：获取运行时信息。
- :erlang.memory/0 ：获取内存使用信息。
- Process.list/0 ：获取所有进程列表。
- Process.info/1 ：查询进程详细信息。

以 observer 应用程序为例，它可以在本地启动并从远程节点收集数据。要使用 observer，需要在 mix.exs 中包含 runtime_tools 应用程序：

defmodule Todo.MixProject do
  ...
  def application do
    [
      extra_applications: [:logger, :runtime_tools],
      ...
    ]
  end
  ...
end

启动系统和 observer 的步骤如下：
1. 后台启动系统：

RELEASE_NODE="todo@localhost" \
RELEASE_COOKIE="todo" \
_build/prod/rel/todo/bin/todo daemon

2. 启动交互式 shell 并运行 observer：

iex --hidden --sname observer@localhost --cookie todo
iex(observer@localhost)1> :observer.start()

然后在菜单中选择 Nodes > todo@localhost 。

除了 observer，还有其他前端工具，如 observer_cli，可通过命令行界面使用。

6. 跟踪技术

可以使用 :sys 和 :dbg 模块开启与进程和函数调用相关的跟踪。

6.1 使用 :sys 模块跟踪 OTP 兼容进程

以下是跟踪特定进程的步骤：
1. 确保节点未运行，然后以 iex 启动节点：

TODO_SERVER_EXPIRY=600 \
RELEASE_NODE="todo@localhost" \
RELEASE_COOKIE="todo" \
_build/prod/rel/todo/bin/todo daemon_iex

2. 连接到运行中的节点并开启跟踪：

_build/prod/rel/todo/erts-13.0/bin/to_erl _build/prod/rel/todo/tmp/pipe/
iex(todo@localhost)1> :sys.trace(Todo.Cache.server_process("bob"), true)

3. 发送 HTTP 请求：

curl "http://localhost:5454/entries?list=bob&date=2023-12-19"

在连接的 shell 中会看到跟踪信息。跟踪完成后，停止跟踪：

iex(todo@localhost)1> :sys.trace(Todo.Cache.server_process("bob"), false)

6.2 使用 :dbg 模块进行跟踪

以下是使用 :dbg 模块跟踪 Todo.Server 模块函数调用的步骤：
1. 启动另一个节点：

iex --sname tracer@localhost --cookie todo --hidden

2. 在 tracer 节点上设置跟踪：

iex(tracer@localhost)1> :dbg.tracer()
iex(tracer@localhost)2> :dbg.n(:"todo@localhost")
iex(tracer@localhost)3> :dbg.p(:all, [:call])
iex(tracer@localhost)4> :dbg.tp(Todo.Server, [])

3. 发送 HTTP 请求，在 tracer 节点的 shell 中会看到跟踪信息。跟踪完成后，停止所有跟踪：

iex(tracer@localhost)1> :dbg.stop_clear/0

需要注意的是，过度跟踪可能会影响系统性能，使用时要谨慎。此外，Recon 库也提供了许多有用的函数用于分析运行中的 BEAM 节点。

通过以上方法，可以更好地构建、运行和分析 Elixir 系统，确保系统的稳定性和性能。

深入探索 Elixir 系统的构建、运行与分析

7. 构建与运行系统的关键要点总结

为了更清晰地回顾构建和运行 Elixir 系统的关键步骤，我们可以用一个流程图来展示：

graph LR
    A[选择基础镜像] --> B[复制 OTP 版本]
    B --> C[配置区域设置]
    C --> D[定义启动命令]
    D --> E[构建镜像]
    E --> F[启动容器]
    F --> G[与系统交互]

以下是详细的操作步骤总结表格：
| 步骤 | 操作 | 命令示例 |
| — | — | — |
| 选择基础镜像 | 使用与构建镜像相同的基础操作系统，如 Debian | 无 |
| 复制 OTP 版本 | 从构建阶段复制 | 无 |
| 配置区域设置 | 设置环境变量 | plaintext<br>ENV LANG="en_US.UTF-8"<br>ENV LANGUAGE="en_US:en"<br>ENV LC_ALL="en_US.UTF-8"<br> |
| 定义启动命令 | 选择合适的启动命令，如 start_iex | plaintext<br>CMD ["/todo/bin/todo", "start_iex"]<br> |
| 构建镜像 | 使用 docker build 命令 | bash<br>docker build . -t elixir-in-action/todo<br> |
| 启动容器 | 配置相关参数启动容器 | bash<br>docker run \<br>--rm -it \<br>--name todo_system \<br>-p "5454:5454" \ <br>elixir-in-action/todo<br> |
| 与系统交互 | 进行添加条目、查询条目等操作 | bash<br>curl -d "" "http://localhost:5454/add_entry?list=bob&date=2023-12-19&title=Dentist"<br>curl "http://localhost:5454/entries?list=bob&date=2023-12-19"<br> |

8. 调试、日志、交互与跟踪的综合运用

在实际的 Elixir 系统开发和维护中，调试、日志、与系统交互和跟踪这几种技术需要综合运用。以下是一个简单的场景示例和应对策略列表：

场景	问题表现	应对策略
开发阶段代码出错	程序运行结果不符合预期	使用 IO.inspect 和 dbg 宏进行调试，结合自动化测试定位问题
生产环境进程崩溃	系统出现错误，部分功能无法正常使用	查看 Elixir 的 logger 应用程序记录的日志，分析堆栈跟踪信息
需要了解系统整体状态	想要查看系统资源使用情况、进程状态等	连接到运行中的节点，使用 :erlang.system_info/1 、 Process.list/0 等函数收集信息，或使用 observer 应用程序进行可视化展示
分析特定函数调用情况	怀疑某个模块的函数调用存在问题	使用 :dbg 模块进行跟踪，查看函数调用的输入参数和执行流程

9. 注意事项与最佳实践

在使用上述技术时，还需要注意以下几点：
- 调试方面 ：
- 开发完成后，及时移除 IO.inspect 和 dbg 调用，避免影响系统性能。
- 合理使用自动化测试，提高代码的稳定性和可维护性。
- 日志记录方面 ：
- 根据实际需求配置日志级别，避免记录过多无用信息。
- 考虑使用自定义日志处理程序，将日志存储到合适的位置，方便后续分析。
- 与系统交互方面 ：
- 操作时要谨慎，避免误操作导致系统出现问题。
- 确保节点的 cookie 配置正确，否则无法正常连接到运行中的节点。
- 跟踪方面 ：
- 控制跟踪的范围和时间，避免过度跟踪影响系统性能。
- 跟踪完成后，及时停止跟踪，释放系统资源。

10. 总结

通过对 Elixir 系统构建、运行和分析的深入探索，我们了解了从基础镜像选择到系统调试、日志记录、交互和跟踪的一系列技术和方法。以下是对整个过程的简要回顾：
1. 构建系统时，要选择合适的基础镜像，复制 OTP 版本，配置区域设置和启动命令，然后使用 Docker 构建和启动容器。
2. 系统运行过程中，可能会出现各种问题，需要运用调试、日志、交互和跟踪等技术进行分析和解决。
3. 调试时，采用日志记录和跟踪、 IO.inspect 、 dbg 宏和 pry 等策略。
4. 日志记录使用 Elixir 的 logger 应用程序，可根据需要进行自定义配置。
5. 与系统交互可以连接到运行中的节点，进行各种操作和获取信息。
6. 跟踪可以使用 :sys 和 :dbg 模块，分析进程和函数调用情况。

在实际应用中，要根据具体情况综合运用这些技术，遵循注意事项和最佳实践，确保 Elixir 系统的稳定性和性能。同时，不断学习和探索更多的知识和工具，提升自己在 Elixir 开发和维护方面的能力。