FusionReactor is a popular tool for monitoring performance and gathering metrics for ColdFusion and Java J2EE applications. You may wish to use FusionReactor with the servers you start up via CommandBox. We've created a CommandBox module that will add FusionReactor support to your CommandBox servers which you can view here on ForgeBox.
The CommandBox FusionReactor module is a separate project that you can optionally install by typing this:
That's it-- now every server you start with the
startcommand will automatically have the JVM args added to it to load up FusionReactor.
There's nothing special you have to do in order for FusionReactor to load. A random port will be chosen for FusionReactor to use so you can have more than one server running at a time and each of them will have their own FusionReactor instance running. When you start a server, you should see some output similar to this:
* CommandBox FusionReactor Module Loaded *
FusionReactor will be available at the URL http://127.0.0.1:2871
To open FusionReactor in your browser, you can run the following command:
If you right click on the tray icon for this server, you'll see there is a new menu item at the bottom called
Open Fusion Reactorthat will do the same thing.
FusionReactor is a commercial product and requires a license to use. If your company has a license for you to use on your PC, then you can register your CommandBox FusionReactor license with this command:
fr register "myLicenseKey"
By default, the license key will always be displayed on the home page after login. You can turn off the display of the key on a per-server basis or at a global level for all servers.
# Server specific
server set fusionreactor.hideLicenseKey=true
# global default
config set server.defaults.fusionreactor.hideLicenseKey=true
By default, the module always picks a random port to start FusionReactor on. You can also set your FusionReactor port on a per-server basis, or at a global level for all servers (if using the fancy host updater module which prevents port conflicts by binding each site to its own IP). The default behavior will still be to pick a random port if you don't specify one.
# Server specific port
server set fusionreactor.port=8088
# global default port
config set server.defaults.fusionreactor.port=8088
By default, the module will bind FR's port to the same host as your CommandBox web server. You can ask FR to bind to a separate host/IP on a per server basis, or a global basis.
# Server specific host
server set fusionreactor.host=0.0.0.0
# global default hsot
config set server.defaults.fusionreactor.host=0.0.0.0
You may want to turn the FusionReactor functionality on or off based on your testing or for specific sites. There is now an enable flag for just that. It can be set per server and for all servers as well.
server set fusionreactor.enable=false
config set server.defaults.fusionreactor.enable=false
You can set a license key per server if you wish like so:
server set fusionreactor.licenseKey=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
The module is regularly updated to use the latest version of FusionReactor. Note however that your license key may not be for the latest FR version. When the internal default version of FR is updated for a major release, the version of the actual FR module will also have a "major" version increment. This is so you can always run
upgrade --systemand you won't have to worry about suddenly getting a major FR upgrade one day that doesn't work with your license key.
If you want to upgrade your CommandBox FusionReactor module to a new major release, just re-run the installation command.
If you have an older FR license you want to use, you can specify the version of FR you'd like like so:
installIDsetting can be any valid CommandBox endpoint installation ID, which means you can point to a custom HTTP URL, or ForgeBox slug, etc.
As of version 4.0 of this module, the debugger libs will be added automatically for you based on your OS. To disable the debugger libs use the following setting:
# Server specific version
server set fusionreactor.debugEnable=false
# global default version
config set server.defaults.fusionreactor.debugEnable=false
There are a handful of JVM args we can use to set things like license key or password, but there are many many settings inside of FusionReactor that have no corresponding method to externalize them. These are stored in a file called
conf/reactor.confinside of the FusionReactor home directory. If you want to script out settings such as
- E-mail servers
- Notification settings
- Profiler settings
- Request history settings
Then you can make a copy of a
reactor.conffile that contains the settings you want the point this module at the file to be copied over when starting the server so FR will pick it up and use it. Just need in mind that this setting will override any manual setting changes you make in the FR web admin every time you start the server.
cp "`server info property=FRHomeDirectory`conf/reactor.conf" ./reactor.conf
server.jsonto the new file. Remember, non-absolute paths are relative to the directory the
server set fusionreactor.reactorconfFile=reactor.conf
Now, a fresh new server will have these settings.
server forget --force
reactor.conffile may contain passwords or other sensitive information. It is in a java properties file format, so feel free to edit it and remove items you don't want. Also, take care when committing it to a source repo or making it web accessible so you don't reveal information. There is currently no support for environment variable expansions in this file, but perhaps we'll add it if it's useful.
The CommandBox FusionReactor module has passthrough settings for every documented JVM arg. Here are the remaining ones we haven't covered. If you want to know what some of these do, read the official FR docs on them.
Here's the module setting, followed by the JVM arg it creates. Remember, you can use environment variables in your
server.jsonto control these dynamically on a per-server basis!
- fusionreactor.password -
- fusionreactor.cloudGroup -
- fusionreactor.requestObfuscateParameters -
- fusionreactor.autoApplicationNaming -
- fusionreactor.defaultApplicationName -
- fusionreactor.EDSEnable -
fr.ed.ds.enable(version added: 8.1.0)
- fusionreactor.EDSListen -
fr.ed.ds.listen(version added: 8.1.0)
- fusionreactor.EDSPollTimeout -
fr.ed.ds.polltimeout(version added: 8.1.0)
- fusionreactor.EDSMaxDataSize -
fr.ed.ds.maxdatasize(version added: 8.2.2)
- fusionreactor.EDSTarget -
fr.ed.ds.target(version added: 8.1.0)
- fusionreactor.EDSGroups -
fr.ed.ds.groups(version added: 8.1.0)
- fusionreactor.ChatEnabled -
fr.chat.enabled(version added: 8.7.2)
- fusionreactor.RESTRegisterURL -
- fusionreactor.RESTShutdownAction -
- fusionreactor.RESTRegisterHostname -
- fusionreactor.RESTRegisterGroup -
- fusionreactor.licenseDeactivateOnShutdown -
- fusionreactor.licenseLeaseTimeout -
By default, FusionReactor is only available on the FR port, and not the HTTP or HTTPS port. If you want to hit FusionReactor's web UI through your main web server on the standard HTTP port, then enable the external server setting. This completely bypasses the custom port and custom host discussed above.
This can provide a convenient method to make FR accessible, but remember to put appropriate lock-down rules on your external web server so FR is not publicly accessible. Also note if you have a web server such as Nginx only proxying traffic to .cfm URLs to CommandBox, you'll need to modify it to also proxy requests to
/fusionreactor/to CommandBox as well or this feature will not work and you'll just get an Nginx/etc 404 instead.
# Server specific version
server set fusionreactor.externalServerEnable=true
# global default version
config set server.defaults.fusionreactor.externalServerEnable=true