Supported Ruby frameworks and libraries

Validated libraries and frameworks

The following libraries and frameworks are supported by Observe by Snowflake APM and work with all Observe by Snowflake APM features.

Cache Client

Library nameSupported versionsTrace ExplorerService CatalogService InspectorRED MetricsDeploymentsService MapsError & Exception Tracking
Redisredis < 5.0 or redis-client supported, including redis >= 5.0✅✅✅✅✅✅✅

Database Client

Library nameSupported versionsTrace ExplorerService CatalogService InspectorRED MetricsDatabase StatementsService Maps
mysql2 (MySQL)mysql2 0.5.7✅✅✅✅✅✅
pg (PostgreSQL)> 1.1.0✅✅✅✅✅✅

GraphQL

Library nameSupported versionsTrace ExplorerService CatalogService InspectorRED MetricsDeploymentsService MapsError & Exception Tracking
GraphQL Ruby>= 2.0.19 (default new tracer);
legacy_tracing supports != 2.0.18
✅✅✅✅✅✅✅

ORM

Library nameSupported versionsTrace ExplorerService CatalogService InspectorRED MetricsDatabase StatementsService Maps
ActiveRecord>= 7.0✅✅✅✅✅✅

Web / HTTP

Library nameSupported versionsTrace ExplorerService CatalogService InspectorRED MetricsDeploymentsService MapsError & Exception Tracking
Rack>= 2.0✅✅✅✅✅✅✅
Rails>= 7.0✅✅✅✅✅✅✅
Sinatra>= 2.0; validated with Sinatra 4.2.1✅✅✅✅✅✅✅

Other libraries and frameworks supported by OpenTelemetry

The libraries and frameworks in this section are supported by OpenTelemetry but are not certified for compatibility with Observe by Snowflake APM.

Cache Client

Library nameSupported versionsTrace Explorer
Dalli (Memcached) 2️⃣<= 4.1.0; built-in tracing from 4.2.0✅

Cloud SDK

Library nameSupported versionsTrace Explorer
AWS LambdaNot yet documented upstream✅
AWS SDK (aws-sdk-core)>= 2.0.0✅

Database Client

Library nameSupported versionsTrace Explorer
LMDBNot yet documented upstream✅
MongoDB (mongo gem) 2️⃣>= 2.5.0, <= 2.22.0; built-in tracing from 2.23.0✅
Net::LDAP 1️⃣>= 0.17.1✅
Trilogy (MySQL)>= 2.11.0, < 3.0.0✅

GenAI

Library nameSupported versionsTrace Explorer
AnthropicNot yet documented upstream✅
OpenAI 1️⃣>= 0.35.2✅

HTTP Client

Library nameSupported versionsTrace Explorer
EthonNot yet documented upstream✅
ExconNot yet documented upstream✅
Faraday>= 1.0.0✅
HTTP.rbNot yet documented upstream✅
HTTPClientNot yet documented upstream✅
HTTPX>= 1.7.4✅
Koala (Facebook)Not yet documented upstream✅
Net::HTTP (standard library)Not yet documented upstream✅
RestClientNot yet documented upstream✅

Messaging and Background Jobs

Library nameSupported versionsTrace Explorer
ActiveJob>= 7.1.0✅
Bunny (RabbitMQ)Not yet documented upstream✅
Delayed Job>= 4.1.0✅
Que>= 1.2.0✅
Racecar>= 2.7.0✅
rdkafka>= 0.18.0✅
ResqueNot yet documented upstream✅
ruby-kafka>= 0.7.0✅
Sidekiq>= 4.2.10✅

Rails Components

Library nameSupported versionsTrace Explorer
Action Mailer>= 7.1.0✅
Action Pack>= 7.1.0✅
Action View>= 7.1.0✅
Active Model Serializers>= 0.10.0✅
Active Storage>= 7.1.0✅
Active Support>= 7.1.0✅

Web / HTTP

Library nameSupported versionsTrace Explorer
Grape>= 1.2.0✅

Web / RPC

Library nameSupported versionsTrace Explorer
gRPCNot yet documented upstream✅
Gruf (gRPC)Not yet documented upstream✅

Other

Library nameSupported versionsTrace Explorer
Concurrent RubyNot yet documented upstream✅
Logger 1️⃣Not yet documented upstream✅
Rake>= 0.9.0✅

1️⃣ Not included in opentelemetry-instrumentation-all. Add its gem (opentelemetry-instrumentation-net_ldap, opentelemetry-instrumentation-openai, or opentelemetry-instrumentation-logger) and enable it with c.use.

2️⃣ Newer versions emit OpenTelemetry traces themselves, without the instrumentation gem. The mongo gem's built-in tracing is off by default; enable it in the driver configuration.

Check your application's libraries

☝️

Public preview feature

You may access and use this preview feature solely for internal evaluation purposes.  Previews are provided as-is. Your use of this preview is subject to the Snowflake Preview Terms located at https://www.snowflake.com/en/legal.


To check the gem versions your application uses against these lists, run observe instrumentation audit in your project. See Check OpenTelemetry readiness with the Observe by Snowflake CLI.


Did this page help you?