アプリケーションの自動ネーミング

アプリケーションに付けた名前は、New Relic のパフォーマンス指標を整理するのに役立ちます。

New Relic の Java エージェントは、単一の JVM 内のすべてのトランザクションとその他のメトリクスを、設定app_nameのnewrelic.ymlで指定されたアプリケーション名にレポートします (アプリケーションの名前付けの詳細については、 「Java アプリケーションに名前を付ける」を参照してください)。newrelic.ymlのenable_auto_app_namingをtrueに変更すると、アプリケーションにはコンテキスト、フィルター、サーブレット、またはリクエスト属性に応じた名前が付けられます。

この設定により、トランザクション、エラー、メトリクスを New Relic ユーザー インターフェースの他の適切なアプリケーションにレポートしながら、単一の JVM で複数の Web アプリケーションを実行できます。バックグラウンド タスクでは、引き続きnewrelic.ymlのデフォルトのアプリケーション名が使用されます。

アプリケーション名のソース

enable_auto_app_namingをtrueに設定すると、New Relic は次の情報ソースを使用してアプリケーションに名前を付けます。

リクエスト属性

APPLICATION_NAMEリクエスト属性は、XML 内のどの設定よりも優先されます。この属性は、Web トランザクションのできるだけ早い段階で設定します。複数回呼び出された場合、最後の呼び出しによってアプリケーション名が決定されます。

request属性を使用して、リクエストURIに基づいたきめ細かなアプリケーションの命名を行うこと。

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
  ...
  String requestUri = httpServletRequest.getRequestURI();

  if (requestUri.startsWith("/my-special-request/")) {
      request.setAttribute("com.newrelic.agent.APPLICATION_NAME", "MySpecialWebApp");
  }
  ...

サーブレットの初期化パラメーター

init parametersを使用してweb.xml内の個々のサーブレットのアプリケーション名を設定するには:

<servlet>
  <servlet-name>SqlServlet</servlet-name>
  <servlet-class>test.SqlServlet</servlet-class>
  <init-param>
    <param-name>com.newrelic.agent.APPLICATION_NAME</param-name>
    <param-value>MyServletApp</param-value>
  </init-param>
</servlet>

エージェントは、呼び出してinit-paramの値を取得します。

javax.servlet.ServletConfig#getInitParameter(String)

引数com.newrelic.agent.APPLICATION_NAMEを使用します。

Web リクエストが複数のサーブレットを呼び出す場合、最初に終了したサーブレットのinit-paramが優先されます。init-paramのないサーブレットは、Web アプリのデフォルトのアプリケーション名を使用します。

アプリケーション名を XML で宣言するだけでなく、 javax.servlet.ServletRequestに属性を保存してアプリケーション コードで設定することもできます。

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
  ...
  request.setAttribute("com.newrelic.agent.APPLICATION_NAME", "MyWebApp");
  ...

フィルターの初期化パラメーター

Webアプリにサーブレットがない場合は、フィルタのinitパラメータを使うことができます。

<filter>
  <filter-name>SqlFilter</filter-name>
  <filter-class>test.SqlFilter</filter-class>
  <init-param>
    <param-name>com.newrelic.agent.APPLICATION_NAME</param-name>
    <param-value>MyFilterApp</param-value>
  </init-param>
</filter>

エージェントは、引数com.newrelic.agent.APPLICATION_NAMEを指定してjavax.servlet.FilterConfig#getInitParameter(String)を呼び出すことで、 init-paramの値を取得します。アプリケーションの命名に関してはサーブレットがフィルターよりも優先されるため、フィルターの init パラメーターはサーブレットが呼び出されなかった場合にのみ使用されます。最初に終了するフィルタのinit-paramが優先されます。

コンテキストパラメータ

コンテキストパラメーターを使ってアプリケーション名を設定するには

<context-param>
  <param-name>com.newrelic.agent.APPLICATION_NAME</param-name>
  <param-value>MyWebApp</param-value>
</context-param>

エージェントは、引数com.newrelic.agent.APPLICATION_NAMEを指定してjavax.servlet.ServletContext#getInitParameter(String)を呼び出すことでコンテキスト パラメータの値を取得します。context パラメータは、 display-name要素よりも優先されます。

表示名

web.xmlのdisplay-name要素を使用してアプリケーション名を決定するには:

<display-name>MyWebApp</display-name>

エージェントは、 javax.servlet.ServletContext#getServletContextName()を呼び出してdisplay-name要素の値を取得します。

コンテクストパス

display-name要素がなく、アプリ名の設定に他の上位階層メソッドが使用されていない場合、アプリケーション名は Web アプリのコンテキスト パスから取得されます。エージェントは、 javax.servlet.ServletContext#getContextPath()を呼び出してコンテキスト パスを取得します。

コンテキストパスは、リクエストのコンテキストを選択するために使用されるリクエストURIの部分です。コンテキストパスは、リクエストURIの中で常に最初に置かれます。例えば、以下のようになります。

次のようなURLを考えてみましょう。

http://example.com/newrelic-axis2-ws/getWeather

このURLに

• リクエスト URI は/newrelic-axis2-ws/getWeatherです。
• コンテキスト パスは/newrelic-axis2-wsです。
• アプリケーションの名前はnewrelic-axis2-wsです。