Skip to content

Maven Central

Installation

This document details how to download and install the Lucee agent. Before installing the agent, review the requirements below.

Requirements

The NerdVision Lucee agent requires:

  • Java 1.7+
  • Lucee 5.3.6+

Download

Download the latest Java agent from maven central

Check file name

The file name after the download will include the version number. Please ensure you rename the file to match that which is added to the JVM config.

Lucee ColdFusion (5.3.6)

To install NerdVision you need to add the javaagent argument to the Java options used by the Lucee server. To install please follow these steps:

  1. Navigate to the following directory: {Lucee-Home}/bin`
  2. Locate (or create) and then open the setenv.sh file with a text editor of your preference.
  3. Add the following to the file: 
    export JAVA_OPTS="${JAVA_OPTS} -javaagent:/full/path/to/nerdvision.jar=api.key=[API_KEY]"

  4. Replace the [API_KEY] (including the []) with your API key from accounts

  5. Save the changes made.

Tomcat configuration

Lucee uses Tomcat to run, for further information on configuring Tomcat see Apache Tomcat

Adobe ColdFusion (10+)

To install NerdVision you need to add the javaagent argument to the Java options used by the ColdFusion server. To install please follow these steps:

  1. Navigate to the following directory: {ColdFusion-Home}/cfusion/bin
  2. Locate and open the jvm.config file with a text editor of your preference.
  3. Add the NerdVision Java agent at the end of the line after "# Arguments to VM". Please make sure that all the Java Arguments are on the same line. 
    -javaagent:/full/path/to/nerdvision.jar=api.key=[API_KEY]
    Replace the [API_KEY] (including the []) with your API key from accounts
  4. Save the changes made.

Here is an example of a jvm.config: 

...
# Arguments to VM
java.args=-server -Xms256m -Xmx512m -XX:MaxPermSize=192m -Xbatch -Dcoldfusion.home={application.home} -Djava.awt.headless=true -Dcoldfusion.rootDir={application.home} -Djava.security.policy={application.home}/lib/coldfusion.policy -Djava.security.auth.policy={application.home}/lib/neo-jaas.policy -Dcoldfusion.classPath={application.home}/lib/updates,{application.home}/lib,{application.home}/lib/axis2,{application.home}/gateway/lib/,{application.home}/wwwroot/WEB-INF/cfform/jars,{application.home}/wwwroot/WEB-INF/flex/jars,{application.home}/lib/oosdk/lib,{application.home}/lib/oosdk/classes -Dcoldfusion.libPath={application.home}/lib -Dorg.apache.coyote.USE-CUSTOM-STATUS-MSG-IN-HEADER=true -javaagent:/full/path/to/nerdvision.jar=api.key=[API_KEY]

What's next?

After you install the agent, here are some suggestions for what to do next:

  • Login to NerdVision and create a workspace for your app.
  • Set a tracepoint on a line of real code (not comments) by clicking in the gutter.
  • Execute an action in the app that will cause the tracepoint to fire and a snapshot should arrive.
  • Look at the snapshot to see what live data from you app looks like.
  • Debug all your apps!

Need more help?