Heap Periscope UI

Heap Periscope UI is a lightweight, configurable Ruby gem designed to provide a user interface for inspecting and analyzing the memory heap of a Ruby application, designed to be used with the heap_periscope_agent gem

This tool is a user interface and must be installed alongside the heap_periscope_agent gem. The agent is responsible for collecting the heap data, while this UI gem provides the visualization

Add this line to your application's Gemfile:

gem 'heap_periscope_agent'

And then execute:

bundle install

Or install it yourself as:

gem install heap_periscope_agent

Or you can find the complete installation setup here: https://github.com/codepawpaw/heap_periscope_ui

Add this line to your application's Gemfile:

gem 'heap_periscope_ui'

And then execute:

bundle install

Or install it yourself as:

gem install heap_periscope_ui

For Rails applications, after bundling the gem, run the config generator to create an initializer file:

rails generate heap_periscope_agent:config

This will create config/initializers/heap_periscope_agent.rb.

# config/initializers/heap_periscope_agent.rb
HeapPeriscopeAgent.configure do |config|
  # Interval in seconds for collecting and reporting metrics.
  config.interval = 10 # Default: 10

  # Host of the server where metrics will be sent.
  config.host = '127.0.0.1' # Default: '127.0.0.1'
  # Port of the metrics server.
  config.port = 9000 # Default: 9000
  # Enable verbose logging from the agent.
  config.verbose = true # Default: true
  # Enable collection of detailed object allocation information.
  # This can have a higher performance overhead.
  config.enable_detailed_objects = false # Default: false
  # If detailed_objects is enabled, this limits the number of
  # distinct object types to report on.
  config.detailed_objects_limit = 20 # Default: 20
end

If you want to monitor living objects inside rails controller, you can generate a specific tracker for it.

rails generate heap_periscope_agent:controller_instrumentation

Remember to enable config.enable_controller_instrumentation = true in your main HeapPeriscopeAgent initializer

If you want to monitor living objects inside rails model, you can generate a specific tracker for it.

rails generate heap_periscope_agent:model_instrumentation

Remember to enable config.enable_model_instrumentation = true in your main HeapPeriscopeAgent initializer

The agent can be easily configured to monitor the memory usage of your Sidekiq jobs.

To monitor every job processed by your Sidekiq server, you can install a middleware. This is the recommended approach for general monitoring.

rails generate heap_periscope_agent:sidekiq_middleware

This command creates an initializer that adds the tracking middleware to Sidekiq's server chain. Restart your Sidekiq process for the change to take effect.

If you need to focus on a single, potentially problematic job, you can instrument it directly.

rails generate heap_periscope_agent:job_tracker MySpecificJob

Replace MySpecificJob with the class name of your job (e.g., ProcessCsvJob, Integrations::ThirdPartySyncJob). This will prepend a tracking module directly into the job file.

The agent can also monitor the memory usage of your Rake tasks.

To monitor the entire execution of any Rake command (e.g., rails db:migrate, rails assets:precompile), you can install the Rake instrumentation. This is the recommended approach for general monitoring of background tasks.

rails generate heap_periscope_agent:rake_instrumentation

This command creates an initializer that wraps the main Rake execution loop, starting the agent when the command begins and stopping it when it finishes.

If you want to isolate and monitor a single Rake task, you can generate a specific tracker for it.

rails generate heap_periscope_agent:rake_task_tracker my_namespace:my_task

Replace my_namespace:my_task with the name of your task. This command will create a new file in lib/tasks/ that enhances your existing task at runtime to add memory profiling. This method does not modify your original Rake file.

Beyond the automated setup for Rails and Sidekiq, you can control the agent programmatically. This is useful for profiling specific sections of code, Rake tasks, or in non-Rails applications.

To monitor a specific piece of code, you can wrap it with HeapPeriscopeAgent.start and HeapPeriscopeAgent.stop. It's crucial to use an ensure block to guarantee that the agent is stopped, even if an error occurs.

begin
  HeapPeriscopeAgent.start
  # --- Your code to be profiled goes here ---
ensure
  HeapPeriscopeAgent.stop
end

Open http://localhost:3000/heap_periscope in your browser

If you don't need continuous monitoring and just want a single, on-demand snapshot of the application's memory state, you can use report_once!. This will collect and send a single report without starting the background monitoring thread.

HeapPeriscopeAgent.report_once!

After checking out the repo, run bin/setup to install dependencies (if you have such a script, otherwise bundle install).

To build the gem locally:

gem build heap_periscope_ui.gemspec

To install this gem onto your local machine:

gem install ./heap_periscope_ui-0.0.0.gem # Replace with the actual version built

You can also run bin/console for an interactive prompt that will allow you to experiment.

Bug reports and pull requests are welcome on GitHub at https://github.com/codepawpaw/heap_periscope_ui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

1. Fork the repository.
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin my-new-feature).
5. Create a new Pull Request.