Wonder JavaMonitor and wotaskd

Version 65.1 by David Avendasora on 2011/04/25 12:42

Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Introduction

JavaMonitor is a web-based tool used to configure and maintain deployed WebObjects applications. It is capable of handling multiple WebObjects applications, multiple instances of each application, and multiple WebObjects Applications Servers. In most cases you'll have one instance of JavaMonitor controlling all instances of your applications, even if they are spread across multiple Application Servers.

wotaskd (WebObjects task daemon) is the WebObjects Deployment tool that manages the instances on an Application Server. It's used by Monitor to propagate site configuration changes throughout the site's application hosts.

Apple released the original wotaskd and JavaMonitor to the community as open source in WebObjects 5.4. The source was then quickly modified and included in Project Wonder. Substantial improvements in both functionality and look-and-feel have been made over the years. These improved versions of wotaskd.woa and JavaMonitor.woa are available as standard Wonder applications.

Where To Get Them

You can either download them pre-built from Wonder's Hudson build server or build them from the source code.

To build them from the Wonder source code, simply run the following command from the Wonder directory at the root of the Wonder source.

ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true

What this command does:

*ant*: calls Apache Ant. It is assumed that you have this already installed.
*frameworks*: tells Ant to build the "frameworks" target. This may not be needed if you already have Wonder built and installed in a location Ant can find automatically.
*deployment.tools*: tells Ant to build the "deployment.tools" target. This is the target that builds both wotaskd.woa and JavaMonitor.woa. You absolutely need this one.
*\-Dwonder.patch=54*: tells Wonder to build for WebObjects version 5.4. You need this if you are building against Wonder Trunk. Some branches don't need it, but it doesn't hurt either.
*\-Ddeployment.standalone=true*: argument will embed the required Wonder and WebObjects frameworks in built applications. You need this to ensure that the required frameworks are embedded in the built applications.

Bug Fixes to Apple's Versions

JavaMonitor

Fixes an issue with the Application Delete page
Selection in Application Detail page is now Ajax and is maintained

Improvements to Apple's versions

Automatic archive of SiteConfig.xml

On every change you make to an application's configuration, a backup of SiteConfig.xml will be created in, by default, /Library/WebObjects/Configuration.

Simplified/Automated Bouncing

In the "list instances" page, you get a "Bounce" action link. This action only work if you have at least one active instance and one inactive. What it does is :

Find the inactive (i.e., not started) instance and start it
Find the active instances (minus the one started in the previous step) and enable "Refuse New Session"
Bounce the active instances when the minimum session count is reached

This feature, from Pascal's understanding, allows you to upload new versions of your application, start up the new version and refuse sessions for the instances running on the older version.

Database Changes

It is uncertain what will happen if the new version of your application makes changes to your database schema (e.g., uses [ERXMigrations|WO:Project WONDER-Frameworks-ERXMigration]). The old instances may raise exceptions before they can gracefully shut down because the schema no longer matches what the old application's EOF expects. *Try it out on a test server first and then update this page so everyone knows\!*

Statistics

If you call http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics, JavaMonitor will send you back statistics, in JSON format, about instances, per application.

Statistics Example Results

(
{
"configuredInstances" = "2";
"maxSessions" = "0";
"maxAvgIdleTime" = "2.078";
"avgTransactions" = "44.0000";
"sumSessions" = "0";
"avgAvgTransactionTime" = "0.0985000";
"refusingInstances" = "0";
"avgSessions" = "0.0000";
"maxTransactions" = "88";
"applicationName" = "AjaxExample";
"avgAvgIdleTime" = "1.0390000";
"maxAvgTransactionTime" = "0.197";
"runningInstances" = "2";
"sumTransactions" = "88";
},
{
"configuredInstances" = "2";
"maxSessions" = "0";
"maxAvgIdleTime" = "325.443";
"avgTransactions" = "0.5000";
"sumSessions" = "0";
"avgAvgTransactionTime" = "0.00000";
"refusingInstances" = "0";
"avgSessions" = "0.0000";
"maxTransactions" = "1";
"applicationName" = "AjaxExample2";
"avgAvgIdleTime" = "162.7215000";
"maxAvgTransactionTime" = "0.0";
"runningInstances" = "2";
"sumTransactions" = "1";
}
)

If JavaMonitor is configured with a password, and I hope you do, pass pw=monitorpassword as a argument to the query :

http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword

Direct Actions for Management Tasks

You can do most of the standard management tasks you'd normally do in JavaMonitor's web UI by calling standard WebObjects Direct Actions. Instead of using the /wa/ request handler though, these management tasks use a new /admin/ request handler. These Direct Actions can be very useful, especially if you need to restart instances or other do tasks from the command line, from within Ant or other build or deployment systems.

List of available direct actions :

*}info{* : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified
info?}{*}type=all{*
info?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

info?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}running{* : Returns *}YES{* if all of the specified are running, NO if not
running?}{*}type=all{*
running?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

running?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}stopped{* : Returns *}YES{* if all the specified is running, *}NO{* if not.
stopped?}{*}type=all{*
stopped?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

stopped?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}bounce{* : Returns *}OK{* after Bouncing (see description above) as specified
bounce?}{*}type=all{*
bounce?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}clearDeaths{* : Returns *}OK{* after clearing deaths as specified
clearDeaths?}{*}type=all{*
clearDeaths?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}turnScheduledOn{* : Returns *}OK{* after turning on scheduling as specified. Call /turnScheduledOff to do the opposite.
turnScheduledOn?}{*}type=all{*
turnScheduledOn?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

turnScheduledOn?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}turnRefuseNewSessionsOn{* : Returns *}OK{* after turning on "Refuse new sessions" as specified
turnRefuseNewSessionsOn?}{*}type=all{*
turnRefuseNewSessionsOn?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

turnRefuseNewSessionsOn?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}turnRefuseNewSessionsOff{* : Returns *}OK{* after turning off "Refuse new sessions" as specified
turnRefuseNewSessionsOn?}{*}type=all{*
turnRefuseNewSessionsOn?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

turnRefuseNewSessionsOn?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}turnAutoRecoverOn{* : Returns *}OK{* after turning on "Auto Recover" as specified
turnAutoRecoverOn?}{*}type=all{*
turnAutoRecoverOn?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

turnAutoRecoverOn?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}turnAutoRecoverOff{* : Returns *}OK{* after turning off "Auto Recover" as specified
turnAutoRecoverOn?}{*}type=all{*
turnAutoRecoverOn?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

turnAutoRecoverOn?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}forceQuit{* : Returns *}OK{* after force quitting as specified. This could be useful to call from a monitoring system.
forceQuit?}{*}type=all{*
forceQuit?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

forceQuit?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}stop{* : Returns *}OK{* after calling "Stop" as specified
stop?}{*}type=all{*
stop?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

stop?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

*}start{* : Returns *}OK{* after calling "Start" as specified
start?}{*}type=all{*
start?}{*}type=app&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

start?}{*}type=ins&name=*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
}*\-*{Unknown macro: color. Click on this message for details.
The [color] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

To get details about all instances of all applications:
http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all

To get details about the AjaxExample application:
http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample

To get details about instance 1 of the AjaxExample application:
http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1

Remote Control via REST Routes

If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via REST calls. Between the two methods (Direct Actions, REST) you have almost full remote-control of JavaMonitor. Just make sure that your JavaMonitor installation is secure Just like with Direct Actions, you need to append ?pw=XXXX to the URLs if your JavaMonitor is password protected.

Examples of REST calls :

Adding a New Host

curl -X POST -d "{id: 'otherserver.com',type: 'MHost', osType: 'MACOSX',address: '192.168.20.5', name: 'otherserver.com'}" http://monitorhost:port/apps/WebObjects/JavaMonitor.woa/ra/mHosts.json

Fetching Details for All Applications

curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json

Adding a New Application

curl -X POST -d "{id: 'AjaxExample',type: 'MApplication', name: 'AjaxExample',unixOutputPath: '/opt/Local/Library/WebObjects/Logs', unixPath: '/opt/Local/Library/WebObjects/Applications/AjaxExample.woa/AjaxExample'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json

Delete an Application

curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json

Adding a New Instance

curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost

Delete an Instance

curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1

Configuring the Site

curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json

Note that before configuring the site you must first add a host. If you attempt to configure the site prior to adding a host you will get an InvalidStateException.

Troubleshooting

If JavaMonitor won't start up check the troubleshooting deployment section. In particular pay attention to the WOTaskd Didn't Start Q&A.