memprof API完全参考stats、track、dump、trace_request全接口速查清单【免费下载链接】memprofA Ruby gem for memory profiling项目地址: https://gitcode.com/gh_mirrors/me/memprofmemprof 是一款运行在 Ruby 层面的内存剖析工具Memory Profiler帮你定位应用中的对象引用泄漏。它提供 stats、track、dump、dump_all、trace、trace_request 六大核心接口配合 Rack 中间件即可在生产环境中追踪每个请求的内存分配与 I/O 调用。本文以速查清单形式带你一次性掌握 memprof 的全部 API 用法。一、5分钟上手memprof 是什么memprof 是一个 Ruby gem它在不修改 Ruby 虚拟机的前提下记录每个新创建对象的文件:行号/类名信息同时还能做非常轻量的函数调用追踪系统调用、数据库查询、缓存操作等。安装方式gem install memprof⚠️ 版本提示memprof 仅支持Ruby 1.8.xMRI/REE64-bit 且带调试符号Ruby 1.8.7 以上版本不再兼容。相关接口注册见 ext/memprof.c。二、对象追踪接口stats 与 track1. Memprof.start / Memprof.stop —— 手动开关最底层的开关接口。调用start后所有新创建的 Ruby 对象都会记录创建位置Memprof.start 12.times{ abc } Memprof.stats Memprof.stop # 输出: 12 file.rb:2:String2. Memprof.stats —— 打印对象统计汇总start之后创建的对象按数量 文件:行号:类名打印Memprof.stats(/path/to/file)将结果写入文件而非 stdoutMemprof.stats!打印后清空已收集的追踪数据 排查泄漏的经典技巧GC 前后各调用一次 stats对比哪些对象被垃圾回收、哪些赖着不走puts Before GC Memprof.stats GC.start puts After GC Memprof.stats # 只有仍被引用的对象会保留测试用例可参考 spec/memprof_spec.rb。3. Memprof.track —— 块级统计最常用track是stats的便捷封装自动 start/stop并统计块内创建的每个对象Memprof.track{ 100.times{ abc } 100.times{ 1.23 1 } 100.times{ Module.new } } # 100 file.rb:2:String # 100 file.rb:3:Float # 100 file.rb:4:Module传入文件路径Memprof.track(/path/to/file)写入文件块末尾调用GC.start可只打印出仍在泄漏的对象三、堆导出接口dump 与 dump_all1. Memprof.dump —— 以 JSON 导出块内对象把块内创建的每个对象导出为详细 JSON含创建位置、类型、内容Memprof.dump{ hello world } # { _id: 0x15e5018, file: file.rb, line: 2, # type: string, class_name: String, # length: 10, data: helloworld }使用Memprof.dump(/path/to/filename)可逐行写入文件便于后续脚本分析。2. Memprof.dump_all —— 导出整个堆Memprof.dump_all(myapp_heap.json)一次性导出Ruby 虚拟机中所有存活对象每行一个 JSON。这是排查内存泄漏的终极武器——配合堆可视化工具可直观查看引用链。 生产环境实战技巧借助 lib/memprof/signal.rb 安装SIGURG信号处理器在不中断服务的情况下 fork 子进程导出整个堆require gem which memprof/signal.strip之后向进程发送信号即可触发dump_all堆快照写入/tmp/memprof-PID-时间戳.json。四、调用追踪接口trace 与 trace_request1. Memprof.trace —— 六合一轻量追踪器对一块代码同时统计以下维度输出统一 JSON 报告追踪维度统计内容objects每类对象创建数量gcGC 调用次数与耗时fdconnect/read/write/select 调用与耗时mysql查询次数与耗时memcache命令调用次数与响应分布内存malloc/realloc/free 调用与字节数Memprof.trace{ 10.times{ GC.start } 10.times{ open(http://google.com/) } }写入文件设置Memprof.trace_filename /path/to/file.json底层由 ext/tracers/ 目录下的 C 探针实现包括 gc.c、fd.c、mysql.c、memcache.c 等。2. Memprof.trace_request —— 请求级追踪trace的增强版接收一个 Rackenv把请求本身的信息URI、方法、客户端 IP、Rails 控制器/动作一并写入报告Memprof.trace_request(env){ app.call(env) } # { # rails: { controller: home, action: index }, # request: { REQUEST_URI: /home, REQUEST_METHOD: GET, ... }, # tracers: { ... }, # time: 1.3442 # }相关实现见 lib/memprof/tracer.rb行为验证见 spec/tracing_spec.rb。五、Rack 中间件零代码接入Memprof::Middleware —— 每请求对象统计require memprof/middleware config.middlewares.use(Memprof::Middleware)每个请求自动用Memprof.track包裹打印该请求创建的全部对象。源码见 lib/memprof/middleware.rb。传:force_gc true可在报告前强制 GC只保留泄漏对象建议在staging/production下使用——开发模式每请求会产生大量无关对象Memprof::Tracer —— 每请求调用追踪require memprof/tracer config.middleware.insert(0, Memprof::Tracer)用trace_request包裹每个请求结果写入/tmp/memprof_tracer-PID.json。Memprof::Filter —— Rails 2.2 遗留方案老版本 Rails 2.2 应用可在控制器中用around_filter(Memprof::Filter)达到同样效果。六、接口速查清单 接口用途输出需要 blockMemprof.start开启对象追踪无否Memprof.stop关闭对象追踪无否Memprof.stats([file])打印对象统计数量 文件:行:类名否Memprof.stats!([file])统计并清空数据同上否Memprof.track([file])块级对象统计同上是Memprof.dump([file])块级对象导出详细 JSON是Memprof.dump_all(file)全堆导出逐行 JSON否Memprof.trace([file])六合一调用追踪聚合 JSON是Memprof.trace_request(env)请求级追踪请求追踪 JSON是Memprof.trace_filename指定报告文件无否以上接口均在 C 扩展中注册为单例方法见 ext/memprof.c。七、避坑指南3 个高频问题为什么 gem install 后报错需要 64-bit Ruby 1.8.x 且带调试符号Linux 发行版通常要额外安装调试包如apt-get install libruby1.8-dbg。stats/dump 报 RuntimeError必须先调用Memprof.starttrack、dump带 block 的用法除外。报告太多噪音对象统计建议配合GC.startforce_gc调用追踪建议只包关键代码段。掌握以上接口从单行track快速自查到dump_all全堆取证memprof 都能胜任——Ruby 内存泄漏排查这一篇就够了。【免费下载链接】memprofA Ruby gem for memory profiling项目地址: https://gitcode.com/gh_mirrors/me/memprof创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考