Skip to Content
Version 119.1 by David Avendasora on 2010/11/29 20:09
Hide last authors
David Avendasora 77.1 1 [[image:WonderJavaMonitor.png||border="1"]]
2
3 {{toc}}{{/toc}}
4
Pascal Robert 57.1 5 === Introduction ===
6
David Avendasora 77.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
David Avendasora 77.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.
Pascal Robert 57.1 10
David Avendasora 77.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.
Pascal Robert 57.1 12
David Avendasora 77.1 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
Pascal Robert 57.1 19 {{code}}
David Avendasora 77.1 20 ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
21 {{/code}}
Pascal Robert 57.1 22
David Avendasora 77.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 * *\-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
32
David Avendasora 113.1 33 {{/info}}
David Avendasora 77.1 34
David Avendasora 115.1 35 === Major Improvements over Apple's versions ===
David Avendasora 77.1 36
David Avendasora 119.1 37 ==== Automatic archive of SiteConfig.xml ====
38
39 On every change you make to an application's configuration, a backup of SiteConfig.xml will be created in, by default, /Library/WebObjects/Configuration.
40
41 ==== Simplified/Automated Bouncing ====
42
43 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 :
44
45 * Find the inactive (eg : not started) instance and start it
46 * Find the active instances (minus the one started the step below) and enable "Refuse New Session"
47 * Bounce the active instances when the minimum session count is reached
48
49 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.
50
51 {{note}}
52
53 How this will work if your new version uses ERXMigrations to change your schema (e.g., The old instances might raise exceptions because the database schema changed), so try it out on a test server first and then update this page so everyone knows!
54
55 {{/note}}
56
David Avendasora 115.1 57 ==== Statistics ====
58
David Avendasora 113.1 59 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 :
David Avendasora 77.1 60
David Avendasora 113.1 61 {{code}}
David Avendasora 77.1 62
Pascal Robert 57.1 63 (
64 {
65 "configuredInstances" = "2";
66 "maxSessions" = "0";
67 "maxAvgIdleTime" = "2.078";
68 "avgTransactions" = "44.0000";
69 "sumSessions" = "0";
70 "avgAvgTransactionTime" = "0.0985000";
71 "refusingInstances" = "0";
72 "avgSessions" = "0.0000";
73 "maxTransactions" = "88";
74 "applicationName" = "AjaxExample";
75 "avgAvgIdleTime" = "1.0390000";
76 "maxAvgTransactionTime" = "0.197";
77 "runningInstances" = "2";
78 "sumTransactions" = "88";
79 },
80 {
81 "configuredInstances" = "2";
82 "maxSessions" = "0";
83 "maxAvgIdleTime" = "325.443";
84 "avgTransactions" = "0.5000";
85 "sumSessions" = "0";
86 "avgAvgTransactionTime" = "0.00000";
87 "refusingInstances" = "0";
88 "avgSessions" = "0.0000";
89 "maxTransactions" = "1";
90 "applicationName" = "AjaxExample2";
91 "avgAvgIdleTime" = "162.7215000";
92 "maxAvgTransactionTime" = "0.0";
93 "runningInstances" = "2";
94 "sumTransactions" = "1";
95 }
96 )
97
David Avendasora 113.1 98 {{/code}}
Pascal Robert 57.1 99
David Avendasora 113.1 100 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 101
David Avendasora 113.1 102 [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
Pascal Robert 57.1 103
David Avendasora 115.1 104 ==== Direct Actions to many tasks ====
Pascal Robert 57.1 105
David Avendasora 113.1 106 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.
Pascal Robert 57.1 107
David Avendasora 113.1 108 //?type=all// : return details about all applications and instances
109 //?type=app&name=AppName// : return details about all instances of a specific application
110 //?type=ins&name=AppName-InstanceNo// : return details about one specific instance
111
David Avendasora 97.1 112 For example, if you want to get details about all instances and applications, you call :
Pascal Robert 57.1 113
David Avendasora 113.1 114 [[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
Pascal Robert 57.1 115
David Avendasora 113.1 116 To get details about the //AjaxExample// application :
Pascal Robert 57.1 117
David Avendasora 113.1 118 [[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
Pascal Robert 57.1 119
David Avendasora 97.1 120 And for a specific instance :
Pascal Robert 57.1 121
David Avendasora 113.1 122 [[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
Pascal Robert 57.1 123
David Avendasora 113.1 124 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 :
David Avendasora 105.1 125
David Avendasora 113.1 126 {{code}}
127
David Avendasora 105.1 128 [Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
129
David Avendasora 113.1 130 {{/code}}
131
David Avendasora 105.1 132 List of available direct actions :
133
David Avendasora 113.1 134 ///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
135 ///running// : return YES if the instance is running, NO if not.
136 ///stopped// : return NO if the instance is running, YES if not.
137 ///bounce//: more on it later.
138 ///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
139 ///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
140 ///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
141 ///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
142 ///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
143 ///stop// : stop an application/instance the normal way.
144 ///start// : start an application/instance the normal way.
David Avendasora 105.1 145
David Avendasora 115.1 146 ==== Remote Control via REST Routes ====
David Avendasora 113.1 147
148 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.
149
David Avendasora 77.1 150 Examples of REST calls :
151
David Avendasora 111.1 152 Fetching the details of all applications :
David Avendasora 113.1 153
154 {{code}}
155
David Avendasora 109.1 156 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
David Avendasora 77.1 157
David Avendasora 113.1 158 {{/code}}
159
David Avendasora 111.1 160 Adding a new application :
David Avendasora 77.1 161
David Avendasora 113.1 162 {{code}}
163
David Avendasora 109.1 164 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
David Avendasora 77.1 165
David Avendasora 113.1 166 {{/code}}
167
David Avendasora 111.1 168 Adding a new instance :
David Avendasora 77.1 169
David Avendasora 113.1 170 {{code}}
171
David Avendasora 111.1 172 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
David Avendasora 77.1 173
David Avendasora 113.1 174 {{/code}}
175
David Avendasora 111.1 176 Delete an application :
177
David Avendasora 113.1 178 {{code}}
179
David Avendasora 105.1 180 curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
181
David Avendasora 113.1 182 {{/code}}
183
David Avendasora 111.1 184 Delete an instance :
David Avendasora 77.1 185
David Avendasora 113.1 186 {{code}}
187
David Avendasora 111.1 188 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
David Avendasora 77.1 189
David Avendasora 113.1 190 {{/code}}
191
David Avendasora 111.1 192 Adding a new host :
David Avendasora 77.1 193
David Avendasora 113.1 194 {{code}}
195
David Avendasora 111.1 196 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
David Avendasora 77.1 197
David Avendasora 113.1 198 {{/code}}