Changes for page Wonder JavaMonitor and wotaskd
Last modified by Pascal Robert on 2023/08/10 22:21
From version 96.1
edited by David Avendasora
on 2010/11/29 22:44
on 2010/11/29 22:44
Change comment:
There is no comment for this version
To version 105.1
edited by David Avendasora
on 2010/11/29 20:20
on 2010/11/29 20:20
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -28,6 +28,8 @@ 28 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 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 30 31 + 32 + 31 31 {{/info}} 32 32 33 33 === Major Improvements over Apple's versions === ... ... @@ -40,21 +40,21 @@ 40 40 41 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 42 43 -* Find the inactive ( i.e.,not started) instance and start it44 -* Find the active instances (minus the one started inthepreviousstep) and enable "Refuse New Session"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" 45 45 * Bounce the active instances when the minimum session count is reached 46 46 47 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 48 49 -{{ warningtitle="Database Changes"}}51 +{{note title="Database Changes"}} 50 50 51 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 52 53 -{{/ warning}}55 +{{/note}} 54 54 55 55 ==== Statistics ==== 56 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.59 +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 58 59 59 {{code title="Statistics Example Results"}} 60 60 ... ... @@ -97,127 +97,100 @@ 97 97 98 98 If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query : 99 99 100 - ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]##102 +[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]] 101 101 102 -==== Direct Actions forManagementTasks ====104 +==== Direct Actions to many tasks ==== 103 103 104 -You can do most of the standard managementtasks you'dnormallydo inJavaMonitor'swebUI by callingstandard WebObjects DirectActions.Insteadof usingthe ##/wa/##requesthandlerthough,these managementtasksusea new##/admin/## requesthandler. These DirectActionscan beveryuseful,especially if you need to restart instances or otherdotasksfrom the command line, fromwithinAnt or other buildordeployment systems.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. 105 105 106 -List of available direct actions : 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 107 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 +For example, if you want to get details about all instances and applications, you call : 112 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}}**## 114 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]] 117 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}}**## 116 +To get details about the //AjaxExample// application : 122 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}}**## 118 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]] 126 126 127 -* **##clearDeaths##** : Returns **##OK##** after clearing deaths as specified 128 -##clearDeaths?**type=all**## 129 -##clearDeaths?**type=app&name={{color value="maroon"}}AppName{{/color}}**## 120 +And for a specific instance : 130 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}}**## 122 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]] 135 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}}**## 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 : 140 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}}**## 126 +{{code}} 145 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}}**## 128 +[Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/] 150 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}}**## 130 +{{/code}} 155 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}}**## 132 +List of available direct actions : 160 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}}**## 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. 165 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 183 ==== Remote Control via REST Routes ==== 184 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.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. 186 186 187 187 Examples of REST calls : 188 188 189 - {{codele="AddingaNew Host"}}152 +Fetching the details of all applications : 190 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.json154 +{{code}} 192 192 156 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json 157 + 193 193 {{/code}} 194 194 195 - {{code title="FetchingDetailsforAll Applications"}}160 +Adding a new application : 196 196 197 -c url -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json162 +{{code}} 198 198 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 165 + 199 199 {{/code}} 200 200 201 - {{code title="Adding aNewApplication"}}168 +Adding a new instance : 202 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.json170 +{{code}} 204 204 172 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost 173 + 205 205 {{/code}} 206 206 207 - {{code title="Delete anApplication"}}176 +Delete an application : 208 208 209 -c url -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json178 +{{code}} 210 210 180 +curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json 181 + 211 211 {{/code}} 212 212 213 - {{codetitle="AddingaNew Instance"}}184 +Delete an instance : 214 214 215 -c url -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost186 +{{code}} 216 216 188 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1 189 + 217 217 {{/code}} 218 218 219 - {{code title="DeleteanInstance:"}}192 +Adding a new host : 220 220 221 -c url -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1194 +{{code}} 222 222 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 197 + 223 223 {{/code}}