Skip to Content
Version 96.1 by David Avendasora on 2010/11/29 22:44
Show last authors
1 [[image:WonderJavaMonitor.png||border="1"]]
2
3 {{toc}}{{/toc}}
4
5 === Introduction ===
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.
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.
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.
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 {{code}}
20 ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
21 {{/code}}
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 === Major Improvements over Apple's versions ===
34
35 ==== Automatic archive of SiteConfig.xml ====
36
37 On every change you make to an application's configuration, a backup of SiteConfig.xml will be created in, by default, /Library/WebObjects/Configuration.
38
39 ==== Simplified/Automated Bouncing ====
40
41 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 :
42
43 * Find the inactive (i.e., not started) instance and start it
44 * Find the active instances (minus the one started in the previous step) and enable "Refuse New Session"
45 * Bounce the active instances when the minimum session count is reached
46
47 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.
48
49 {{warning title="Database Changes"}}
50
51 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\!*
52
53 {{/warning}}
54
55 ==== Statistics ====
56
57 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.
58
59 {{code title="Statistics Example Results"}}
60
61 (
62 {
63 "configuredInstances" = "2";
64 "maxSessions" = "0";
65 "maxAvgIdleTime" = "2.078";
66 "avgTransactions" = "44.0000";
67 "sumSessions" = "0";
68 "avgAvgTransactionTime" = "0.0985000";
69 "refusingInstances" = "0";
70 "avgSessions" = "0.0000";
71 "maxTransactions" = "88";
72 "applicationName" = "AjaxExample";
73 "avgAvgIdleTime" = "1.0390000";
74 "maxAvgTransactionTime" = "0.197";
75 "runningInstances" = "2";
76 "sumTransactions" = "88";
77 },
78 {
79 "configuredInstances" = "2";
80 "maxSessions" = "0";
81 "maxAvgIdleTime" = "325.443";
82 "avgTransactions" = "0.5000";
83 "sumSessions" = "0";
84 "avgAvgTransactionTime" = "0.00000";
85 "refusingInstances" = "0";
86 "avgSessions" = "0.0000";
87 "maxTransactions" = "1";
88 "applicationName" = "AjaxExample2";
89 "avgAvgIdleTime" = "162.7215000";
90 "maxAvgTransactionTime" = "0.0";
91 "runningInstances" = "2";
92 "sumTransactions" = "1";
93 }
94 )
95
96 {{/code}}
97
98 If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
99
100 ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]##
101
102 ==== Direct Actions for Management Tasks ====
103
104 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.
105
106 List of available direct actions :
107
108 * **##info##** : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified
109 ##info?**type=all**##
110 ##info?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
111 ##info?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
112
113 * **##running##** : Returns **##YES##** if **all** of the specified are running, ##NO## if not
114 ##running?**type=all**##
115 ##running?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
116 ##running?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
117
118 * **##stopped##** : Returns **##YES##** if **all** the specified is running, **##NO##** if not.
119 ##stopped?**type=all**##
120 ##stopped?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
121 ##stopped?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
122
123 * **##bounce##** : Returns **##OK##** after Bouncing (see description above) as specified
124 ##bounce?**type=all**##
125 ##bounce?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
126
127 * **##clearDeaths##** : Returns **##OK##** after clearing deaths as specified
128 ##clearDeaths?**type=all**##
129 ##clearDeaths?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
130
131 * **##turnScheduledOn##** : Returns **##OK##** after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.
132 ##turnScheduledOn?**type=all**##
133 ##turnScheduledOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
134 ##turnScheduledOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
135
136 * **##turnRefuseNewSessionsOn##** : Returns **##OK##** after turning on "Refuse new sessions" as specified
137 ##turnRefuseNewSessionsOn?**type=all**##
138 ##turnRefuseNewSessionsOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
139 ##turnRefuseNewSessionsOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
140
141 * **##turnRefuseNewSessionsOff##** : Returns **##OK##** after turning off "Refuse new sessions" as specified
142 ##turnRefuseNewSessionsOn?**type=all**##
143 ##turnRefuseNewSessionsOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
144 ##turnRefuseNewSessionsOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
145
146 * **##turnAutoRecoverOn##** : Returns **##OK##** after turning on "Auto Recover" as specified
147 ##turnAutoRecoverOn?**type=all**##
148 ##turnAutoRecoverOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
149 ##turnAutoRecoverOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
150
151 * **##turnAutoRecoverOff##** : Returns **##OK##** after turning off "Auto Recover" as specified
152 ##turnAutoRecoverOn?**type=all**##
153 ##turnAutoRecoverOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
154 ##turnAutoRecoverOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
155
156 * **##forceQuit##** : Returns **##OK##** after force quitting as specified. This could be useful to call from a monitoring system.
157 ##forceQuit?**type=all**##
158 ##forceQuit?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
159 ##forceQuit?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
160
161 * **##stop##** : Returns **##OK##** after calling "Stop" as specified
162 ##stop?**type=all**##
163 ##stop?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
164 ##stop?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
165
166 * **##start##** : Returns **##OK##** after calling "Start" as specified
167 ##start?**type=all**##
168 ##start?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
169 ##start?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
170
171 For example, if you want to get details about all instances and applications, you call :
172
173 [[http://monitorhost:port9/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
174
175 To get details about the //AjaxExample// application :
176
177 [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
178
179 And for a specific instance :
180
181 [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
182
183 ==== Remote Control via REST Routes ====
184
185 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.
186
187 Examples of REST calls :
188
189 {{code title="Adding a New Host"}}
190
191 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
192
193 {{/code}}
194
195 {{code title="Fetching Details for All Applications"}}
196
197 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
198
199 {{/code}}
200
201 {{code title="Adding a New Application"}}
202
203 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
204
205 {{/code}}
206
207 {{code title="Delete an Application"}}
208
209 curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
210
211 {{/code}}
212
213 {{code title="Adding a New Instance"}}
214
215 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
216
217 {{/code}}
218
219 {{code title="Delete an Instance :"}}
220
221 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
222
223 {{/code}}