sentry-yabeda 6.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 240d26d6fb3fd640846c0012d52573e1ef8d52f8ee196ccdae1f48847986f6dd
+  data.tar.gz: ae115213024349ce83a753c66e113a31d3bd12e61f5359cb273998f74fd7db77
+SHA512:
+  metadata.gz: 76b1256442c8eded36f5c6b34790b11e0bb7acc8fe72e55ac4661292fe971ced5f633d4ce13a4ce11bef222be44942f0a1e45a686316f38e53cf9fac58e0647e
+  data.tar.gz: d3541d062a739013e80be0ded8eacdc7ece9766032d96a13a59e0fd182113669172e1f19840fb6fede5c061c4d6f333a93c53202e7f2d870d476613e3f3abe88

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+git_source(:github) { |name| "https://github.com/#{name}.git" }
+
+eval_gemfile "../Gemfile.dev"
+
+# Specify your gem's dependencies in sentry-yabeda.gemspec
+gemspec
+
+gem "sentry-ruby", path: "../sentry-ruby"
+
+gem "timecop"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sentry
+
+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/Makefile

@@ -0,0 +1,3 @@
+build:
+	bundle install
+	gem build sentry-yabeda.gemspec

data/README.md

@@ -0,0 +1,47 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br>
+</p>
+
+# sentry-yabeda, the Yabeda integration for Sentry's Ruby client
+
+---
+
+[![Gem Version](https://img.shields.io/gem/v/sentry-yabeda.svg)](https://rubygems.org/gems/sentry-yabeda)
+![Build Status](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_yabeda_test.yml/badge.svg)
+[![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master)
+[![Gem](https://img.shields.io/gem/dt/sentry-yabeda.svg)](https://rubygems.org/gems/sentry-yabeda/)
+
+
+[Documentation](https://docs.sentry.io/platforms/ruby/) | [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
+
+The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
+
+
+## Getting Started
+
+### Install
+
+```ruby
+gem "sentry-ruby"
+gem "sentry-yabeda"
+```
+
+Then initialize Sentry with metrics enabled:
+
+```ruby
+Sentry.init do |config|
+  config.dsn = ENV["SENTRY_DSN"]
+  config.enable_metrics = true
+end
+```
+
+That's it! All Yabeda metrics will automatically flow to Sentry.
+
+## How it works
+
+Counters, histograms, summaries, and directly-set gauges all forward to Sentry inline when your app calls them. Yabeda summaries map to Sentry distributions, as Sentry has no summary type.
+
+Collector blocks (`Yabeda.configure { collect { ... } }`) are Yabeda's pull hook — in Prometheus they're triggered by a scrape request. Since Sentry is push-based, `sentry-yabeda` runs a background thread that calls `Yabeda.collect!` every 15 seconds. Metrics populated this way (typically gauges for GC stats, thread counts, etc.) won't carry trace context.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require_relative "../lib/sentry/test/rake_tasks"
+
+Sentry::Test::RakeTasks.define_spec_tasks(
+  spec_pattern: "spec/sentry/**/*_spec.rb",
+  spec_rspec_opts: "--order rand --format progress"
+)
+
+task default: :spec

data/lib/sentry/yabeda/adapter.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "yabeda/base_adapter"
+
+module Sentry
+  module Yabeda
+    class Adapter < ::Yabeda::BaseAdapter
+      # Sentry does not require pre-registration of metrics
+      def register_counter!(_metric); end
+      def register_gauge!(_metric); end
+      def register_histogram!(_metric); end
+      def register_summary!(_metric); end
+
+      def perform_counter_increment!(counter, tags, increment)
+        return unless enabled?
+
+        Sentry.metrics.count(
+          metric_name(counter),
+          value: increment,
+          attributes: attributes_for(tags)
+        )
+      end
+
+      def perform_gauge_set!(gauge, tags, value)
+        return unless enabled?
+
+        Sentry.metrics.gauge(
+          metric_name(gauge),
+          value,
+          unit: unit_for(gauge),
+          attributes: attributes_for(tags)
+        )
+      end
+
+      def perform_histogram_measure!(histogram, tags, value)
+        return unless enabled?
+
+        Sentry.metrics.distribution(
+          metric_name(histogram),
+          value,
+          unit: unit_for(histogram),
+          attributes: attributes_for(tags)
+        )
+      end
+
+      def perform_summary_observe!(summary, tags, value)
+        return unless enabled?
+
+        Sentry.metrics.distribution(
+          metric_name(summary),
+          value,
+          unit: unit_for(summary),
+          attributes: attributes_for(tags)
+        )
+      end
+
+      private
+
+      def enabled?
+        Sentry.initialized? && Sentry.configuration.enable_metrics
+      end
+
+      def attributes_for(tags)
+        tags.empty? ? nil : tags
+      end
+
+      def metric_name(metric)
+        [metric.group, metric.name].compact.join(".")
+      end
+
+      def unit_for(metric)
+        metric.unit&.to_s&.chomp("s")
+      end
+    end
+  end
+end

data/lib/sentry/yabeda/collector.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "sentry/threaded_periodic_worker"
+
+module Sentry
+  module Yabeda
+    # Periodically calls Yabeda.collect! to trigger gauge collection blocks
+    # registered by plugins like yabeda-puma-plugin, yabeda-gc, and
+    # yabeda-gvl_metrics.
+    #
+    # In a pull-based system (Prometheus), the scrape request triggers
+    # collection. In a push-based system (Sentry), we need this periodic
+    # worker to drive the collect → gauge.set → adapter.perform_gauge_set!
+    # pipeline.
+    class Collector < Sentry::ThreadedPeriodicWorker
+      DEFAULT_INTERVAL = 15 # seconds
+
+      def initialize(configuration, interval: DEFAULT_INTERVAL)
+        super(configuration.sdk_logger, interval)
+        ensure_thread
+      end
+
+      def run
+        ::Yabeda.collect!
+      rescue => e
+        log_warn("[Sentry::Yabeda::Collector] collection failed: #{e.message}")
+      end
+    end
+  end
+end

data/lib/sentry/yabeda/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sentry
+  class Configuration
+    after(:configured) do
+      if enable_metrics
+        Sentry::Yabeda.collector&.kill
+        Sentry::Yabeda.collector = Sentry::Yabeda::Collector.new(self)
+      end
+    end
+
+    after(:closed) do
+      if (collector = Sentry::Yabeda.collector)
+        collector.run
+        collector.kill
+        Sentry::Yabeda.collector = nil
+      end
+    end
+  end
+end

data/lib/sentry/yabeda/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Yabeda
+    VERSION = "6.6.0"
+  end
+end

data/lib/sentry-yabeda.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "yabeda"
+require "sentry-ruby"
+require "sentry/integrable"
+require "sentry/yabeda/version"
+require "sentry/yabeda/adapter"
+require "sentry/yabeda/collector"
+require "sentry/yabeda/configuration"
+
+module Sentry
+  module Yabeda
+    extend Sentry::Integrable
+
+    register_integration name: "yabeda", version: Sentry::Yabeda::VERSION
+
+    class << self
+      attr_accessor :collector
+    end
+  end
+end
+
+::Yabeda.register_adapter(:sentry, Sentry::Yabeda::Adapter.new)

data/sentry-yabeda.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/sentry/yabeda/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sentry-yabeda"
+  spec.version       = Sentry::Yabeda::VERSION
+  spec.authors = ["Sentry Team"]
+  spec.description = spec.summary = "A gem that provides Yabeda integration for the Sentry error logger"
+  spec.email = "accounts@sentry.io"
+  spec.license = 'MIT'
+
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.7'
+  spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|\.rubocop\.yml)'`.split("\n")
+
+  github_root_uri = 'https://github.com/getsentry/sentry-ruby'
+  spec.homepage = "#{github_root_uri}/tree/#{spec.version}/#{spec.name}"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{github_root_uri}/blob/#{spec.version}/CHANGELOG.md",
+    "bug_tracker_uri" => "#{github_root_uri}/issues",
+    "documentation_uri" => "http://www.rubydoc.info/gems/#{spec.name}/#{spec.version}"
+  }
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sentry-ruby", "~> 6.6.0"
+  spec.add_dependency "yabeda", ">= 0.11"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: sentry-yabeda
+version: !ruby/object:Gem::Version
+  version: 6.6.0
+platform: ruby
+authors:
+- Sentry Team
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.0
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: A gem that provides Yabeda integration for the Sentry error logger
+email: accounts@sentry.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- lib/sentry-yabeda.rb
+- lib/sentry/yabeda/adapter.rb
+- lib/sentry/yabeda/collector.rb
+- lib/sentry/yabeda/configuration.rb
+- lib/sentry/yabeda/version.rb
+- sentry-yabeda.gemspec
+homepage: https://github.com/getsentry/sentry-ruby/tree/6.6.0/sentry-yabeda
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.6.0/sentry-yabeda
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.6.0/sentry-yabeda
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.6.0/CHANGELOG.md
+  bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
+  documentation_uri: http://www.rubydoc.info/gems/sentry-yabeda/6.6.0
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A gem that provides Yabeda integration for the Sentry error logger
+test_files: []