riffer 0.35.0 → 0.37.0

data/lib/riffer/metrics.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-# rbs_inline: enabled
-
-# Internal metrics port — records OTEL metric instruments when the host bundles
-# the OpenTelemetry metrics API and no-ops otherwise, so riffer never declares
-# an OTEL dependency.
-module Riffer::Metrics # :nodoc: all
-  extend self
-
-  # @rbs @backend: untyped
-
-  MUTEX = Mutex.new #: Mutex
-
-  # The Ruby API cannot attach a schema URL to a meter, so the semconv pin
-  # lives here as the documented contract version.
-  SCHEMA_URL = "https://opentelemetry.io/schemas/1.37.0" #: String
-
-  # A handle to a named histogram, safe to hold as a constant: it defers backend
-  # resolution to record time, so it survives a meter-provider swap or a runtime
-  # +enabled+ flip.
-  class Histogram
-    # @rbs @name: String
-    # @rbs @unit: String?
-    # @rbs @description: String?
-
-    #--
-    #: (String, ?unit: String?, ?description: String?) -> void
-    def initialize(name, unit: nil, description: nil)
-      @name = name
-      @unit = unit
-      @description = description
-    end
-
-    #--
-    #: (Numeric, ?attributes: Hash[String, untyped]?) -> void
-    def record(value, attributes: nil)
-      Riffer::Metrics.record_histogram(@name, value, unit: @unit, description: @description, attributes: attributes)
-    end
-  end
-
-  # Returns a handle to the named histogram.
-  #--
-  #: (String, ?unit: String?, ?description: String?) -> Riffer::Metrics::Histogram
-  def create_histogram(name, unit: nil, description: nil)
-    Histogram.new(name, unit: unit, description: description)
-  end
-
-  # Records a value onto the named histogram.
-  #--
-  #: (String, Numeric, ?unit: String?, ?description: String?, ?attributes: Hash[String, untyped]?) -> void
-  def record_histogram(name, value, unit: nil, description: nil, attributes: nil)
-    return unless Riffer.config.metrics.enabled
-    backend.record_histogram(name, value, unit: unit, description: description, attributes: attributes)
-  end
-
-  # Mirrors a span's +recording?+ so a caller can skip work that exists only to
-  # feed a metric. True for any live backend — the OTEL backend or a
-  # consumer-supplied one — so a custom metrics sink still gets fed.
-  #--
-  #: () -> bool
-  def recording?
-    Riffer.config.metrics.enabled && !backend.equal?(NoOp)
-  end
-
-  # Reads the monotonic clock in seconds — the time source for duration metrics,
-  # immune to wall-clock adjustments.
-  #--
-  #: () -> Float
-  def monotonic_now
-    Process.clock_gettime(Process::CLOCK_MONOTONIC)
-  end
-
-  # Discards the resolved backend so the next record re-resolves it; cached
-  # instruments live on that backend, so this clears them too.
-  #--
-  #: () -> void
-  def reset!
-    MUTEX.synchronize { @backend = nil }
-  end
-
-  private
-
-  #--
-  #: () -> untyped
-  def backend
-    @backend || MUTEX.synchronize { @backend ||= resolve_backend }
-  end
-
-  #--
-  #: () -> untyped
-  def resolve_backend
-    Riffer.config.metrics.backend || NoOp
-  end
-end

data/sig/generated/riffer/metrics/instruments.rbs

@@ -1,15 +0,0 @@
-# Generated from lib/riffer/metrics/instruments.rb with RBS::Inline
-
-# The catalog of metric instruments riffer records. Each handle is a constant
-# that resolves its backend at record time, so it survives a meter-provider swap
-# or a runtime +enabled+ flip.
-module Riffer::Metrics::Instruments
-  # :nodoc: all
-  OPERATION_DURATION: Riffer::Metrics::Histogram
-
-  TOKEN_USAGE: Riffer::Metrics::Histogram
-
-  COST: Riffer::Metrics::Histogram
-
-  GUARDRAIL_DURATION: Riffer::Metrics::Histogram
-end

data/sig/generated/riffer/metrics/no_op.rbs

@@ -1,10 +0,0 @@
-# Generated from lib/riffer/metrics/no_op.rb with RBS::Inline
-
-# No-op metrics backend, used when the OpenTelemetry metrics API is unavailable
-# or metrics are disabled.
-module Riffer::Metrics::NoOp
-  # Ignores the measurement; there is no meter without the OTEL metrics API.
-  # --
-  # : (String, Numeric, unit: String?, description: String?, attributes: Hash[String, untyped]?) -> void
-  def record_histogram: (String, Numeric, unit: String?, description: String?, attributes: Hash[String, untyped]?) -> void
-end

data/sig/generated/riffer/metrics/otel.rbs

@@ -1,48 +0,0 @@
-# Generated from lib/riffer/metrics/otel.rb with RBS::Inline
-
-# OTEL-backed metrics backend. <tt>::OpenTelemetry</tt> constants appear only
-# inside method bodies here, so the gem loads and eager-loads cleanly when the
-# OpenTelemetry metrics API is absent.
-class Riffer::Metrics::Otel
-  # :nodoc: all
-  SUPPORTED_API_VERSIONS: Gem::Requirement
-
-  # Builds a backend when the OpenTelemetry metrics API is loadable at a
-  # supported version; returns +nil+ so resolution falls back to NoOp.
-  # +provider+ defaults to the global <tt>OpenTelemetry.meter_provider</tt>.
-  # --
-  # : (?provider: untyped) -> Riffer::Metrics::Otel?
-  def self.build: (?provider: untyped) -> Riffer::Metrics::Otel?
-
-  # Whether the OpenTelemetry metrics API gem is loadable at a supported
-  # version.
-  # --
-  # : () -> bool
-  def self.available?: () -> bool
-
-  # Whether the given opentelemetry-metrics-api version is one riffer codes
-  # against. The gem is undeclared, so this guard is the only protection
-  # against an incompatible, still-pre-1.0 API.
-  # --
-  # : (Gem::Version) -> bool
-  def self.supported?: (Gem::Version) -> bool
-
-  # --
-  # : () -> Gem::Version?
-  private def self.api_version: () -> Gem::Version?
-
-  @meter: untyped
-
-  @instruments: Hash[String, untyped]
-
-  @mutex: Mutex
-
-  # --
-  # : (provider: untyped) -> void
-  def initialize: (provider: untyped) -> void
-
-  # Records a value onto the named histogram.
-  # --
-  # : (String, Numeric, unit: String?, description: String?, attributes: Hash[String, untyped]?) -> void
-  def record_histogram: (String, Numeric, unit: String?, description: String?, attributes: Hash[String, untyped]?) -> void
-end

data/sig/generated/riffer/metrics.rbs

@@ -1,72 +0,0 @@
-# Generated from lib/riffer/metrics.rb with RBS::Inline
-
-# Internal metrics port — records OTEL metric instruments when the host bundles
-# the OpenTelemetry metrics API and no-ops otherwise, so riffer never declares
-# an OTEL dependency.
-module Riffer::Metrics
-  @backend: untyped
-
-  MUTEX: Mutex
-
-  # The Ruby API cannot attach a schema URL to a meter, so the semconv pin
-  # lives here as the documented contract version.
-  SCHEMA_URL: String
-
-  # A handle to a named histogram, safe to hold as a constant: it defers backend
-  # resolution to record time, so it survives a meter-provider swap or a runtime
-  # +enabled+ flip.
-  class Histogram
-    @name: String
-
-    @unit: String?
-
-    @description: String?
-
-    # --
-    # : (String, ?unit: String?, ?description: String?) -> void
-    def initialize: (String, ?unit: String?, ?description: String?) -> void
-
-    # --
-    # : (Numeric, ?attributes: Hash[String, untyped]?) -> void
-    def record: (Numeric, ?attributes: Hash[String, untyped]?) -> void
-  end
-
-  # Returns a handle to the named histogram.
-  # --
-  # : (String, ?unit: String?, ?description: String?) -> Riffer::Metrics::Histogram
-  def create_histogram: (String, ?unit: String?, ?description: String?) -> Riffer::Metrics::Histogram
-
-  # Records a value onto the named histogram.
-  # --
-  # : (String, Numeric, ?unit: String?, ?description: String?, ?attributes: Hash[String, untyped]?) -> void
-  def record_histogram: (String, Numeric, ?unit: String?, ?description: String?, ?attributes: Hash[String, untyped]?) -> void
-
-  # Mirrors a span's +recording?+ so a caller can skip work that exists only to
-  # feed a metric. True for any live backend — the OTEL backend or a
-  # consumer-supplied one — so a custom metrics sink still gets fed.
-  # --
-  # : () -> bool
-  def recording?: () -> bool
-
-  # Reads the monotonic clock in seconds — the time source for duration metrics,
-  # immune to wall-clock adjustments.
-  # --
-  # : () -> Float
-  def monotonic_now: () -> Float
-
-  # Discards the resolved backend so the next record re-resolves it; cached
-  # instruments live on that backend, so this clears them too.
-  # --
-  # : () -> void
-  def reset!: () -> void
-
-  private
-
-  # --
-  # : () -> untyped
-  def backend: () -> untyped
-
-  # --
-  # : () -> untyped
-  def resolve_backend: () -> untyped
-end

data/sig/manual/riffer/metrics/no_op.rbs

@@ -1,5 +0,0 @@
-# `Riffer::Metrics::NoOp` uses `extend self`; rbs-inline doesn't emit that, so
-# re-extend here to expose its instance methods as singleton methods.
-module Riffer::Metrics::NoOp
-  extend ::Riffer::Metrics::NoOp
-end

data/sig/manual/riffer/metrics.rbs

@@ -1,5 +0,0 @@
-# `Riffer::Metrics` uses `extend self`; rbs-inline doesn't emit that, so
-# re-extend here to expose its instance methods as singleton methods.
-module Riffer::Metrics
-  extend ::Riffer::Metrics
-end