Splunk Observability Cloud 用に Ruby アプリケーションを手動でインストルメンテーションする

スパンにカスタム属性を追加する必要がある場合、またはスパンを手動で生成する場合は、Ruby アプリケーションを手動でインストルメンテーションしてください。

Splunk Distribution of OpenTelemetry Ruby のエージェントを使ってアプリケーションを自動的にインストルメンテーションすれば、ほとんどのニーズに対応できます。アプリケーションを手動でインストルメンテーションする必要があるのは、たとえば、スパンにカスタム属性を追加する必要があるときや、スパンを手動で生成する必要があるときだけです。

ライブラリの設置

手動インストルメンテーションでは、インストルメンテーション ライブラリを個別にインストールして有効にすることができます。これにより、プロジェクトのビルド時に Ruby が取得する gem を制御できます。

Ruby アプリケーションを手動でインストルメンテーションする方法については、OpenTelemetry.io の https://opentelemetry.io/docs/instrumentation/ruby/manual/ を参照してください。

インストルメンテーション・ライブラリを手動でインストールし、アクティブ化します：

  1. gem install を使用するか、プロジェクトの Gemfile に含めて、インストルメンテーション ライブラリをインストールします。たとえば、Sinatra インストルメンテーションをインストールするには、Gemfile に次のように追加します。

    gem "opentelemetry-instrumentation-sinatra", "~> 0.21"

  2. Splunk::Otel.configure メソッドに渡されるブロックで、ソフトウェア開発キット（SDK）がそれぞれのインストルメンテーション ライブラリを使用するように設定します。Sinatra インストルメンテーションの場合、ブロックは次の例のようになります。

    require "splunk/otel"
Splunk::Otel.configure do |c|
c.use "OpenTelemetry::Instrumentation::Sinatra", { opt: "value" }
end

すべてのインストルメンテーション ライブラリのインストール

すべてのインストルメンテーションライブラリをインストールするには、以下の手順に従ってください：

  1. OpenTelemetry インストルメンテーションライブラリをインストールします：

    bundle add opentelemetry-sdk opentelemetry-instrumentation-all

  2. OpenTelemetry::sdk.configure メソッドに渡されるブロックで、SDK がすべてのインストルメンテーションライブラリを使用するように設定します:

    require "opentelemetry/sdk"
require "opentelemetry/instrumentation/all"
OpenTelemetry::SDK.configure do |c|
   c.use_all()
end

Railsアプリケーションをインストルメンテーションする

Ruby on Railsアプリケーションをインストルメンテーションするには、以下の手順に従ってください：

  1. インストルメンテーション ライブラリをプロジェクトの Gemfile に追加します。

    gem "opentelemetry-instrumentation-rails", "~> 0.27"

    bundle を使って gem をインストールすることもできます：

    bundle add opentelemetry-instrumentation-rails --version "~> 0.27"

  2. OpenTelemetry が利用可能なすべてのインストルメンテーション・ライブラリを使用するように設定します：

    # config/initializers/opentelemetry.rb
require "splunk/otel"
...
Splunk::Otel.configure do |c|
c.use_all()
end

    use_all 関数を使うと、特定のインストルメンテーションを無効にすることができます。例：

    Splunk::Otel.configure do |c|
c.use_all({ 'OpenTelemetry::Instrumentation::ActiveRecord' => { enabled: false } })
end

  3. Railsだけをアクティブにするには、単一の c.use ステートメントを使用できます：

    Splunk::Otel.configure do |c|
c.use 'OpenTelemetry::Instrumentation::Rails'
end

例については、「Rails 7 の例」を参照してください。

スパンとイベントの手動インストルメンテーション

Rubyの手動インストルメンテーションの例については、OpenTelemetryの公式ドキュメントを参照してください。

注: 手動 OTel インストルメンテーションは、Splunk の自動 Ruby インストルメンテーションと完全に互換性があり、Splunk によって完全にサポートされています。