heap-profiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd1bb47a992405f240fc5b4cc0da81eab1c834184407fabafa98e466e119d890
+  data.tar.gz: b54e6472ed171723cb765002834fc9ef385d977d659aa96bddc5d7f5dff0428d
+SHA512:
+  metadata.gz: b052ccea980716b84308ffdfe490916c84cd796dcb40a4329b15d48097955a50ec576f6d440bfc6b143800dd8af2509d82ad675c1f7845ca44850ba6c161a36c
+  data.tar.gz: a70adefc9b02b9b22792d94775d982ca6148d45d56ebb47b97ca327e00eabe5ff0fafa663f1eb251a16b143eca6e4f790566c976ada0244f7492646608ab808a

data/.github/workflows/tests.yml

@@ -0,0 +1,59 @@
+name: CI
+on: [push]
+
+jobs:
+  rubocop:
+    name: Rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+      - name: Ruby gem cache
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run linters
+        run: |
+          bin/rubocop -c .rubocop.yml
+
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7' ]
+    name: Ruby ${{ matrix.ruby }} Tests
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Ruby gem cache
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+*.bundle
+*.so

data/.rubocop.yml

@@ -0,0 +1,20 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  Exclude:
+    - bin/generate-report
+    - vendor/bundle/**/*
+    - ext/**/*
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Lint/RescueException:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in heap-profiler.gemspec
+gemspec
+
+gem "rake"
+gem "rake-compiler"
+gem "minitest", "~> 5.0"
+gem "byebug"
+gem "rubocop-shopify", require: false
+gem "benchmark-ips"

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    heap-profiler (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    benchmark-ips (2.8.2)
+    byebug (11.1.3)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rake-compiler (1.1.1)
+      rake
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    rubocop-shopify (1.0.4)
+      rubocop (>= 0.85, < 0.87)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  byebug
+  heap-profiler!
+  minitest (~> 5.0)
+  rake
+  rake-compiler
+  rubocop-shopify
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jean Boussier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,269 @@
+# HeapProfiler
+
+A memory profiler for Ruby
+
+## Requirements
+
+Ruby(MRI) Version 2.6 and above.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heap-profiler'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install heap-profiler
+
+## Usage
+
+### Profiling Mode
+
+HeapProfiler can be used to measure memory allocations and retentions of a Ruby code snippet.
+
+To record a profile:
+
+```ruby
+require 'heap-profiler'
+HeapProfiler.report('path/to/report/directory') do
+  # You code here
+end
+```
+
+To then analyse the profile, run the `heap-profiler` command against the directory you specified.
+Note that on large applications this can take a while, but if you are profiling a production
+application, you can download the profile directory and do the analysis on another machine.
+
+```bash
+$ heap-profiler path/to/report/directory
+        Total allocated: 3.64 kB (35 objects)
+        Total retained: 728.00 B (11 objects)
+
+        allocated memory by gem
+        -----------------------------------
+           3.64 kB  other
+
+        allocated memory by file
+        -----------------------------------
+           3.64 kB  bin/generate-report
+
+        allocated memory by location
+        -----------------------------------
+           3.17 kB  bin/generate-report:32
+          157.00 B  bin/generate-report:26
+           72.00 B  bin/generate-report:20
+           40.00 B  bin/generate-report:29
+           40.00 B  bin/generate-report:28
+           40.00 B  bin/generate-report:24
+           40.00 B  bin/generate-report:23
+           40.00 B  bin/generate-report:22
+           40.00 B  bin/generate-report:21
+
+        allocated memory by class
+        -----------------------------------
+           1.18 kB  Class
+          848.00 B  <iseq> (IMEMO)
+          597.00 B  String
+          384.00 B  <ment> (IMEMO)
+          192.00 B  Hash
+          192.00 B  Array
+           80.00 B  <ifunc> (IMEMO)
+           80.00 B  <cref> (IMEMO)
+           40.00 B  Symbol
+           40.00 B  SomeCustomStuff
+
+        allocated objects by gem
+        -----------------------------------
+                35  other
+
+        allocated objects by file
+        -----------------------------------
+                35  bin/generate-report
+
+        allocated objects by location
+        -----------------------------------
+                27  bin/generate-report:32
+                 1  bin/generate-report:29
+                 1  bin/generate-report:28
+                 1  bin/generate-report:26
+                 1  bin/generate-report:24
+                 1  bin/generate-report:23
+                 1  bin/generate-report:22
+                 1  bin/generate-report:21
+                 1  bin/generate-report:20
+
+        allocated objects by class
+        -----------------------------------
+                12  String
+                 8  <ment> (IMEMO)
+                 4  Array
+                 2  Class
+                 2  <iseq> (IMEMO)
+                 2  <ifunc> (IMEMO)
+                 2  <cref> (IMEMO)
+                 1  Symbol
+                 1  SomeCustomStuff
+                 1  Hash
+
+        retained memory by gem
+        -----------------------------------
+          728.00 B  other
+
+        retained memory by file
+        -----------------------------------
+          728.00 B  bin/generate-report
+
+        retained memory by location
+        -----------------------------------
+          168.00 B  bin/generate-report:28
+          168.00 B  bin/generate-report:26
+          160.00 B  bin/generate-report:32
+           72.00 B  bin/generate-report:20
+           40.00 B  bin/generate-report:24
+           40.00 B  bin/generate-report:23
+           40.00 B  bin/generate-report:22
+           40.00 B  bin/generate-report:21
+
+        retained memory by class
+        -----------------------------------
+          336.00 B  Hash
+          240.00 B  String
+           72.00 B  Array
+           40.00 B  Symbol
+           40.00 B  SomeCustomStuff
+
+        retained objects by gem
+        -----------------------------------
+                11  other
+
+        retained objects by file
+        -----------------------------------
+                11  bin/generate-report
+
+        retained objects by location
+        -----------------------------------
+                 4  bin/generate-report:32
+                 1  bin/generate-report:28
+                 1  bin/generate-report:26
+                 1  bin/generate-report:24
+                 1  bin/generate-report:23
+                 1  bin/generate-report:22
+                 1  bin/generate-report:21
+                 1  bin/generate-report:20
+
+        retained objects by class
+        -----------------------------------
+                 6  String
+                 2  Hash
+                 1  Symbol
+                 1  SomeCustomStuff
+                 1  Array
+
+        Allocated String Report
+        -----------------------------------
+           80.00 B       2  "foo="
+                         2  bin/generate-report:32
+
+           80.00 B       2  "foo"
+                         2  bin/generate-report:32
+
+           80.00 B       2  "bar="
+                         2  bin/generate-report:32
+
+           80.00 B       2  "I am retained"
+                         1  bin/generate-report:22
+                         1  bin/generate-report:21
+
+           40.00 B       1  "I am retained too"
+                         1  bin/generate-report:23
+
+           40.00 B       1  "I am allocated too"
+                         1  bin/generate-report:29
+
+           40.00 B       1  "I am allocated"
+                         1  bin/generate-report:28
+
+          157.00 B       1  "I am a very very long string I am a very very long string I am a very very long string I am a very very long string "
+                         1  bin/generate-report:26
+
+
+        Retained String Report
+        -----------------------------------
+           80.00 B       2  "I am retained"
+                         1  bin/generate-report:22
+                         1  bin/generate-report:21
+
+           40.00 B       1  "foo="
+                         1  bin/generate-report:32
+
+           40.00 B       1  "foo"
+                         1  bin/generate-report:32
+
+           40.00 B       1  "bar="
+                         1  bin/generate-report:32
+
+           40.00 B       1  "I am retained too"
+                         1  bin/generate-report:23
+```
+
+### Heap Analysis
+
+Alternatively if you with to analyse the entire heap of your Ruby process.
+
+If you can, you should enable allocation tracing as early as possible during your application boot process, e.g. in `config/boot.rb` for Rails apps.
+
+```ruby
+require 'objspace'
+ObjectSpace.trace_object_allocations_start.
+```
+
+Then to dump the heap:
+
+```ruby
+require 'objspace'
+ObjectSpace.dump_all(output: File.open('path/to/file.heap', 'w+'))
+```
+
+Then run `heap-profiler` against it:
+
+```bash
+heap-profiler path/to/file.heap
+```
+
+## How is it different from memory_profiler?
+
+`heap-profiler` is heavilly inspired of `memory_profiler`, it aims at being as similar as possible.
+However it uses a different Ruby API to gather data.
+
+`memory_profiler` uses [`ObjectSpace.each_object`](https://ruby-doc.org/core-2.7.1/ObjectSpace.html#method-c-each_object) which contrary to what its name
+suggest doesn't expose all existing object. There are many objects that the Ruby VM consider "internal" (see MRI's `internal_object_p(VALUE)`) and won't yield to `each_object`.
+
+On the other hand `heap-profiler` uses [`ObjectSpace.dump_all`](https://ruby-doc.org/stdlib-2.7.1/libdoc/objspace/rdoc/ObjectSpace.html#method-c-dump_all), which
+does serialize every objects, including internal ones, into JSON files. This leads to more exhaustive reports.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/heap-profiler.
+
+## Thanks
+
+This gem was heavilly inspired from http://github.com/SamSaffron/memory_profiler, it even borrowed some code from it, so thanks to [@SamSaffron](https://github.com/SamSaffron).
+
+It also makes heavy use of https://github.com/simdjson/simdjson for fast heap dump parsing. So big thanks to [Daniel Lemire](https://github.com/lemire) and [John Keiser](https://github.com/jkeiser).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).