Skip to Content
Version 134.1 by David Avendasora on 2010/11/29 17:57
Hide last authors
David Avendasora 77.1 1 {{toc}}{{/toc}}
2
Pascal Robert 57.1 3 === Introduction ===
4
Pascal Robert 131.1 5 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.
Pascal Robert 57.1 6
David Avendasora 133.1 7 [[image:WonderJavaMonitor.png||border="1"]]
David Avendasora 129.1 8
Pascal Robert 131.1 9 === Misc ===
David Avendasora 129.1 10
Pascal Robert 131.1 11 The community's improved versions of **wotaskd.woa** and **JavaMonitor.woa** are now available as full Wonder applications. You can download them pre-built from the [[Hudson Wonder build server>>http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]].
Pascal Robert 57.1 12
Pascal Robert 131.1 13 If you build everything from Wonder source, you can run :
David Avendasora 77.1 14
Pascal Robert 57.1 15 {{code}}
Pascal Robert 131.1 16 ant deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
David Avendasora 77.1 17 {{/code}}
Pascal Robert 57.1 18
David Avendasora 133.1 19 The //Ddeployment.standalone=true// argument will embed the required frameworks in wotaskd and JavaMonitor. Please note that you have to build the Wonder frameworks before calling //ant deployment.tools//, if you get classpath errors when building the deployment tools, first run:
David Avendasora 77.1 20
Pascal Robert 131.1 21 {{code}}
22 ant frameworks
23 {{/code}}
David Avendasora 77.1 24
David Avendasora 121.1 25 === Statistics ===
David Avendasora 77.1 26
David Avendasora 113.1 27 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 28
David Avendasora 113.1 29 {{code}}
David Avendasora 77.1 30
Pascal Robert 57.1 31 (
32 {
33 "configuredInstances" = "2";
34 "maxSessions" = "0";
35 "maxAvgIdleTime" = "2.078";
36 "avgTransactions" = "44.0000";
37 "sumSessions" = "0";
38 "avgAvgTransactionTime" = "0.0985000";
39 "refusingInstances" = "0";
40 "avgSessions" = "0.0000";
41 "maxTransactions" = "88";
42 "applicationName" = "AjaxExample";
43 "avgAvgIdleTime" = "1.0390000";
44 "maxAvgTransactionTime" = "0.197";
45 "runningInstances" = "2";
46 "sumTransactions" = "88";
47 },
48 {
49 "configuredInstances" = "2";
50 "maxSessions" = "0";
51 "maxAvgIdleTime" = "325.443";
52 "avgTransactions" = "0.5000";
53 "sumSessions" = "0";
54 "avgAvgTransactionTime" = "0.00000";
55 "refusingInstances" = "0";
56 "avgSessions" = "0.0000";
57 "maxTransactions" = "1";
58 "applicationName" = "AjaxExample2";
59 "avgAvgIdleTime" = "162.7215000";
60 "maxAvgTransactionTime" = "0.0";
61 "runningInstances" = "2";
62 "sumTransactions" = "1";
63 }
64 )
65
David Avendasora 113.1 66 {{/code}}
Pascal Robert 57.1 67
David Avendasora 113.1 68 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 69
David Avendasora 113.1 70 [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
Pascal Robert 57.1 71
David Avendasora 121.1 72 === Direct Actions to many tasks ===
Pascal Robert 57.1 73
David Avendasora 113.1 74 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 75
David Avendasora 113.1 76 //?type=all// : return details about all applications and instances
77 //?type=app&name=AppName// : return details about all instances of a specific application
78 //?type=ins&name=AppName-InstanceNo// : return details about one specific instance
79
David Avendasora 97.1 80 For example, if you want to get details about all instances and applications, you call :
Pascal Robert 57.1 81
David Avendasora 113.1 82 [[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
Pascal Robert 57.1 83
David Avendasora 113.1 84 To get details about the //AjaxExample// application :
Pascal Robert 57.1 85
David Avendasora 113.1 86 [[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
Pascal Robert 57.1 87
David Avendasora 97.1 88 And for a specific instance :
Pascal Robert 57.1 89
David Avendasora 113.1 90 [[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
Pascal Robert 57.1 91
David Avendasora 113.1 92 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 93
David Avendasora 113.1 94 {{code}}
95
David Avendasora 105.1 96 [Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
97
David Avendasora 113.1 98 {{/code}}
99
David Avendasora 105.1 100 List of available direct actions :
101
David Avendasora 113.1 102 ///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
103 ///running// : return YES if the instance is running, NO if not.
104 ///stopped// : return NO if the instance is running, YES if not.
105 ///bounce//: more on it later.
106 ///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
107 ///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
108 ///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
109 ///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
110 ///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
111 ///stop// : stop an application/instance the normal way.
112 ///start// : start an application/instance the normal way.
David Avendasora 105.1 113
David Avendasora 121.1 114 === Automatic archive of SiteConfig.xml ===
David Avendasora 113.1 115
David Avendasora 121.1 116 On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
117
118 === Bounce feature ===
119
120 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 :
121
122 * Find the inactive (eg : not started) instance and start it
123 * Find the active instances (minus the one started the step below) and enable "Refuse New Session"
124 * Bounce the active instances when the minimum session count is reached
125
126 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.
127
128 === REST routes ===
129
David Avendasora 113.1 130 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.
131
David Avendasora 77.1 132 Examples of REST calls :
133
David Avendasora 111.1 134 Fetching the details of all applications :
David Avendasora 113.1 135
136 {{code}}
137
David Avendasora 109.1 138 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
David Avendasora 77.1 139
David Avendasora 113.1 140 {{/code}}
141
David Avendasora 111.1 142 Adding a new application :
David Avendasora 77.1 143
David Avendasora 113.1 144 {{code}}
145
David Avendasora 109.1 146 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 147
David Avendasora 113.1 148 {{/code}}
149
David Avendasora 111.1 150 Adding a new instance :
David Avendasora 77.1 151
David Avendasora 113.1 152 {{code}}
153
David Avendasora 111.1 154 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
David Avendasora 77.1 155
David Avendasora 113.1 156 {{/code}}
157
David Avendasora 111.1 158 Delete an application :
159
David Avendasora 113.1 160 {{code}}
161
David Avendasora 105.1 162 curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
163
David Avendasora 113.1 164 {{/code}}
165
David Avendasora 111.1 166 Delete an instance :
David Avendasora 77.1 167
David Avendasora 113.1 168 {{code}}
169
David Avendasora 111.1 170 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
David Avendasora 77.1 171
David Avendasora 113.1 172 {{/code}}
173
David Avendasora 111.1 174 Adding a new host :
David Avendasora 77.1 175
David Avendasora 113.1 176 {{code}}
177
David Avendasora 111.1 178 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 179
David Avendasora 113.1 180 {{/code}}