【问题标题】:Debug Nodejs inside Docker container在 Docker 容器中调试 Nodejs
【发布时间】:2016-01-04 02:30:02
【问题描述】:

我正在为 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 上调试

【问题讨论】:

  • 我用过docker logs -f [docker_name]
  • 所以@NguyenSyThanhSon 你是说你使用日志通过根据需要注销来执行简单的调试吗?我希望有一个解决方案,我可以像在使用 webstorm 的普通节点项目中一样设置断点。
  • 对此进行了一些工作,认为我的解决方案非常干净。让我知道你的想法。

标签: node.js docker remote-debugging


【解决方案1】:

经过一段时间的努力让这个工作,我发现添加:

--inspect-brk=0.0.0.0:9229

而不仅仅是通常的inspect-brk

让事情顺利进行。

您还需要在 docker run 命令中正确映射端口:

-p 9229:9229

完整示例:

docker run -ti -p 3000:3000 -p 9229:9229 -v `pwd`:/app/ myImage bash

node --inspect-brk=0.0.0.0:9229 /app/index.js

然后转到 chrome://inspect

然后点击“Open dedicated DevTools for Node”,它应该可以正常工作:)

【讨论】:

    【解决方案2】:

    我有一个类似于 Eric 上述的替代解决方案,但使用主机而不是容器网络。

    • 在主 node.js 容器中,将 5900 端口映射到主机
    • 在启用调试的情况下运行主节点进程
    • 使用单独的容器运行节点检查器
    • 为节点检查器容器使用主机网络

    我在这里写了一些关于它的更多细节:https://keylocation.sg/our-tech/debugging-nodejs-in-docker-using-node-inspector

    【讨论】:

      【解决方案3】:

      在这种情况下,为调试器 (node-debug) 和应用服务器 (custom-node) 使用两个不同的图像是没有意义的。因为 custom-node 容器也需要安装 node-inspector 二进制文件。否则,Cannot find module '/usr/lib/node_modules/node-inspector/lib/InjectorServer.js' 错误会被推送到 node-inspector 客户端控制台,并且也不会进行任何调试。

      【讨论】:

        【解决方案4】:

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

        这是我的解决方案:

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

        RUN npm install -g node-inspector
        

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

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

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

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

        我猜你可以使用相同的技巧来安装或不安装节点检查器。如果您想跳过安装脚本,您甚至可以使用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 容器一起使用

        这是我的节点调试容器 Dockerfile 的内容

        FROM node:4.2.1
        
        EXPOSE 9080
        
        RUN npm install -g node-inspector
        
        CMD ["node-inspector", "--web-port", "9080"]
        

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

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

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

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

        如果您希望在调试中启动节点的可能性,请继续使用 start.sh 脚本(尽管删除节点检查器命令)。我想知道我们是否可以在 docker 中使用signal,这将完全消除对 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
        

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

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

        启动节点调试容器:

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

        这样,您可以快速生成节点调试容器来调试节点进程。

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

        【讨论】:

        • 这太棒了,我认为你的学分不够!
        • node-inspector 已弃用,请参阅 github.com/node-inspector/node-inspector
        猜你喜欢
        • 1970-01-01
        • 1970-01-01
        • 2017-12-18
        • 1970-01-01
        • 2021-01-19
        • 2018-01-21
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多