9.2 トレース機能のセットアップ方法
本製品をインストールしたあと,トレース機能を有効にするために次の手順でセットアップをしてください。
-
Serverタグの子要素に設定を追記する。
${CATALINA_BASE}/conf/server.xml(Tomcatのサーバ設定ファイル)に記載されているServerタグの子要素に,次の内容を追記してください。Serverタグの子要素のほかのタグよりも前に記載することを推奨します。
<Listener className="com.cosminexus.appruntime.tomcat.tracer.ServerComponentHandler" />
-
Engineタグの子要素に設定を追記する。
${CATALINA_BASE}/conf/server.xml(Tomcatのサーバ設定ファイル)に記載されているEngineタグの子要素に,次の内容を追記してください。Engineタグの子要素のほかのタグよりも前に記載することを推奨します。
<Valve className="com.cosminexus.appruntime.tomcat.tracer.RequestTraceValve" />
-
ResourceタグのjdbcInterceptors属性に設定を追記する。
次のファイルに記載されているResourceタグのjdbcInterceptors属性にcom.cosminexus.appruntime.tomcat.tracer.JdbcTraceHandlerを追記してください。ただし,Resourceタグのfactory属性がorg.apache.tomcat.jdbc.pool.DataSourceFactoryの場合に限ります。
-
${CATALINA_BASE}/conf/server.xml(Tomcatのサーバ設定ファイル)
-
${CATALINA_BASE}/conf/context.xml(Tomcatのコンテキスト設定ファイル)
なお,設定を追記しない場合は,Tomcat JDBC Connection Poolのトレースを取得できません。
設定を追記する例を次に示します。太字が追記する個所です。
<Resource ・・・省略・・・ factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" ・・・省略・・・ jdbcInterceptors="com.cosminexus.appruntime.tomcat.tracer.JdbcTraceHandler" ・・・省略・・・ />
-
-
Contextタグの子要素に設定を追記する。
${CATALINA_BASE}/conf/context.xml(Tomcatのコンテキスト設定ファイル)に記載されているContextタグの子要素に,次の内容を追記してください。Contextタグの子要素のほかタグとの記載順序は問いません。
<Loader loaderClass="com.cosminexus.appruntime.tomcat.tracer.WebappTraceClassLoader" />
-
Eclipse Jersey以外のJAX-RSクライアントを使用する場合,ユーザプログラムを変更する。
Eclipse Jersey以外のJAX-RSクライアントを使用する場合は,ユーザプログラム中のClientオブジェクトにJaxrsClientTraceFeatureを登録する必要があります。登録しない場合,JAX-RSクライアントのトレースを取得できません。登録する例を次に示します。
import javax.ws.rs.client.Client; import com.cosminexus.appruntime.common.tracer.JaxrsClientTraceFeature; Client client = <Clientオブジェクトの取得>; client.register(JaxrsClientTraceFeature.class); // JaxrsClientTraceFeatureの登録
なお,Eclipse Jersey 2.x系を使用する場合は,ユーザプログラムの変更は不要です。この手順を実施する必要はありません。
-
必要に応じてconfig.properties(本製品の設定ファイル)のプロパティを設定する。
config.properties(本製品の設定ファイル)については,「12.2 config.properties(本製品の設定ファイル)」を参照してください。