Instrument Ruby applications with OpenTelemetry

Add the gems of the instrumentations for the frameworks you use to your gemfile and run bundle install (see OpenTelemetry rubygems page)

rubycopydownload
gem 'opentelemetry-instrumentation-<USED_FRAMEWORK>' #TODO add your framework

To instrument manually, add the gem to the gemfile, run bundle install and add the code snippet below to any Ruby method you want to monitor.
Set names for the tracer, the span, and add attributes as you see fit.

rubycopydownload
gem 'opentelemetry-api'

rubycopydownload
tracer = OpenTelemetry.tracer_provider.tracer('manual')

span = tracer.start_span("my-span", kind: :internal) #TODO Replace with the name of your span
OpenTelemetry::Trace.with_span(span) do |span, context|
  span.set_attribute("my-key-1", "my-value-1") #TODO Add attributes
  # your original code goes here
end
rescue Exception => e
  span&.record_exception(e)
  span&.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{e.class}")
  raise e
ensure
  span&.finish

With OneAgent, you can simply point to a local endpoint without an authentication token to enable trace ingestion.

Additionally, make sure to set the following environment variable (without this, no spans will be exported):
OTEL_EXPORTER_OTLP_COMPRESSION=none

rubycopydownload
require 'opentelemetry/sdk'
require 'opentelemetry/exporter/otlp'

OpenTelemetry::SDK.configure do |c|
  c.service_name = 'ruby-quickstart' #TODO Replace with the name of your application
  c.service_version = '1.0.1' #TODO Replace with the version of your application
  c.use_all
  for name in ["dt_metadata_e617c525669e072eebe3d0f08212e8f2.properties", "/var/lib/dynatrace/enrichment/dt_metadata.properties"] do
    begin
      c.resource = OpenTelemetry::SDK::Resources::Resource.create(Hash[*File.read(name.start_with?("/var") ? name : File.read(name)).split(/[=\n]+/)])
    rescue
    end
  end
  c.add_span_processor(
    OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
      OpenTelemetry::Exporter::OTLP::Exporter.new(
        endpoint: 'http://localhost:14499/otlp/v1/traces'
      )
    )
  )
end

When using OneAgent, make sure to enable the public Extension Execution Controller in your Dynatrace Settings, otherwise no data will be sent.

In the Dynatrace menu, go to Settings > Preferences > Extension Execution Controller. The toggles Enable Extension Execution Controller and Enable local PIPE/HTTP metric and Log Ingest API should be active.

Without OneAgent, you need to set the endpoint to a specific URL containing your environment ID and configure an authentication token.

rubycopydownload
require 'opentelemetry/sdk'
require 'opentelemetry/exporter/otlp'

OpenTelemetry::SDK.configure do |c|
  c.service_name = 'ruby-quickstart' #TODO Replace with the name of your application
  c.service_version = '1.0.1' #TODO Replace with the version of your application
  c.use_all
  for name in ["dt_metadata_e617c525669e072eebe3d0f08212e8f2.properties", "/var/lib/dynatrace/enrichment/dt_metadata.properties"] do
    begin
      c.resource = OpenTelemetry::SDK::Resources::Resource.create(Hash[*File.read(name.start_with?("/var") ? name : File.read(name)).split(/[=\n]+/)])
    rescue
    end
  end
  c.add_span_processor(
    OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
      OpenTelemetry::Exporter::OTLP::Exporter.new(
        endpoint: '<URL>',  #TODO Replace <URL> to your SaaS/Managed-URL as mentioned in the next step
        headers: {
          "Authorization": "Api-Token <TOKEN>" #TODO Replace <TOKEN> with your API Token as mentioned in the next step
        }
      )
    )
  )
end

Lastly, you need to define the correct endpoint and token, to make sure your data arrives where it should be.

• To set the endpoint:
  1. Use your Environment ID to set the endpoint to which your app will send traces as follows:
     • Dynatrace SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/otlp/v1/traces
     • Dynatrace Managed https://{your-domain}/e/{your-environment-id}/api/v2/otlp/v1/traces
     • Dynatrace ActiveGate https://{your-activegate-endpoint}/e/{your-environment-id}/api/v2/otlp/v1/traces
       • You may need to include the port to your ActiveGate endpoint. For example:
         • https://{your-activegate-endpoint}:9999/e/{your-environment-id}/api/v2/otlp/v1/traces
       • If you are running a containerized ActiveGate, you need to use the FQDN of it. For example:
         • https://{your-activegate-service-name}.dynatrace.svc.cluster.local/e/{your-environment-id}/api/v2/otlp/v1/traces
  2. Replace <URL> in the code snippet above with your endpoint.
• To create an authentication token
  1. In the Dynatrace menu, go to Access tokens and select Generate new token.
  2. Provide a Token name.
  3. In the Search scopes box, search for Ingest OpenTelemetry traces and select the checkbox.
  4. Select Generate token.
  5. Select Copy to copy the token to your clipboard.
  6. Save the token in a safe place; you can't display it again.
  7. Replace <TOKEN> in the code snippet above with your token.