node.js - 在 Docker 容器中调试 Nodejs

Question

我正在为 nodejs 应用程序上的典型开发人员规划工作流程。我想你们大多数人都会:

git clone [appcode] + (Dockerfile with volume mapping to local path) > docker-compose build > docker-compose up

然后我编辑一些代码，最好使用 Webstorm 或文本编辑器 Sublime 等 IDE。然后终端 Ctrl+C 终止当前进程 > docker-compose up(或配置容器以使用 nodemon 来监视代码更改)和刷新浏览器以查看最新的本地代码正在运行。

以上所有内容看起来都很标准吗？

我的主要问题是是否有人使用 IDE 或 node-inspect 调试到容器中？

我尝试过暴露端口等。连接被拒绝。我相信因为 node.js 只允许在 127.0.0.1:5858 上调试

Answer 1

我设法让它在这里运行。我希望我可以将 node-inspector 作为 sidekick 容器运行，它会非常干净(编辑:有可能，请参阅答案结尾)。不幸的是，查看 node-inspector 源代码，无法远程运行 node-inspector(因为 node-inspector 需要访问文件才能显示它们)，因此即使是容器链接也是如此。也许它会在某个时候支持它。

这是我的解决方案:

在 Dockerfile 中，安装 node-inspector。我决定将其设为全局，以便我可以使用同一个容器来调试我的所有应用程序。

RUN npm install -g node-inspector

不要在 CMD 命令中使用午餐 Node ，而是使用 bash 脚本来启动多个进程。这不是 Docker 的方式，但正如我所说， Node 检查器的限制阻止我们使用 Sidekick 容器。您还可以使用更强大的流程管理解决方案，例如 supervisor但在我看来，调试一个简单的脚本就足够了。

CMD ["/bin/bash", "start.sh"]

此脚本检查是否存在 DEBUG 环境变量以启动 Node 并启用调试。

#!/bin/bash

if [ -z ${DEBUG+x} ]; then
  node server.js
else
  node-inspector --web-port 9080 &
  node --debug server.js
fi

我猜你可以使用相同的技巧来安装或不安装 Node 检查器。你甚至可以拥有conditional statement in RUN command如果您想跳过安装脚本。

然后当你想调试一个容器时，像这样启动它:

docker run -d -P -p 9080:9080 --env DEBUG=1 --name my_service \
    -v /home/docker/sources/.../:/usr/src/app custom-node

现在你只需要点击 docker daemon ip 进行调试，因为我们在 docker run 命令中暴露了脚本(9080)中指定的调试端口。我的 Dockerfile 已经暴露了我的主端口，所以我使用了 -P。

如果您的容器在本地 VM 上运行并且您设置在代理后面，请确保它支持本地地址或在调试之前禁用它。

---

编辑:现在可与 Sidekick 容器一起使用

这是我的 Node 调试容器 Dockerfile 的内容

FROM node:4.2.1

EXPOSE 9080

RUN npm install -g node-inspector

CMD ["node-inspector", "--web-port", "9080"]

Docker 为我们提供了 2 个功能，使 Node 检查器就像在本地与 Node 进程一起运行。

1. 尽管 node-inspector 似乎暗示您可以通过告诉您连接到 127.0.0.1:8080/?ws=127.0.0.1&port=5858 来连接到远程机器，但我找不到任何解析 ws 参数的代码，因此我使用 docker net config 选项将 node-debug 容器弹出到与调试进程相同的网络堆栈中:--net=容器:mysvc。这样，node-inspector 可以打开 websocket 连接到 localhost:5858。

2. 通过使用与调试进程相同的挂载点，您可以将文件本地性伪装成 Node 检查器进程。

现在为了方便一点，我建议使用 data container为您的应用程序来源。

如果您希望在调试中启动 Node 的可能性，请继续使用 start.sh 脚本(尽管删除 Node 检查器命令)。我想知道我们是否可以使用 signal但是，使用 docker，这将完全消除对 start.sh 的依赖。

if [ -z ${DEBUG+x} ]; then
  node server.js
else
  node --debug server.js
fi

所以创建数据容器:

docker create -v /home/docker/sources/.../:/usr/src/app  \
    --name my_service-src custom-node /bin/true

启动 Node 应用程序并公开 Node 检查器调试端口:

docker run -d -P -p 9080:9080 --env DEBUG=1 --name my_service \
    --volumes-from my_service-src custom-node

启动 Node 调试容器:

docker run -d --net=container:my_service --volumes-from my_service-src \
    --name node-debug node-debug

这样，您可以快速生成 Node 调试容器来调试 Node 进程。

连接到 docker ip 并享受您的调试 session !