Skip to Content

Wiki source code of Wonder JavaMonitor and wotaskd

Version 172.1 by Pascal Robert on 2012/08/09 11:42
Hide last authors
simon 149.1 1 [[image:WonderJavaMonitor.png||border="1"]]
2
3 {{toc}}{{/toc}}
4
Pascal Robert 57.1 5 === Introduction ===
6
simon 149.1 7 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.
Pascal Robert 57.1 8
simon 149.1 9 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.
David Avendasora 77.1 10
simon 149.1 11 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.
David Avendasora 77.1 12
simon 149.1 13 === Where To Get Them ===
14
Pascal Robert 167.1 15 You can either download them pre-built from [[Wonder's Jenkins build server>>http://jenkins.wocommunity.org/job/Wonder/lastSuccessfulBuild/]] or build them from the source code.
simon 149.1 16
Pascal Robert 171.1 17 To build them from the [[Wonder source code>>Getting the Wonder Source Code]], simply run the following command from the Wonder directory at the root of the Wonder source.
simon 149.1 18
David Avendasora 113.1 19 {{code}}
Pascal Robert 167.1 20 ant frameworks deployment.tools -Ddeployment.standalone=true
simon 149.1 21 {{/code}}
David Avendasora 77.1 22
simon 149.1 23 {{info title="What this command does:"}}
24
25 * *ant*: calls Apache Ant. It is assumed that you have this already installed.
26 * *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.
27 * *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.
28 * *\-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.
29
30 {{/info}}
31
32 === Bug Fixes to Apple's Versions ===
33
34 ==== JavaMonitor ====
35
36 * Fixes an issue with the Application Delete page
37 * Selection in Application Detail page is now Ajax and is maintained
38
39 === Improvements to Apple's versions ===
40
41 ==== Automatic archive of SiteConfig.xml ====
42
43 On every change you make to an application's configuration, a backup of SiteConfig.xml will be created in, by default, /Library/WebObjects/Configuration.
44
45 ==== Simplified/Automated Bouncing ====
46
John Huss 165.1 47 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 instance (only one inactive instance takes part in the bounce). What it does is :
simon 149.1 48
John Huss 165.1 49 * Find one inactive (i.e., not started) instance and start it
simon 149.1 50 * Find the active instances (minus the one started in the previous step) and enable "Refuse New Session"
John Huss 165.1 51 * Stop the active instances that are refusing new sessions when the minimum session count is reached
52 * Restart all but one of the instances that were just stopped and turn on "Auto-Recover"
simon 149.1 53
John Huss 165.1 54 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.  This is designed to work so that you always have just **one** inactive instance that is only used while the bounce is performed.  While waiting for the existing sessions to end you will have only one instance of your app accepting new sessions; you need to determine if this is acceptable for your app or not.
simon 149.1 55
56 {{warning title="Database Changes"}}
57
58 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\!*
59
60 {{/warning}}
61
62 ==== Statistics ====
63
64 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.
65
66 {{code title="Statistics Example Results"}}
67
Pascal Robert 57.1 68 (
69 {
70 "configuredInstances" = "2";
71 "maxSessions" = "0";
72 "maxAvgIdleTime" = "2.078";
73 "avgTransactions" = "44.0000";
74 "sumSessions" = "0";
75 "avgAvgTransactionTime" = "0.0985000";
76 "refusingInstances" = "0";
77 "avgSessions" = "0.0000";
78 "maxTransactions" = "88";
79 "applicationName" = "AjaxExample";
80 "avgAvgIdleTime" = "1.0390000";
81 "maxAvgTransactionTime" = "0.197";
82 "runningInstances" = "2";
83 "sumTransactions" = "88";
84 },
85 {
86 "configuredInstances" = "2";
87 "maxSessions" = "0";
88 "maxAvgIdleTime" = "325.443";
89 "avgTransactions" = "0.5000";
90 "sumSessions" = "0";
91 "avgAvgTransactionTime" = "0.00000";
92 "refusingInstances" = "0";
93 "avgSessions" = "0.0000";
94 "maxTransactions" = "1";
95 "applicationName" = "AjaxExample2";
96 "avgAvgIdleTime" = "162.7215000";
97 "maxAvgTransactionTime" = "0.0";
98 "runningInstances" = "2";
99 "sumTransactions" = "1";
100 }
101 )
102
David Avendasora 113.1 103 {{/code}}
Pascal Robert 57.1 104
Pascal Robert 171.1 105 {{info}}
Pascal Robert 57.1 106
pyu 169.1 107 If JavaMonitor is configured with a password, and I hope you do, pass _pw=monitorpassword_ as a argument to the query :
Pascal Robert 57.1 108
Pascal Robert 171.1 109 {code}
110 http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword
pyu 169.1 111
Pascal Robert 171.1 112 wget http://monitorhost:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/stop?type=app&name=InstanceName&pw=yourPassword
113 {code}
pyu 169.1 114
Pascal Robert 171.1 115 {{/info}}
pyu 169.1 116
simon 149.1 117 ==== Direct Actions for Management Tasks ====
Pascal Robert 57.1 118
simon 149.1 119 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.
Pascal Robert 57.1 120
simon 149.1 121 List of available direct actions :
David Avendasora 113.1 122
simon 149.1 123 * {{{*}info{*}}} : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified
124 ##info?##{{{}{*}type=all{*}}}
125 ##info?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
126 ##info?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
Pascal Robert 57.1 127
simon 149.1 128 * {{{*}running{*}}} : Returns {{{*}YES{*}}} if **all** of the specified are running, ##NO## if not
129 ##running?##{{{}{*}type=all{*}}}
130 ##running?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
131 ##running?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
Pascal Robert 57.1 132
simon 149.1 133 * {{{*}stopped{*}}} : Returns {{{*}YES{*}}} if **all** the specified is running, {{{*}NO{*}}} if not.
134 ##stopped?##{{{}{*}type=all{*}}}
135 ##stopped?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
136 ##stopped?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
Pascal Robert 57.1 137
simon 149.1 138 * {{{*}bounce{*}}} : Returns {{{*}OK{*}}} after Bouncing (see description above) as specified
139 ##bounce?##{{{}{*}type=all{*}}}
140 ##bounce?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
Pascal Robert 57.1 141
simon 149.1 142 * {{{*}clearDeaths{*}}} : Returns {{{*}OK{*}}} after clearing deaths as specified
143 ##clearDeaths?##{{{}{*}type=all{*}}}
144 ##clearDeaths?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
Pascal Robert 57.1 145
simon 149.1 146 * {{{*}turnScheduledOn{*}}} : Returns {{{*}OK{*}}} after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.
147 ##turnScheduledOn?##{{{}{*}type=all{*}}}
148 ##turnScheduledOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
149 ##turnScheduledOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
Pascal Robert 57.1 150
simon 149.1 151 * {{{*}turnRefuseNewSessionsOn{*}}} : Returns {{{*}OK{*}}} after turning on "Refuse new sessions" as specified
152 ##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
153 ##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
154 ##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
David Avendasora 105.1 155
simon 149.1 156 * {{{*}turnRefuseNewSessionsOff{*}}} : Returns {{{*}OK{*}}} after turning off "Refuse new sessions" as specified
157 ##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
158 ##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
159 ##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
David Avendasora 113.1 160
simon 149.1 161 * {{{*}turnAutoRecoverOn{*}}} : Returns {{{*}OK{*}}} after turning on "Auto Recover" as specified
162 ##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
163 ##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
164 ##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
David Avendasora 105.1 165
simon 149.1 166 * {{{*}turnAutoRecoverOff{*}}} : Returns {{{*}OK{*}}} after turning off "Auto Recover" as specified
167 ##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
168 ##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
169 ##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
170
171 * {{{*}forceQuit{*}}} : Returns {{{*}OK{*}}} after force quitting as specified. This could be useful to call from a monitoring system.
172 ##forceQuit?##{{{}{*}type=all{*}}}
173 ##forceQuit?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
174 ##forceQuit?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
175
176 * {{{*}stop{*}}} : Returns {{{*}OK{*}}} after calling "Stop" as specified
177 ##stop?##{{{}{*}type=all{*}}}
178 ##stop?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
179 ##stop?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
180
181 * {{{*}start{*}}} : Returns {{{*}OK{*}}} after calling "Start" as specified
182 ##start?##{{{}{*}type=all{*}}}
183 ##start?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
184 ##start?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
185
186 To get details about all instances of all applications:
187 ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]##
188
189 To get details about the **AjaxExample** application:
190 ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]##
191
192 To get details about instance **1** of the **AjaxExample** application:
193 ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]##
194
195 ==== Remote Control via REST Routes ====
196
Pascal Robert 171.1 197 If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via [[REST>>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.
simon 149.1 198
199 Examples of REST calls :
200
201 {{code title="Adding a New Host"}}
202
203 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
204
David Avendasora 113.1 205 {{/code}}
206
simon 149.1 207 {{code title="Fetching Details for All Applications"}}
David Avendasora 105.1 208
simon 149.1 209 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
David Avendasora 105.1 210
simon 149.1 211 {{/code}}
David Avendasora 113.1 212
simon 149.1 213 {{code title="Adding a New Application"}}
David Avendasora 121.1 214
simon 149.1 215 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
David Avendasora 121.1 216
simon 149.1 217 {{/code}}
David Avendasora 121.1 218
simon 149.1 219 {{code title="Delete an Application"}}
David Avendasora 121.1 220
simon 149.1 221 curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
David Avendasora 121.1 222
simon 149.1 223 {{/code}}
David Holt 137.1 224
simon 149.1 225 {{code title="Adding a New Instance"}}
David Holt 137.1 226
simon 149.1 227 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
David Holt 137.1 228
229 {{/code}}
simon 149.1 230
simon 163.1 231 {{code title="Delete an Instance"}}
simon 149.1 232
233 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
234
235 {{/code}}
simon 153.1 236
simon 163.1 237 {{code title="Configuring the Site"}}
simon 153.1 238
simon 155.1 239 curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json
simon 153.1 240
241 {{/code}}
John Huss 165.1 242
243 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.
244
Pascal Robert 172.1 245 {{info}}
246 Starting on August 9th 2012 (in the integration branch of Wonder), the REST routes are also available in wotaskd.
247 {{/info}}
248
John Huss 165.1 249 === Troubleshooting ===
250
Pascal Robert 171.1 251 If JavaMonitor won't start up check the [[troubleshooting deployment>>Troubleshooting Deployment]] section. In particular pay attention to the [[WOTaskd Didn't Start>>Troubleshooting Deployment]] Q&A.