hasnat/docker-stats-on-exit-shim

Docker Stats On Exit Shim

镜像概述

Docker Stats On Exit Shim是一个轻量实用工具，旨在容器销毁前捕获其运行期间的Cgroup子系统统计信息。它作为容器的主进程，等待实际命令执行完毕后，查询Cgroup数据并以JSON格式输出，同时保持原命令的退出码。

核心功能

1. 捕获容器退出前的Cgroup统计数据（CPU、内存、IO、Pids等）
2. 支持自定义输出文件路径和前缀
3. 保留原命令的退出码
4. 输出结构化JSON格式的统计结果

使用场景

• 分析容器单次运行的资源消耗情况
• 调试容器性能瓶颈（如CPU占用、内存泄漏）
• 收集容器运行的资源使用日志用于后续分析

配置说明

通过环境变量配置工具行为：

• STATS_OUTPUT_FILE: 统计结果输出路径，默认值为/dev/stdout
• STATS_OUTPUT_PREFIX: 输出内容的前缀字符串，默认无

示例

Dockerfile集成

dockerfile
COPY --from=hasnat/docker-stats-on-exit-shim:exitgo2 /docker-stats-on-exit-shim .
ENTRYPOINT ["/docker-stats-on-exit-shim"]
CMD ["sleep", "1"]

运行示例

bash
docker run --rm -ti hasnat/docker-stats-on-exit-shim:exitgo2 /bin/sleep 1

输出示例（JSON片段）

json
{"cgroup.controllers":"cpuset cpu io memory hugetlb pids rdma","cpu.stat.usage_usec":"112557","memory.current":"6676480","pids.current":"3"}

构建镜像

bash
docker build -t docker-stats-on-exit-shim .

开发调试

将源码挂载到容器中运行脚本：

bash
docker run --rm -it -v `pwd`:`pwd` -w `pwd` --entrypoint=./shim.sh alpine 2>&1 | jq -c .

注意事项

1. 统计数据并非完全在容器销毁前捕获，但误差极小
2. 工具本身会产生少量资源消耗（如CPU），但可忽略
3. 当前版本基于Cgroup文件直接读取数据，后续会根据官方文档优化