Skip to main content

Overview

Motadata APM supports Ruby trace ingestion using custom agent. Ruby applications must run on a supported runtime (CRuby MRI ≥ 3.2 recommended), and trace ingestion is agent-based with runtime instrumentation via the motadata-apm gem.

info

Make sure it is supported by Linux Host/ VM agents only.

Go to Menu > Settings > APM > Application Registration. Clicking the Application Registration button, you can register a new application. From the application registration screen, select the instrumentation type Host/VM.

Ruby Trace Configuration

FieldDescription
Select AgentSelect the Host/VM where this application is running. You can configure Ruby application service for Linux type agent.
LanguageSelect Ruby from the language icons.
Business ServiceThe Business Service represents a logical grouping of related microservices under a single business application (e.g., order-management).
Service NameProvide a unique and meaningful name (e.g., order_service).
Service Attributes (Tags)Add key–value tags to your application for better filtering and organizing data in Explorer. Attribute key names must be lowercase (for example, apm.env = prod). To add multiple Key-Value pairs, click the add icon.
Add Custom ParametersAllows you to define custom sampling or tagging parameters for advanced use cases. These optional parameters are passed to the agent (for example, version=4).

Clicking the Apply Configuration button, the ingestion gets started. The screen displays the Setup Command to instrument your Ruby application.

You can configure trace ingestion according to the framework used to build the application. The following are the supported frameworks.

Supported Frameworks

FrameworkVersion
Ruby on Rails7.1+
Action Pack7.1+
Action View7.1+
Action Mailer7.1+
Active Storage7.1+
Active Support7.1+
Sinatra1.4+
Rack0.1+
Grape1.2+
GraphQL (graphql)2.0+
Active Model Serializers0.10+

Supported Database

Database / ORMVersion
Active Record7.1+
PostgreSQL (pg)1.0+
MySQL (mysql2)0.5+
MongoDB (mongo)2.5+
Trilogy2.0+
LMDB0.2+

Supported Queue

Queue / SystemVersion
Sidekiq6.0+
Active Job7.1+
Delayed Job4.1+
Resque2.0+
Que1.0+
Rake12.3+
Bunny (RabbitMQ)2.0+
rdkafka0.12+
ruby-kafka0.7+
Racecar0.3+

Supported Others

Library / SystemVersion
Net::HTTPRuby stdlib
Faraday1.0+
HTTP.rb4.0+
HTTPX0.20+
HTTPClient2.8+
Excon0.56+
Ethon0.12+
RestClient2.0+
Redis4.0+
Dalli (Memcached)3.0+
gRPC (grpc)1.10+
Gruf2.10+
AWS SDK3.0+
AWS Lambda1.0+
Anthropic0.1+
Koala3.0+
Concurrent Ruby1.1+

Once the application is running, you need to verify the below points:

  • Confirm that the service has been registered successfully.
  • On the service registration screen, the Service Trace Collection Status should display "Running."
  • The traces will start appearing in the APM Explorer screen.