JavaエージェントAPIを用いたブラウザモニタリングの構築

ブラウザモニタリングでは、JavaScript スニペット（または"エージェント" ）を使用してアプリのウェブページを計測することで、ユーザーが Java アプリケーションをどのように操作しているかを可視化することができます。UIを介してブラウザエージェントをインストールするには、ブラウザエージェントのインストールの手順に従ってください。例えば、以下のようになります。

APM監視対象のアプリを有効にします。
コピー/ペースト方式で有効にする。
REST APIを使用して有効にする。

また、このドキュメントで説明されているように、JavaエージェントAPIを使用してウェブページを手動でインストルメントすることもできます。

JavaエージェントAPIの使用

お使いのフレームワークで、当社のUI、コピー／ペースト方法、またはREST APIを使用してブラウザ監視を有効にできない場合は、ウェブページの監視を手動で行うことができます。これを行うには、当社の Java エージェント API を使用してください。

最新のJavaエージェントのバージョンを使用していることを確認してください。
オートインストルメントを無効にします。
newrelic.ymlで browser_monitoring の下の auto_instrument フラグを false に設定します。
browser_monitoring: auto_instrument: false
アプリケーションを再起動します。
アプリサーバーのワークキャッシュをフラッシュします。
ワークキャッシュをフラッシュすると、アプリサーバーはJSPの再コンパイルを余儀なくされますが、この時に自動計測が行われます。
browser_monitoring スタンザの下で disabled_auto_pages フラグを使用します。たとえば、 testpage_1.jsp および testpage_2.jspで自動計測を無効にするには、次を使用します。
browser_monitoring: disabled_auto_pages: /WEB-INF/jsp/testpage_1.jsp, /WEB-INF/jsp/testpage_2.jsp
アプリケーションクラスパスにnewrelic-api.jarを追加して、Java エージェント API クラスにアクセスします。
時間追跡を開始するための適切なメソッドを追加します (例: com.newrelic.api.agent.NewRelic.getBrowserTimingHeader() 。
時間追跡を停止するための適切なメソッドを追加します (例: com.newrelic.api.agent.NewRelic.getBrowserTimingFooter() 。
使用しているフレームワークに応じて、適切な方法を見つけてください。
ヘッダーは<head>タグのできるだけ先頭に挿入しますが、メタタグの後に挿入します。</body>タグの前にフッターを挿入します。
<!DOCTYPE html> <html> <head> <title>EXAMPLE</title> <meta charset="utf-8" /> <meta name="description" content="Example header and footer call" /> ; <%= com.newrelic.api.agent.NewRelic.getBrowserTimingHeader() %> </head> <body> <%= com.newrelic.api.agent.NewRelic.getBrowserTimingFooter() %> </body> </html>
<head> ... <div th:remove="tag" th:utext="${T(com.newrelic.api.agent.NewRelic).getBrowserTimingHeader()}" ></div> </head> <body> ... <div th:utext="${T(com.newrelic.api.agent.NewRelic).getBrowserTimingFooter()}" ></div> </body>
<cfobject type="Java" class="com.newrelic.api.agent.NewRelic" name="newRelic" /> <cfset header="newRelic.getBrowserTimingHeader()" /> <cfoutput>#header#</cfoutput> ... ... <cfset footer="newRelic.getBrowserTimingFooter()" /> <cfoutput>#footer#</cfoutput>
${com.newrelic.api.agent.NewRelic.getBrowserTimingHeader().raw()} ... ... ${com.newrelic.api.agent.NewRelic.getBrowserTimingFooter().raw()}
以下をbuild.sbtに追加して、3.xx を最新のエージェントバージョンに置き換えます。
libraryDependencies += "com.newrelic.agent.java" % "newrelic-api" % "3.x.x"
main.scala.htmlに、次を追加します。
@Html(com.newrelic.api.agent.NewRelic.getBrowserTimingHeader()) ... ... @Html(com.newrelic.api.agent.NewRelic.getBrowserTimingFooter())
2.xx を最新のエージェントバージョンに置き換えて、次をBuild.scalaに追加します。
appDependencies += "com.newrelic.agent.java" % "newrelic-api" % "2.x.x"
main.scala.htmlに、次を追加します。
@Html(com.newrelic.api.agent.NewRelic.getBrowserTimingHeader()) ... ... @Html(com.newrelic.api.agent.NewRelic.getBrowserTimingFooter())
Velocity Tools を使用している場合は、 toolbox.xmlでNewRelicツールを定義します:
<toolbox> <tool> <key>NewRelic</key> <scope>application</scope> <class>com.newrelic.api.agent.NewRelic</class> </tool> </toolbox>
ベロシティテンプレートでNewRelic API を呼び出します。
$NewRelic.getBrowserTimingHeader() ... ... $NewRelic.getBrowserTimingFooter()
すべてのブラウザページビューが 1 つの /velocity トランザクションの下にグループ化されないようにする (および指標のグループ化の問題を回避する) には、 newrelic.yml ファイルで enable_auto_transaction_naming 設定を無効にします。
enable_auto_transaction_naming: false
newrelic-api.jarを Tomcat のクラスパス (通常は.../tomcat/bin/setenv.sh ) に追加します。
bash
$CLASSPATH=$CLASSPATH:/opt/newrelic/newrelic-api.jar
また
この jar ファイルへの参照を、そのファイル内の既存のCLASSPATH=...行の末尾に追加します。
各アプリでWEB-INF/tools.xmlを見つけて、次のタグを追加します。
<toolbox scope="application"> <tool class="com.newrelic.api.agent.NewRelic" key="NewRelic" /> </toolbox>
<toolbox scope="application">タグが既に存在する場合は、タグ内に<tool ... />を挿入します。
各アプリで、アプリケーションの他のページが使用する Velocity テンプレートを編集します。<head>スタンザ内で、 <link>および<script>宣言の前、メタタグの後に次のタグを追加します。
$NewRelic.getBrowserTimingHeader()
<body>スタンザ内の</body>タグの直前の行として、本文の一番下に次のタグを追加します。
$NewRelic.getBrowserTimingFooter()
Tomcatサーバを再起動する。
Linux/Unixを使用している場合は、次のコマンドラインをUsers/Tomcat/binディレクトリに追加します。
./shutdown.sh ./startup.sh
Windowsを使用している場合は、 Users/Tomcat/binディレクトリに移動し、次のコマンドラインを追加します。
% shutdown.bat % startup.bat

ログファイルを調べて、エージェントが正しく計測されていることを確認します。newrelic.ymlのlog_level設定をlog_level: finerに設定し、次のメッセージを確認します:

May 17, 2011 9:33:18 AM NewRelic FINE: Compiling JSP: /jsp/header.jsp
May 17, 2011 9:33:18 AM NewRelic FINE: Injecting browser timing header into: /jsp/header.jsp

May 17, 2011 9:33:36 AM NewRelic FINE: Compiling JSP: /jsp/footer.jsp
May 17, 2011 9:33:36 AM NewRelic FINE: Injecting browser timing footer into: /jsp/footer.jsp

JavaScriptのスニペットは、エージェントがサーバーに接続するまでHTMLレスポンスに挿入されません。

May 17, 2011 9:43:21 AM NewRelic INFO: Real user monitoring is enabled with auto instrumentation

May 17, 2011 9:43:23 AM NewRelic FINER: Injecting browser timing header in a JSP.  Content type is text/html
May 17, 2011 9:43:23 AM NewRelic FINER: Injecting browser timing footer in a JSP.  Content type is text/html

May 17, 2011 9:43:23 AM NewRelic FINEST: Got browser timing header in NewRelic API: <script>var    NREUMQ=[];NREUMQ.push(["mark","firstbyte",new Date().getTime()]);(function(){var d=document;var e=d.createElement("script");e.type="text/javascript";e.async=true;e.src="https://d7p9czrvs14ne.cloudfront.net/11/eum/rum.js";var s=d.getElementsByTagName("script")[0];s.parentNode.insertBefore(e,s);})();</script>

May 17, 2011 9:43:23 AM NewRelic FINEST: Got browser timing footer in NewRelic API: <script type="text/javascript" charset="utf-8">NREUMQ.push(["nrf2","staging-beacon-1.newrelic.com","8512b4d93f",7449,"M1RTYksFDEYDUxdcDgoeZERQSwhGEmQGRhVL",0,413])</script>

この機械翻訳は参考用に提供されます。

JavaエージェントAPIを用いたブラウザモニタリングの構築

JavaエージェントAPIの使用

すべてのページでオートインストルメントを無効にする

特定のページでのみオートインストルメントを無効にする

JSP マニュアルインストルメント

Raw HTMLのマニュアルインストルメント

Thymeleaf 2.1以上のマニュアルインストルメント

ColdFusion CFMLページの手動インストルメント

Java Server Faces（JSF）フレームワーク

Play Groovyテンプレート・マニュアル・インストゥルメンテーション

Play 2.2以上 Scalaテンプレート・マニュアル・インストゥルメンテーション

Play 2.1 Scalaテンプレート・マニュアル・インストゥルメンテーション

Apache Velocity Toolsのマニュアルインストルメント

Apache Velocityのマニュアルインストルメント

JSPエンジンは、JSPをコンパイルする際に

エージェントがサーバーに接続した後

New Relic が JSP を起動すると

エージェントがヘッダーとフッターのAPIを呼び出すと