Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 151.1
edited by David Avendasora
on 2010/11/30 01:02
Change comment: There is no comment for this version
To version 148.1
edited by Pascal Robert
on 2009/08/10 15:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Wonder JavaMonitor and wotaskd
1 +Project Wonder additions to wotaskd and JavaMonitor
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.avendasora
1 +XWiki.probert
Content
... ... @@ -1,70 +5,13 @@
1 -[[image:WonderJavaMonitor.png||border="1"]]
2 -
3 -{{toc}}{{/toc}}
4 -
5 5  === Introduction ===
6 6  
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.
3 +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.
8 8  
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.
5 +=== Statistics ===
10 10  
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.
7 +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 :
12 12  
13 -=== Where To Get Them ===
14 -
15 -You can either download them pre-built from [[Wonder's Hudson build server>>http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]] or build them from the source code.
16 -
17 -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.
18 -
19 19  {{code}}
20 -ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
21 -{{/code}}
22 22  
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 -* *\-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.
29 -* *\-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.
30 -
31 -{{/info}}
32 -
33 -=== Bug Fixes to Apple's Versions ===
34 -
35 -==== JavaMonitor ====
36 -
37 -* Fixes an issue with the Application Delete page
38 -* Selection in Application Detail page is now Ajax and is maintained
39 -
40 -=== Improvements to Apple's versions ===
41 -
42 -==== Automatic archive of SiteConfig.xml ====
43 -
44 -On every change you make to an application's configuration, a backup of SiteConfig.xml will be created in, by default, /Library/WebObjects/Configuration.
45 -
46 -==== Simplified/Automated Bouncing ====
47 -
48 -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 :
49 -
50 -* Find the inactive (i.e., not started) instance and start it
51 -* Find the active instances (minus the one started in the previous step) and enable "Refuse New Session"
52 -* Bounce the active instances when the minimum session count is reached
53 -
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.
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 -
68 68  (
69 69   {
70 70   "configuredInstances" = "2";
... ... @@ -104,124 +104,77 @@
104 104  
105 105  If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
106 106  
107 -##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]##
50 +http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword
108 108  
109 -==== Direct Actions for Management Tasks ====
52 +=== Direct Actions to many tasks ===
110 110  
111 -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.
54 +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.
112 112  
113 -List of available direct actions :
56 +//?type=all// : return details about all applications and instances
57 +//?type=app&name=AppName// : return details about all instances of a specific application
58 +//?type=ins&name=AppName-InstanceNo// : return details about one specific instance
114 114  
115 -* {{{*}info{*}}} : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified
116 -##info?##{{{}{*}type=all{*}}}
117 -##info?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
118 -##info?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
60 +For example, if you want to get details about all instances and applications, you call :
119 119  
120 -* {{{*}running{*}}} : Returns {{{*}YES{*}}} if **all** of the specified are running, ##NO## if not
121 -##running?##{{{}{*}type=all{*}}}
122 -##running?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
123 -##running?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
62 +http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all
124 124  
125 -* {{{*}stopped{*}}} : Returns {{{*}YES{*}}} if **all** the specified is running, {{{*}NO{*}}} if not.
126 -##stopped?##{{{}{*}type=all{*}}}
127 -##stopped?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
128 -##stopped?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
64 +To get details about the //AjaxExample// application :
129 129  
130 -* {{{*}bounce{*}}} : Returns {{{*}OK{*}}} after Bouncing (see description above) as specified
131 -##bounce?##{{{}{*}type=all{*}}}
132 -##bounce?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
66 +http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample
133 133  
134 -* {{{*}clearDeaths{*}}} : Returns {{{*}OK{*}}} after clearing deaths as specified
135 -##clearDeaths?##{{{}{*}type=all{*}}}
136 -##clearDeaths?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
68 +And for a specific instance :
137 137  
138 -* {{{*}turnScheduledOn{*}}} : Returns {{{*}OK{*}}} after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.
139 -##turnScheduledOn?##{{{}{*}type=all{*}}}
140 -##turnScheduledOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
141 -##turnScheduledOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
70 +http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1
142 142  
143 -* {{{*}turnRefuseNewSessionsOn{*}}} : Returns {{{*}OK{*}}} after turning on "Refuse new sessions" as specified
144 -##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
145 -##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
146 -##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
72 +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 :
147 147  
148 -* {{{*}turnRefuseNewSessionsOff{*}}} : Returns {{{*}OK{*}}} after turning off "Refuse new sessions" as specified
149 -##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
150 -##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
151 -##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
74 +{{code}}
152 152  
153 -* {{{*}turnAutoRecoverOn{*}}} : Returns {{{*}OK{*}}} after turning on "Auto Recover" as specified
154 -##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
155 -##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
156 -##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
76 +[{"name": "AjaxExample", "id": "1", "host": "leopards.macti.lan", "port": "2001", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
77 + "transactions": "88", "activeSessions": "0", "averageIdlePeriod": "2.078", "avgTransactionTime": "0.197"},
78 +{"name": "AjaxExample", "id": "2", "host": "leopards.macti.lan", "port": "2002", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
79 +"transactions": "0", "activeSessions": "0", "averageIdlePeriod": "0.0", "avgTransactionTime": "0.0"},
80 +{"name": "AjaxExample2", "id": "1", "host": "leopards.macti.lan", "port": "2003", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
81 +"transactions": "0", "activeSessions": "0", "averageIdlePeriod": "0.0", "avgTransactionTime": "0.0"},
82 +{"name": "AjaxExample2", "id": "2", "host": "leopards.macti.lan", "port": "2004", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
83 +"transactions": "1", "activeSessions": "0", "averageIdlePeriod": "325.443", "avgTransactionTime": "0.0"}]
157 157  
158 -* {{{*}turnAutoRecoverOff{*}}} : Returns {{{*}OK{*}}} after turning off "Auto Recover" as specified
159 -##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
160 -##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
161 -##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
162 -
163 -* {{{*}forceQuit{*}}} : Returns {{{*}OK{*}}} after force quitting as specified. This could be useful to call from a monitoring system.
164 -##forceQuit?##{{{}{*}type=all{*}}}
165 -##forceQuit?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
166 -##forceQuit?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
167 -
168 -* {{{*}stop{*}}} : Returns {{{*}OK{*}}} after calling "Stop" as specified
169 -##stop?##{{{}{*}type=all{*}}}
170 -##stop?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
171 -##stop?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
172 -
173 -* {{{*}start{*}}} : Returns {{{*}OK{*}}} after calling "Start" as specified
174 -##start?##{{{}{*}type=all{*}}}
175 -##start?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
176 -##start?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
177 -
178 -To get details about all instances of all applications:
179 -##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]##
180 -
181 -To get details about the **AjaxExample** application:
182 -##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]##
183 -
184 -To get details about instance **1** of the **AjaxExample** application:
185 -##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]##
186 -
187 -==== Remote Control via REST Routes ====
188 -
189 -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.
190 -
191 -Examples of REST calls :
192 -
193 -{{code title="Adding a New Host"}}
194 -
195 -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
196 -
197 197  {{/code}}
198 198  
199 -{{code title="Fetching Details for All Applications"}}
87 +List of available direct actions :
200 200  
201 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
89 +///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
90 +///running// : return YES if the instance is running, NO if not.
91 +///stopped// : return NO if the instance is running, YES if not.
92 +///bounce//: more on it later.
93 +///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
94 +///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
95 +///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
96 +///turnAutoRecoverOn// : guess what? It activate "Auto recover"! And guess again? ///turnAutoRecoverOff// do the opposite!
97 +///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
98 +///stop// : stop an application/instance the normal way.
99 +///start// : start an application/instance the normal way.
202 202  
203 -{{/code}}
101 +=== Automatic archive of SiteConfig.xml ===
204 204  
205 -{{code title="Adding a New Application"}}
103 +On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
206 206  
207 -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
105 +=== Bounce feature ===
208 208  
209 -{{/code}}
107 +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 :
210 210  
211 -{{code title="Delete an Application"}}
109 +* Find the inactive (eg : not started) instance and start it
110 +* Find the active instances (minus the one started the step below) and enable "Refuse New Session"
111 +* Bounce the active instances when the minimum session count is reached
212 212  
213 -curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
113 +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.
214 214  
215 -{{/code}}
115 +=== Misc ===
216 216  
217 -{{code title="Adding a New Instance"}}
117 +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//).
218 218  
219 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
119 +If you build everything from Wonder source, you can run :
220 220  
121 +{{code}}
122 +ant deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
221 221  {{/code}}
222 -
223 -{{code title="Delete an Instance :"}}
224 -
225 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
226 -
227 -{{/code}}