Table of Contents - Sashiko — Declarative OpenTelemetry for Ruby 4

Pages

• README
  • Sashiko
  • The boundary problem
  • What it gives you
  • When to use Sashiko
  • Requirements
  • Quick start
  • Core API
  • Sashiko::Traced — declarative spans
  • Sashiko::Context — propagation across Thread / Fiber
  • Sashiko::Context.carrier — across processes, queues, Ractors
  • Sashiko::Ractor — parallel execution with span replay
  • Sashiko::Box — per-Box instrumentation (Ruby 4, experimental)
  • Adapters
  • Rails
  • Faraday
  • Anthropic (optional, may move to a separate gem)
  • Types
  • Examples
  • Development
  • Appendix: Ruby version targeting
  • License

Classes and Modules

• Sashiko
• Sashiko::Adapters
• Sashiko::Adapters::Anthropic
• Sashiko::Adapters::Anthropic::Wrapper
• Sashiko::Adapters::Faraday
• Sashiko::Adapters::Faraday::Middleware
• Sashiko::Box
• Sashiko::Box::NotEnabledError
• Sashiko::Context
• Sashiko::Ractor
• Sashiko::Ractor::NonShareableReceiverError
• Sashiko::Ractor::Recorder
• Sashiko::Ractor::Recorder::Sink
• Sashiko::Rails
• Sashiko::Rails::TracedJob
• Sashiko::Rails::TracedJob::Serialization
• Sashiko::Traced

Methods

• ::async — Sashiko::Rails
• ::attach — Sashiko::Context
• ::bridge_notifications — Sashiko::Rails
• ::build_attributes — Sashiko::Traced
• ::carrier — Sashiko::Context
• ::current — Sashiko::Ractor::Recorder
• ::current — Sashiko::Context
• ::default_lib_path — Sashiko::Box
• ::drain_events! — Sashiko::Ractor::Recorder
• ::enabled? — Sashiko::Box
• ::fiber — Sashiko::Context
• ::included — Sashiko::Rails::TracedJob
• ::install — Sashiko::Ractor::Recorder
• ::install! — Sashiko::Rails
• ::install_overlay — Sashiko::Traced
• ::instrument! — Sashiko::Adapters::Anthropic
• ::instrument_in_box! — Sashiko::Adapters::Anthropic
• ::new — Sashiko::Adapters::Faraday::Middleware
• ::new — Sashiko::Box::NotEnabledError
• ::new — Sashiko::Ractor::Recorder
• ::new — Sashiko::Box
• ::overlay_for — Sashiko::Traced
• ::parallel_map — Sashiko::Ractor::Recorder
• ::parallel_map — Sashiko::Context
• ::pricing — Sashiko::Adapters::Anthropic
• ::record_response — Sashiko::Adapters::Anthropic
• ::replay — Sashiko::Ractor::Recorder::Sink
• ::set_cache_hit_ratio — Sashiko::Adapters::Anthropic
• ::set_cost — Sashiko::Adapters::Anthropic
• ::set_usage_attributes — Sashiko::Adapters::Anthropic
• ::span — Sashiko::Ractor::Recorder
• ::thread — Sashiko::Context
• ::tracer — Sashiko
• ::weave — Sashiko::Traced
• ::with — Sashiko::Context
• #call — Sashiko::Adapters::Faraday::Middleware
• #create — Sashiko::Adapters::Anthropic::Wrapper
• #deep_freeze — Sashiko::Ractor::Recorder
• #deserialize — Sashiko::Rails::TracedJob::Serialization
• #now_ns — Sashiko::Ractor::Recorder
• #serialize — Sashiko::Rails::TracedJob::Serialization
• #span — Sashiko::Ractor::Recorder
• #trace — Sashiko::Traced
• #trace_all — Sashiko::Traced