Skip to Content
Version 145.1 by Pascal Robert on 2010/09/29 11:11
Show last authors
1 === Introduction ===
2
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.
4
5 === Statistics ===
6
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 :
8
9 {{code}}
10
11 (
12 {
13 "configuredInstances" = "2";
14 "maxSessions" = "0";
15 "maxAvgIdleTime" = "2.078";
16 "avgTransactions" = "44.0000";
17 "sumSessions" = "0";
18 "avgAvgTransactionTime" = "0.0985000";
19 "refusingInstances" = "0";
20 "avgSessions" = "0.0000";
21 "maxTransactions" = "88";
22 "applicationName" = "AjaxExample";
23 "avgAvgIdleTime" = "1.0390000";
24 "maxAvgTransactionTime" = "0.197";
25 "runningInstances" = "2";
26 "sumTransactions" = "88";
27 },
28 {
29 "configuredInstances" = "2";
30 "maxSessions" = "0";
31 "maxAvgIdleTime" = "325.443";
32 "avgTransactions" = "0.5000";
33 "sumSessions" = "0";
34 "avgAvgTransactionTime" = "0.00000";
35 "refusingInstances" = "0";
36 "avgSessions" = "0.0000";
37 "maxTransactions" = "1";
38 "applicationName" = "AjaxExample2";
39 "avgAvgIdleTime" = "162.7215000";
40 "maxAvgTransactionTime" = "0.0";
41 "runningInstances" = "2";
42 "sumTransactions" = "1";
43 }
44 )
45
46 {{/code}}
47
48 If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
49
50 http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword
51
52 === Direct Actions to many tasks ===
53
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.
55
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
59
60 For example, if you want to get details about all instances and applications, you call :
61
62 http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all
63
64 To get details about the //AjaxExample// application :
65
66 http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample
67
68 And for a specific instance :
69
70 http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1
71
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 :
73
74 {{code}}
75
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"}]
84
85 {{/code}}
86
87 List of available direct actions :
88
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.
100
101 === Automatic archive of SiteConfig.xml ===
102
103 On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
104
105 === Bounce feature ===
106
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 :
108
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
112
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.
114
115 === REST routes ===
116
117 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.
118
119 Examples of REST calls :
120
121 Fetching the details of all applications :
122
123 {{code}}
124
125 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
126
127 {{/code}}
128
129 Adding a new application :
130
131 {{code}}
132
133 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
134
135 {{/code}}
136
137 Adding a new instance :
138
139 {{code}}
140
141 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
142
143 {{/code}}
144
145 Delete an application :
146
147 {{code}}
148
149 curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
150
151 {{/code}}
152
153 Delete an instance :
154
155 {{code}}
156
157 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
158
159 {{/code}}
160
161 Adding a new host :
162
163 {{code}}
164
165 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
166
167 {{/code}}
168
169 === Misc ===
170
171 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//).
172
173 If you build everything from Wonder source, you can run :
174
175 {{code}}
176 ant deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
177 {{/code}}