Ruby - Middleware Docs

Traces	Metrics	App Logs	Custom Logs	Profiling
✅	✖️	✖️	✖️	✅

Traces

Metrics

App Logs

Custom Logs

Profiling

✅

✖️

✅

Ruby Version

Ruby version 3.0.0. Check your Ruby version with the following command:

Shell

ruby --version

Install

Step 1: Add Gems to Your Gemfile

Linux Gemfile
Windows Gemfile

Ruby

   gem 'opentelemetry-sdk'
   gem 'opentelemetry-exporter-otlp'
   gem 'opentelemetry-instrumentation-all'
   gem 'pyroscope'
   gem 'middleware_apm_linux', '~> 2.1.0'

Ruby

  gem 'opentelemetry-sdk'
  gem 'opentelemetry-exporter-otlp'
  gem 'opentelemetry-instrumentation-all'
  gem 'pyroscope'
  gem 'middleware_apm_windows', '~> 2.1.0'

Step 2: Import Tracker

Linux Environment
Windows Environment

Ruby

    require 'middleware/ruby_gem_linux'
    Middleware::RubyGem.init

Ruby

    require 'middleware/ruby_gem_windows'
    Middleware::RubyGem.init

Step 3: Capture Application Data

Traces

Shell

OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:9320 \ 
OTEL_SERVICE_NAME="<Your Service Name>" \ 
OTEL_RESOURCE_ATTRIBUTES=project.name="<Your Project Name>" \ 
MW_API_KEY=<Your API Key> \ 
<YOUR COMMAND> 

Profiling

Application Profiling is auto-configured upon completion of Step 2.

Continuous Profiling

Continuous profiling captures real-time performance insights from your application to enable rapid identification of resource allocation, bottlenecks, and more. Navigate to the Continuous Profiling section to learn more about using Continuous Profiling with the Ruby APM.

Need assistance or want to learn more about Middleware? Contact us at support[at]middleware.io.

​Prerequisites

​Install

​Step 1: Add Gems to Your Gemfile

​Step 2: Import Tracker

​Step 3: Capture Application Data

​Traces

​Profiling

​Continuous Profiling

Prerequisites

Install

Step 1: Add Gems to Your Gemfile

Step 2: Import Tracker

Step 3: Capture Application Data

Traces

Profiling

Continuous Profiling