Ruby エージェントのインストール

New Relic Ruby エージェントをインストールすると、アプリケーションのパフォーマンスのモニタリングや Ruby アプリに関する深い情報まで見ることができるようになります。

目次

New Relic Ruby エージェントのインストール動画

この動画では、Ruby エージェントをあなたのプロジェクトへインストールする方法、New Relic 使うための Ruby アプリケーションの設定方法、エージェントがレポートしているかのチェック、加えてよくあるトラブルへの対策について解説しています。


Ruby エージェンtののインストールに関する動画 (約 6 分) さらにチュートリアルを見たい方は、learn.newrelic.com をチェックしてください。

gem のインストール

New RelicのRuby エージェントgem(newrelic_rpm)は rubygems.org [external link] から利用できます。Bundlerを使っている場合は、以下を Gemfile に追加してください。

gem 'newrelic_rpm'

Rails 3以上もしくは、推奨設定で Rails 2.3 を使用している場合、Rails はアプリケーション起動時に自動的に Bundler.requireを呼び出すため、newrelic_rpm が必須となります。Sinatra もしく別のフレームワークを使っている場合は、手動でrequire 'newrelic_rpm'またはBundler.require を呼び出す必要があります。

注: Sinatra、Rails 以外の Rack アプリケーションを使って、自動的にブラウザアプリケーションのモニタリングやクロスアプリケーションのトレースを行うためには、エージェンが提供している追加のミドルウェアを手動で設定する必要があります。Rack ミドルウェア [英語]をご覧ください。New Relic gem はできるだけリストの下に記述してください。そうすることで、gem を初期化する際に、その上にあるフレームワークを計測できるからです。

設定ファイル

エージェントのインストールが完了後、以下の作業を行います。

  1. newrelic.yml ファイルをあなたのアプリケーションの config ディレクトリにコピーする
  2. アプリケーション名を意味のある名前に変更する

rpm.newrelic.com にログイン済みの場合は、Account settings [アカウント設定]から、あなたのライセンスキー入のデフォルトの newrelic.yml をダウンロードできます。

エージェントの更新

Bundler を使っている場合は、bundle update newrelic_rpm を実行するだけです。それ以外の場合は、gem update newrelic_rpmを実行します。

本番環境以外へのインストール

一般的にエージェントは本番環境にインストールされます。開発環境やローカル環境でエージェントを試す場合は、newrelic.yml ファイルの environment: ブロックを確認し、monitor_mode の設定値を true にセットします。

例えば、開発環境に New Relic をデプロイした場合でも、アプリケーションのパフォーマンスメトリクスを表示できるようにするには、development:ブロックにある monitor_mode の値を true にセットしてください。本番環境以外でエージェントを使うことに関する詳しい内容は、開発モードをご覧ください。

Ruby用エージェント gem のアンインストール

Bundler を使っている場合は Gemfile からgem 'newrelic_rpm' を削除するだけです。Bundler を使っていない場合は、environment.rbファイルから、newrelic_rpmに関するすべての参照を削除してください。

古いバージョンの Rails へのインストール

Bundler を使っていない Rails 2.x の環境に Ruby エージェントをインストールするには、次の手順に従ってください。

Bundler なしの場合: Rails 2.1 – 2.3

  1. gem install newrelic_rpm を実行して、gem をインストールする。
  2. environment.rb を編集し、initializer ブロックに config.gem "newrelic_rpm" を追加する。

Rails 2.1 以前

New Relic は、2.1以前の Rails のバージョンを公式にはサポートしていません。しかし、バージョン 2.0.* の Rails で、New Relic を使いたい場合は、environment.rb を編集し、以下の文を initializer: ブロッックの後に追加してください。

require "newrelic_rpm"

関連情報

関連情報は以下のとおりです。

  • Ruby エージェントの設定[英語](一般的な設定, プロキシ、トランザクション、トランザクショントレース、エラー収集、更新について)
  • Ruby における New Relic(互換性、要件、インストール、設定、トラブルシューティング、既知の問題、アドバンス機能や、ベータリリースについての概要)
  • 非推奨のRuby エージェントの更新 [英語](New Relic のサポート対象外となった Ruby エージェントのバージョンについて、お使いのアプリにおけるバージョンの検証方法、最新バージョンを維持するための方法について)