Ruby and Rails

​

Send errors with OpenTelemetry

gem "opentelemetry-sdk"
gem "opentelemetry-exporter-otlp"
gem "opentelemetry-instrumentation-all"

require "opentelemetry/sdk"
require "opentelemetry/exporter/otlp"
require "opentelemetry/instrumentation/all"

OpenTelemetry::SDK.configure do |c|
  c.use_all
end

require "opentelemetry/sdk"
require "opentelemetry/exporter/otlp"
require "opentelemetry/instrumentation/all"

OpenTelemetry::SDK.configure do |c|
  c.use_all
end

require_relative "app"
run App

export OTEL_SERVICE_NAME=checkout-api
export OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=production
export OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.squasher.ai
export OTEL_EXPORTER_OTLP_HEADERS="x-squasher-key=$SQUASHER_API_KEY"

​

How errors become issues

• An unhandled exception in a Sinatra request. The Rack instrumentation marks the request span as an error, with the exception class as the message, and records the exception. The issue title is, for example, RuntimeError.
• An error that you catch. Record it on a span and set the status yourself:
  OpenTelemetry.tracer_provider.tracer("checkout").in_span("charge-card") do |span|
    charge_card(order)
  rescue PaymentError => e
    span.record_exception(e)
    span.status = OpenTelemetry::Trace::Status.error(e.message)
  end
  
  The issue title is the error message. record_exception alone also makes an issue, titled with the exception message.

​

Use the Sentry SDK for Ruby

Sentry.init do |config|
  config.dsn = "https://#{ENV.fetch("SQUASHER_API_KEY")}@ingest.squasher.ai/1"
  config.environment = "production"
end

​

Send errors with the HTTP API

require "json"
require "net/http"

module Squasher
  URL = URI("https://ingest.squasher.ai/v1/ingest/#{ENV.fetch("SQUASHER_PROJECT_ID")}")

  def self.capture_exception(error, **extra)
    event = {
      message: error.message,
      type: error.class.name,
      stack: "#{error.class}: #{error.message}\n#{Array(error.backtrace).join("\n")}",
      level: "error",
      environment: ENV.fetch("RACK_ENV", "production"),
      extra: extra
    }
    Net::HTTP.post(URL, JSON.generate(event),
                   "Content-Type" => "application/json",
                   "x-squasher-key" => ENV.fetch("SQUASHER_API_KEY"))
  end
end

​

Send a test error

• OpenTelemetry: add a route that runs raise "Squasher test error", and open it once.
• HTTP API: run Squasher.capture_exception(RuntimeError.new("Squasher test error")).

​

Give the setup to a coding agent

Send this Ruby app's errors to Squasher with OpenTelemetry. There is no Squasher gem. Add
opentelemetry-sdk, opentelemetry-exporter-otlp, and opentelemetry-instrumentation-all, and call
OpenTelemetry::SDK.configure { |c| c.use_all } at boot (for Rails, in config/initializers). Set
OTEL_SERVICE_NAME, OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=production,
OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.squasher.ai, and
OTEL_EXPORTER_OTLP_HEADERS=x-squasher-key=<value of SQUASHER_API_KEY>. Verify with one route that raises
"Squasher test error".

​

Next steps

OpenTelemetry

See which OTLP data Squasher accepts.

Move from Sentry

Move an app from Sentry to Squasher.

HTTP API

See every field of the ingest endpoint.

Troubleshooting

Find out why an event does not appear.