yabeda-jemalloc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34cf4df8c852318316b430e722a61c47428bd9356e3babb436b1e46991484847
+  data.tar.gz: 6b98e646b0dcb22aa0041123765e8540b867b500219ec06cbbbede103a29df8b
+SHA512:
+  metadata.gz: 542b28ac7dc2b44c6c072cdf55e9fe4c7e9c11eb3ac3e3789c1946c62d2c75ac18af07a05b528e81e9d644adcbb4278dda33df525dbca7fa824893bd216e5db4
+  data.tar.gz: fa49fd16af6857405c0d80f6aa7cf35ba4a4a9bcf23ee93e112d02244388e3d9446dc17a67370d8b208f0629173bdf79fadef6aaf9b0088263fbaf65a9d450c4

data/.github/workflows/gem-push.yml

@@ -0,0 +1,35 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 2.6
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2.2
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.GEM_HOST_API_KEY}}"

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yabeda-jemalloc.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    yabeda-jemalloc (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  yabeda-jemalloc!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Jon David Schober
+
+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,193 @@
+# Yabeda::Jemalloc
+
+[![Gem Version](https://badge.fury.io/rb/yabeda-jemalloc.svg)](https://badge.fury.io/rb/yabeda-jemalloc)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+
+A [Yabeda](https://github.com/yabeda-rb/yabeda) plugin that exposes [jemalloc](http://jemalloc.net/) memory allocation statistics for Ruby applications. This gem uses FFI to interface with jemalloc's `mallctl` API and exports key memory metrics to Prometheus or other monitoring systems.
+
+## Why Use This Gem?
+
+Jemalloc is a high-performance memory allocator that provides detailed memory statistics. When running Ruby applications with jemalloc, you can gain valuable insights into:
+
+- **Memory fragmentation**: Understand the difference between allocated vs. resident memory
+- **Virtual memory usage**: Track total mapped memory by jemalloc
+- **Active allocations**: Monitor memory backing live allocations
+
+This is especially useful for production Ruby applications where memory management and leak detection are critical.
+
+## Requirements
+
+- Ruby 2.6 or higher
+- [jemalloc](http://jemalloc.net/) installed and preloaded via `LD_PRELOAD`
+- [Yabeda](https://github.com/yabeda-rb/yabeda) gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yabeda-jemalloc'
+gem 'yabeda-prometheus' # or another exporter
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+### 1. Install jemalloc
+
+First, ensure jemalloc is installed on your system:
+
+**Ubuntu/Debian:**
+```bash
+sudo apt-get install libjemalloc2
+```
+
+**macOS:**
+```bash
+brew install jemalloc
+```
+
+**Alpine Linux:**
+```bash
+apk add jemalloc
+```
+
+### 2. Configure Your Application
+
+The gem automatically registers metrics when jemalloc is detected. Simply require it in your application:
+
+```ruby
+require 'yabeda/jemalloc'
+```
+
+For Rails applications, add to your `config/initializers/yabeda.rb`:
+
+```ruby
+require 'yabeda/prometheus'
+require 'yabeda/jemalloc'
+```
+
+### 3. Run with jemalloc Preloaded
+
+You need to preload jemalloc when starting your Ruby application:
+
+```bash
+LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2 bundle exec rails server
+```
+
+Or for other Ruby applications:
+
+```bash
+LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2 ruby your_app.rb
+```
+
+**Docker Example:**
+
+```dockerfile
+FROM ruby:3.3
+RUN apt-get update && apt-get install -y libjemalloc2
+ENV LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2
+# ... rest of your Dockerfile
+```
+
+### 4. Access Metrics
+
+If using `yabeda-prometheus`, metrics will be available at your configured metrics endpoint (typically `/metrics`):
+
+```
+# HELP jemalloc_mapped_bytes Total virtual bytes mapped by jemalloc
+# TYPE jemalloc_mapped_bytes gauge
+jemalloc_mapped_bytes 2147483648
+
+# HELP jemalloc_resident_bytes Resident bytes (RSS) that belong to jemalloc
+# TYPE jemalloc_resident_bytes gauge
+jemalloc_resident_bytes 1073741824
+
+# HELP jemalloc_active_bytes Bytes backing live allocations (user + internal)
+# TYPE jemalloc_active_bytes gauge
+jemalloc_active_bytes 536870912
+
+# HELP jemalloc_allocated_bytes Bytes actually allocated by the app
+# TYPE jemalloc_allocated_bytes gauge
+jemalloc_allocated_bytes 268435456
+```
+
+## Exposed Metrics
+
+| Metric Name | Type | Description |
+|-------------|------|-------------|
+| `jemalloc_mapped_bytes` | gauge | Total number of bytes in active extents mapped by the allocator |
+| `jemalloc_resident_bytes` | gauge | Maximum number of bytes in physically resident data pages mapped by the allocator |
+| `jemalloc_active_bytes` | gauge | Total number of bytes in active pages allocated by the application |
+| `jemalloc_allocated_bytes` | gauge | Total number of bytes allocated by the application |
+
+### Understanding the Metrics
+
+- **Mapped**: Virtual memory allocated by jemalloc (highest number)
+- **Resident**: Physical memory (RAM) actually used (RSS)
+- **Active**: Memory pages with at least one allocation
+- **Allocated**: Memory requested by your application (lowest number)
+
+The difference between these metrics helps identify memory fragmentation and over-allocation issues.
+
+## Configuration
+
+The gem automatically configures itself when jemalloc is detected via `LD_PRELOAD`. No additional configuration is required.
+
+If jemalloc is not preloaded, the gem will silently skip metric registration, allowing you to safely include it in environments where jemalloc may not be available.
+
+## Troubleshooting
+
+### Metrics not appearing?
+
+1. Verify jemalloc is preloaded:
+   ```bash
+   echo $LD_PRELOAD  # should include libjemalloc.so.2
+   ```
+
+2. Check if jemalloc is actually being used:
+   ```bash
+   ldd $(which ruby) | grep jemalloc
+   ```
+
+3. Ensure Yabeda is properly configured with an exporter (e.g., `yabeda-prometheus`)
+
+### Wrong jemalloc path?
+
+The path to `libjemalloc.so.2` varies by system. Find it with:
+
+```bash
+find /usr -name "libjemalloc.so*" 2>/dev/null
+```
+
+Then use the full path in your `LD_PRELOAD`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jondavidschober/yabeda-jemalloc.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Created by [Jon David Schober](https://github.com/jondavidschober) at [Datavine](https://getdatanamic.com).
+
+## See Also
+
+- [Yabeda](https://github.com/yabeda-rb/yabeda) - Extensible framework for collecting metrics
+- [jemalloc](http://jemalloc.net/) - General purpose malloc implementation
+- [yabeda-prometheus](https://github.com/yabeda-rb/yabeda-prometheus) - Prometheus exporter for Yabeda
+- [Observability is the Eyes and Ears of a Service](dev.datavine.com/observability-is-the-eyes-and-ears-of-a-service)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yabeda/jemalloc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yabeda/jemalloc/ffi.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'ffi'
+module Yabeda::Jemalloc::JemallocFFI
+  if ENV['LD_PRELOAD']&.include?('libjemalloc.so.2')
+    extend FFI::Library
+    ffi_lib 'libjemalloc.so.2' # uses the already-preloaded jemalloc.so
+
+    attach_function :mallctl, %i[string pointer pointer pointer size_t], :int
+
+    SIZE_T = FFI::Type::ULONG_LONG.size # works on 64-bit only
+
+    def self.refresh!
+      epoch = FFI::MemoryPointer.new(:ulong_long)
+      sz    = FFI::MemoryPointer.new(:size_t).write_ulong_long(SIZE_T)
+      mallctl('epoch', epoch, sz, epoch, SIZE_T) # epoch++ refreshes stats
+    end
+
+    def self.uint64(name)
+      buf = FFI::MemoryPointer.new(:ulong_long)
+      sz  = FFI::MemoryPointer.new(:size_t).write_ulong_long(SIZE_T)
+      mallctl(name, buf, sz, nil, 0)
+      buf.read_ulong_long
+    end
+
+    def self.dump(path)
+      path_ptr = FFI::MemoryPointer.from_string(path)
+      path_arg = FFI::MemoryPointer.new(:pointer)
+      path_arg.write_pointer(path_ptr)
+      ret = Jemalloc.mallctl('prof.dump', nil, nil, path_arg, FFI::Type::POINTER.size)
+
+      raise "mallctl failed with error code #{ret}" if ret != 0
+
+      puts "Heap profile dumped to #{path || 'default path'}"
+    end
+  end
+end

data/lib/yabeda/jemalloc/version.rb

@@ -0,0 +1,5 @@
+module Yabeda
+  module Jemalloc
+    VERSION = "0.1.0"
+  end
+end

data/lib/yabeda/jemalloc.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'yabeda/jemalloc/version'
+
+module Yabeda
+  module Jemalloc
+    Yabeda.configure do
+      if ENV['LD_PRELOAD']&.include?('libjemalloc.so.2')
+        gauge :jemalloc_mapped_bytes,
+              comment: 'Total virtual bytes mapped by jemalloc'
+        gauge :jemalloc_resident_bytes,
+              comment: 'Resident bytes (RSS) that belong to jemalloc'
+        gauge :jemalloc_active_bytes,
+              comment: 'Bytes backing live allocations (user + internal)'
+        gauge :jemalloc_allocated_bytes,
+              comment: 'Bytes actually allocated by the app'
+        collect do
+          JemallocFFI.refresh!
+          jemalloc_mapped_bytes.set({}, JemallocFFI.uint64('stats.mapped'))
+          jemalloc_resident_bytes.set({}, JemallocFFI.uint64('stats.resident'))
+          jemalloc_active_bytes.set({}, JemallocFFI.uint64('stats.active'))
+          jemalloc_allocated_bytes.set({}, JemallocFFI.uint64('stats.allocated'))
+        end
+      end
+    end
+  end
+end

data/yabeda-jemalloc.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yabeda/jemalloc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yabeda-jemalloc"
+  spec.version       = Yabeda::Jemalloc::VERSION
+  spec.authors       = ["Jon David Schober"]
+  spec.email         = ["jon@getdatanamic.com"]
+
+  spec.summary       = %q{Yabeda plugin for monitoring jemalloc stats}
+  spec.description   = %q{Yabeda plugin that exposes the jemalloc stats extracted from an FFI to prometheus}
+  spec.homepage      = "https://github.com/jondavidschober/yabeda-jemalloc"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/jondavidschober/yabeda-jemalloc"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "yabeda", "~> 0.6"
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-jemalloc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon David Schober
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Yabeda plugin that exposes the jemalloc stats extracted from an FFI to
+  prometheus
+email:
+- jon@getdatanamic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yabeda/jemalloc.rb
+- lib/yabeda/jemalloc/ffi.rb
+- lib/yabeda/jemalloc/version.rb
+- yabeda-jemalloc.gemspec
+homepage: https://github.com/jondavidschober/yabeda-jemalloc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jondavidschober/yabeda-jemalloc
+  source_code_uri: https://github.com/jondavidschober/yabeda-jemalloc
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Yabeda plugin for monitoring jemalloc stats
+test_files: []