Java Server Faces (JSF) plugin for Spring Insight
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

JSF plugin for Spring Insight

Spring Insight runs in the VMware vFabric tc Server. See for details. This plugin adds instrumentation for web applications that use Java Server Faces (JSF) for their web framework. See ( for details.

What does it do?

It provides instrumentation for the following aspects of the JSF web framework:

  • All lifecyle phase executions
  • Actions
  • Validator operations
  • Action Listeners
  • Phase Listeners


This plugin is compatible with:

  • JSF 2.x Mojarra and Apache MyFaces implementations
  • Spring Insight 1.5+

Installing the plugin

Download the latest release from


get and build the code from: git clone

cd spring-insight-jsf-plugin/collection-plugin
mvn clean package

You'll need to have vFabric tc Server Developer Edition installed. Let's call the location of that tcServer.

Now copy the plugin jar to the right place under tcServer.

cp insight-plugin-jsf-x.x.x.RELEASE.jar tcServer/spring-insight-instance/insight/collection-plugins

If your version of vFabric tc server uses version 1.8.3 or lower of the insight-collection jar then there are additional install steps. vFabric tc server 2.7.1 and lower will have this version of the jar. See here for more details

Running the plugin

  • Start up vFabric tc Server as usual (see the vFabric tc Server Developer Edition documentation) and make sure your WAR file is deployed. Start your application and make sure it's running.
  • Browse to http://localhost:8080/insight to see the Spring Insight dashboard. Click on the 'Administration' button and then 'Collection Plug-ins' under 'Reports and Statistics'.
  • If you can see the JSF plugin it's installed and running.
  • Run through your application in a way you're sure exercises JSF. Then go back to the Spring Insight dashboard to see the traces.

Testing the plugin

There is a sample web app that can be used to test the plugin. See here for details