Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 92.1
edited by David Avendasora
on 2010/11/29 21:48
Change comment: There is no comment for this version
To version 105.1
edited by David Avendasora
on 2010/11/29 20:20
Change comment: There is no comment for this version

Summary

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 it
44 -* Find the active instances (minus the one started in the previous step) 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 -{{warning title="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,48 +97,50 @@
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 for Management Tasks ====
104 +==== Direct Actions to many tasks ====
103 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.
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 the details (number of deaths, state, etc.; see example above), in JavaScript Object Notation (JSON)
109 -** **##?type=all##** : Returns details about all instances of all applications
110 -** **##?type=app&name={{color value="maroon"}}AppName{{/color}}##** : Returns details about all instances of a specific application
111 -** **##?type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}##** : Returns details about one specific instance
112 -* **##running##** : Returns **##YES##** or **##NO##**
113 -** **##?type=all##** : Returns **##YES##** if all instances of all applications are running
114 -** **##?type=app&name={{color value="maroon"}}AppName{{/color}}##** : Returns **##YES##** if all instances of the specified application are running
115 -** **##?type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}##** : Returns **##YES##** if the instance of the specified application is running
116 -* **##stopped##** : return NO if the instance is running, YES if not.
117 -* **##bounce##** : more on it later.
118 -* **##clearDeaths##** : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
119 -* **##turnScheduledOn##** : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
120 -* **##turnRefuseNewSessionsOn##** : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
121 -* **##turnAutoRecoverOn##** : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
122 -* **##forceQuit##** : force quit an application, might be useful to call it from a monitoring system.
123 -* **##stop##** : stop an application/instance the normal way.
124 -* **##start##** : start an application/instance the normal way.
125 -
126 -##?type=all## : returns details about all applications and instances
127 -##?type=app&name=AppName## : returns details about all instances of a specific application
128 -##?type=ins&name=AppName-InstanceNo## : returns details about one specific instance
129 -
130 130  For example, if you want to get details about all instances and applications, you call :
131 131  
132 -[[http://monitorhost:port9/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
114 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
133 133  
134 134  To get details about the //AjaxExample// application :
135 135  
136 -[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
118 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
137 137  
138 138  And for a specific instance :
139 139  
140 -[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
122 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
141 141  
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 :
125 +
126 +{{code}}
127 +
128 +[Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
129 +
130 +{{/code}}
131 +
132 +List of available direct actions :
133 +
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.
145 +
142 142  ==== Remote Control via REST Routes ====
143 143  
144 144  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.
... ... @@ -145,38 +145,50 @@
145 145  
146 146  Examples of REST calls :
147 147  
148 -{{code title="Adding a New Host"}}
152 +Fetching the details of all applications :
149 149  
150 -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
154 +{{code}}
151 151  
156 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
157 +
152 152  {{/code}}
153 153  
154 -{{code title="Fetching Details for All Applications"}}
160 +Adding a new application :
155 155  
156 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
162 +{{code}}
157 157  
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 +
158 158  {{/code}}
159 159  
160 -{{code title="Adding a New Application"}}
168 +Adding a new instance :
161 161  
162 -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
170 +{{code}}
163 163  
172 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
173 +
164 164  {{/code}}
165 165  
166 -{{code title="Delete an Application"}}
176 +Delete an application :
167 167  
168 -curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
178 +{{code}}
169 169  
180 +curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
181 +
170 170  {{/code}}
171 171  
172 -{{code title="Adding a New Instance"}}
184 +Delete an instance :
173 173  
174 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
186 +{{code}}
175 175  
188 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
189 +
176 176  {{/code}}
177 177  
178 -{{code title="Delete an Instance :"}}
192 +Adding a new host :
179 179  
180 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
194 +{{code}}
181 181  
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 +
182 182  {{/code}}