Changes for page Wonder JavaMonitor and wotaskd

Last modified by Pascal Robert on 2023/08/10 22:21

From 145.1 to 144.1 From 154.1 to 153.1

From version 153.1

edited by simon
on 2010/12/01 07:43

Change comment: There is no comment for this version

To version 145.1

edited by Pascal Robert
on 2010/09/29 11:11

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Wonder JavaMonitor and wotaskd
++Project Wonder additions to wotaskd and JavaMonitor

Author

@@ -1,1 +1,1 @@
--XWiki.simon
++XWiki.probert

Content

@@ -1,70 +5,13 @@
--[[image:WonderJavaMonitor.png||border="1"]]
--
--{{toc}}{{/toc}}
--
  === 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 and JavaMonitor were open sourced when WebObjects 5.4 was released in 2007. In 2008 and 2009, the source was modified and included in Project Wonder. This is the list of additions that were added to the Wonder versions of the tools.
--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.
++=== Statistics ===
--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.&nbsp;These improved versions of **wotaskd.woa** and **JavaMonitor.woa** are available as standard Wonder applications.
++If you call http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics, the answer send you back statistics, in JSON format, about instances, per application. Sample :
--=== Where To Get Them ===
--
--You can either download them pre-built from [[Wonder's Hudson build server>>http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]]&nbsp;or build them from the source code.
--
--To build them from the [[Wonder source code>>WONDER:Download Wonder Source, Build, Install and Upgrade]], simply run the following command from the Wonder directory at the root of the Wonder source.
--
  {{code}}
--ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
--{{/code}}
--{{info title="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.
--
--{{/info}}
--
--=== 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.
--
--{{warning title="Database Changes"}}
--
--It is uncertain what will happen if the new version of your application makes&nbsp;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\!*
--
--{{/warning}}
--
--==== 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.
--
--{{code title="Statistics Example Results"}}
--
  (
  	{
  		"configuredInstances" = "2";
@@ -104,136 +104,131 @@
  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]]##
++http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword
--==== Direct Actions for Management Tasks ====
++=== Direct Actions to many 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.
++You can do most of the standard tasks you do in Monitor by calling direct actions. They are in a different query handler, ///admin//. They follow the same format and use the same query parameters. Those DA can be useful if you need to restart instances or other tasks within ant or other build/deployment systems.
--List of available direct actions :
++//?type=all// : return details about all applications and instances
++//?type=app&name=AppName// : return details about all instances of a specific application
++//?type=ins&name=AppName-InstanceNo// : return details about one specific instance
--* {{{*}info{*}}} : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified
--##info?##{{{}{*}type=all{*}}}
--##info?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##info?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++For example, if you want to get details about all instances and applications, you call :
--* {{{*}running{*}}} : Returns {{{*}YES{*}}} if **all** of the specified are running, ##NO## if not
--##running?##{{{}{*}type=all{*}}}
--##running?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##running?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all
--* {{{*}stopped{*}}} : Returns {{{*}YES{*}}} if **all** the specified is running, {{{*}NO{*}}} if not.
--##stopped?##{{{}{*}type=all{*}}}
--##stopped?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##stopped?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++To get details about the //AjaxExample// application :
--* {{{*}bounce{*}}} : Returns {{{*}OK{*}}} after Bouncing (see description above) as specified
--##bounce?##{{{}{*}type=all{*}}}
--##bounce?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
++http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample
--* {{{*}clearDeaths{*}}} : Returns {{{*}OK{*}}} after clearing deaths as specified
--##clearDeaths?##{{{}{*}type=all{*}}}
--##clearDeaths?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
++And for a specific instance :
--* {{{*}turnScheduledOn{*}}} : Returns {{{*}OK{*}}} after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.
--##turnScheduledOn?##{{{}{*}type=all{*}}}
--##turnScheduledOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##turnScheduledOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1
--* {{{*}turnRefuseNewSessionsOn{*}}} : Returns {{{*}OK{*}}} after turning on "Refuse new sessions" as specified
--##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
--##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++The response for the direct actions will either send a JSON array or YES/NO. For example, the query //info// for all instances will return :
--* {{{*}turnRefuseNewSessionsOff{*}}} : Returns {{{*}OK{*}}} after turning off "Refuse new sessions" as specified
--##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
--##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++{{code}}
--* {{{*}turnAutoRecoverOn{*}}} : Returns {{{*}OK{*}}} after turning on "Auto Recover" as specified
--##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
--##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++[{"name": "AjaxExample", "id": "1", "host": "leopards.macti.lan", "port": "2001", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
++ "transactions": "88", "activeSessions": "0", "averageIdlePeriod": "2.078", "avgTransactionTime": "0.197"},
++{"name": "AjaxExample", "id": "2", "host": "leopards.macti.lan", "port": "2002", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
++"transactions": "0", "activeSessions": "0", "averageIdlePeriod": "0.0", "avgTransactionTime": "0.0"},
++{"name": "AjaxExample2", "id": "1", "host": "leopards.macti.lan", "port": "2003", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
++"transactions": "0", "activeSessions": "0", "averageIdlePeriod": "0.0", "avgTransactionTime": "0.0"},
++{"name": "AjaxExample2", "id": "2", "host": "leopards.macti.lan", "port": "2004", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
++"transactions": "1", "activeSessions": "0", "averageIdlePeriod": "325.443", "avgTransactionTime": "0.0"}]
--* {{{*}turnAutoRecoverOff{*}}} : Returns {{{*}OK{*}}} after turning off "Auto Recover" as specified
--##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
--##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++{{/code}}
--* {{{*}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=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##forceQuit?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++List of available direct actions :
--* {{{*}stop{*}}} : Returns {{{*}OK{*}}} after calling "Stop" as specified
--##stop?##{{{}{*}type=all{*}}}
--##stop?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##stop?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
++///running// : return YES if the instance is running, NO if not.
++///stopped// : return NO if the instance is running, YES if not.
++///bounce//: more on it later.
++///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
++///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
++///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
++///turnAutoRecoverOn// : guess what? It activate "Auto recover"! And guess again? ///turnAutoRecoverOff// do the opposite!
++///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
++///stop// : stop an application/instance the normal way.
++///start// : start an application/instance the normal way.
--* {{{*}start{*}}} : Returns {{{*}OK{*}}} after calling "Start" as specified
--##start?##{{{}{*}type=all{*}}}
--##start?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
--##start?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
++=== Automatic archive of SiteConfig.xml ===
--To get details about all instances of all applications:
--##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]##
++On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
--To get details about the **AjaxExample** application:
--##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]##
++=== Bounce feature ===
--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]]##
++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 :
--==== Remote Control via REST Routes ====
++* Find the inactive (eg : not started) instance and start it
++* Find the active instances (minus the one started the step below) and enable "Refuse New Session"
++* Bounce the active instances when the minimum session count is reached
--If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via [[REST>>WONDER:ERRest Framework]] 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.
++This feature, from my understanding, allow you to upload new versions of your app, start up the new version and refuse sessions for the instances running on the older version. I don't know how this will work if your new version use migrations to change your schema (eg : old instances might raise exceptions because of database schema changes), so try it out on a test server before and put your results here.
--Examples of REST calls :
++=== REST routes ===
--{{code title="Adding a New Host"}}
++On September 28th 2010, REST routes were added in JavaMonitor. Those routes + the direct actions explained in this document allow you to control almost everything remotely (make sure that your JavaMonitor installation is secure!). As the direct actions, append //?pw=XXXX// to the URLs if JavaMonitor is password protected.
--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
++Examples of REST calls :
--{{/code}}
++Fetching the details of all applications :
--{{code title="Fetching Details for All Applications"}}
++{{code}}
--curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
++curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
  {{/code}}
--{{code title="Adding a New Application"}}
++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
++{{code}}
++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://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
++
  {{/code}}
--{{code title="Delete an Application"}}
++Adding a new instance :
--curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
++{{code}}
++curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
++
  {{/code}}
--{{code title="Adding a New Instance"}}
++Delete an application :
--curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
++{{code}}
++curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
++
  {{/code}}
--{{code title="Delete an Instance :"}}
++Delete an instance :
--curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
++{{code}}
++curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
++
  {{/code}}
--{{code title="Adding a New Instance"}}
++Adding a new host :
--{color:#808080}curl \-X PUT \-d "{woAdaptor:'{color}{color:#2a5db0}www.mydomain.com{color}{color:#808080}'}"{color} {color:#2a5db0}http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json{color}
++{{code}}
++curl -X POST -d "{id: 'otherserver.com',type: 'MHost', osType: 'MACOSX',address: '192.168.20.5', name: 'otherserver.com'}" http://127.0.0.1:56789/apps/WebObjects/JavaMonitor.woa/ra/mHosts.json
++
  {{/code}}
--{{code title="Delete an Instance :"}}
++=== Misc ===
++wotaskd and JavaMonitor are now full Wonder applications, and needs Ajax.framework, ERExtensions.framework, ERJars.framework, JavaWOExtensions.framework and JavaMonitor.framework to work correctly. If you get wotaskd.woa and JavaMonitor.woa from the //Wonder-latest-Applications-54// archive, those frameworks are NOT embedded inside wotaskd.woa and JavaMonitor.woa, so either build them from source and embed the frameworks or copy the frameworks into the //appserver// user home (on OS X 10.5, it's in ///var/empty//).
++If you build everything from Wonder source, you can run :
++{{code}}
++ant deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
  {{/code}}

Changes for page Wonder JavaMonitor and wotaskd

Summary

Details

Applications

Navigation

My Recent Modifications

Need help?