Project

yabeda-gvl_metrics

0.0
No release in over 3 years
yabeda-gvl_metricsspeedshop/yabeda-gvl_metricsHomepageDocumentationSource CodeBug TrackerWiki
Registers Yabeda gauges for GVL instrumentation and wires middleware callbacks for Rack and Sidekiq.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Popularity
Downloads
146
Stars
0
Forks
0
Watchers
0
 Releases
Current version
0.1.0
Total releases
1
First release
1980-01-02
Latest release
1980-01-02
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2026-02-10
Reverse Dependencies
0

 Dependencies

Runtime

gvl_metrics_middleware
>= 0.3.0
yabeda
>= 0.6
 Project Readme

Yabeda::GvlMetrics

Yabeda plugin for exporting GVL metrics collected by gvl_metrics_middleware. It registers gauges in Yabeda and wires the middleware callbacks for Rack and Sidekiq.

Requirements

Installation

Add the gem to your Gemfile:

gem "yabeda-gvl_metrics"

Then run:

bundle install

Usage

In Rails, the Railtie auto-configures the plugin after initialization. It detects which frameworks are loaded (Rack and/or Sidekiq) and only wires the middleware for the ones that are present.

If you call Yabeda::GvlMetrics.configure! manually in an initializer, the Railtie will detect that the plugin is already configured and skip its own setup.

To configure it manually or disable one source (e.g. only for Sidekiq), add an initializer:

require "yabeda/gvl_metrics"

Yabeda::GvlMetrics.configure!(rack: true, sidekiq: false)

For non-Rails applications, call configure! directly after requiring the gem.

Metrics

All metrics are registered as Yabeda gauges in the gvl_metrics group with a source tag, reported in nanoseconds. Each gauge holds the value from the most recent request or job.

For metric definitions, see: https://github.com/speedshop/gvl_metrics_middleware?tab=readme-ov-file#available-metrics

Metric Tag Description
gvl_metrics_total source: "rack" or source: "sidekiq" Total time (running + io_wait + gvl_wait)
gvl_metrics_running source: "rack" or source: "sidekiq" Time spent running Ruby code
gvl_metrics_io_wait source: "rack" or source: "sidekiq" Time spent waiting on IO
gvl_metrics_gvl_wait source: "rack" or source: "sidekiq" Time spent waiting on the GVL

Contributing

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.