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

Summary

Details

Page properties
Content
... ... @@ -28,35 +28,17 @@
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 ===
34 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 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.
39 +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 :
58 58  
59 -{{code title="Statistics Example Results"}}
41 +{{code}}
60 60  
61 61  (
62 62   {
... ... @@ -97,44 +97,29 @@
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]]##
82 +[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
101 101  
102 -==== Direct Actions for Management Tasks ====
84 +==== 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.
86 +=== ===
105 105  
106 -List of available direct actions :
88 +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.
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="blue"}}{{AppName}}{{/color}} : Returns details about all instances of a specific application
111 -** **##?type=ins&name=AppName-InstanceNo##** : Returns details about one specific instance
112 -* **##running##** : Returns **##YES##** or **##NO##**
113 -* **##stopped##** : return NO if the instance is running, YES if not.
114 -* **##bounce##** : more on it later.
115 -* **##clearDeaths##** : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
116 -* **##turnScheduledOn##** : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
117 -* **##turnRefuseNewSessionsOn##** : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
118 -* **##turnAutoRecoverOn##** : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
119 -* **##forceQuit##** : force quit an application, might be useful to call it from a monitoring system.
120 -* **##stop##** : stop an application/instance the normal way.
121 -* **##start##** : start an application/instance the normal way.
90 +//?type=all// : return details about all applications and instances
91 +//?type=app&name=AppName// : return details about all instances of a specific application
92 +//?type=ins&name=AppName-InstanceNo// : return details about one specific instance
122 122  
123 -##?type=all## : returns details about all applications and instances
124 -##?type=app&name=AppName## : returns details about all instances of a specific application
125 -##?type=ins&name=AppName-InstanceNo## : returns details about one specific instance
126 -
127 127  For example, if you want to get details about all instances and applications, you call :
128 128  
129 -[[http://monitorhost:port9/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
96 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
130 130  
131 131  To get details about the //AjaxExample// application :
132 132  
133 -[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
100 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
134 134  
135 135  And for a specific instance :
136 136  
137 -[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
104 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
138 138  
139 139  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  
... ... @@ -158,44 +158,76 @@
158 158  ///stop// : stop an application/instance the normal way.
159 159  ///start// : start an application/instance the normal way.
160 160  
128 +==== Automatic archive of SiteConfig.xml ====
129 +
130 +=== ===
131 +
132 +On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
133 +
134 +==== Simplified/Automated Bouncing ====
135 +
136 +=== ===
137 +
138 +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 :
139 +
140 +* Find the inactive (eg : not started) instance and start it
141 +* Find the active instances (minus the one started the step below) and enable "Refuse New Session"
142 +* Bounce the active instances when the minimum session count is reached
143 +
144 +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.
145 +
161 161  ==== Remote Control via REST Routes ====
162 162  
148 +=== ===
149 +
163 163  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.
164 164  
165 165  Examples of REST calls :
166 166  
167 -{{code title="Adding a New Host"}}
154 +Fetching the details of all applications :
168 168  
169 -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
156 +{{code}}
170 170  
158 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
159 +
171 171  {{/code}}
172 172  
173 -{{code title="Fetching Details for All Applications"}}
162 +Adding a new application :
174 174  
175 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
164 +{{code}}
176 176  
166 +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
167 +
177 177  {{/code}}
178 178  
179 -{{code title="Adding a New Application"}}
170 +Adding a new instance :
180 180  
181 -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
172 +{{code}}
182 182  
174 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
175 +
183 183  {{/code}}
184 184  
185 -{{code title="Delete an Application"}}
178 +Delete an application :
186 186  
187 -curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
180 +{{code}}
188 188  
182 +curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
183 +
189 189  {{/code}}
190 190  
191 -{{code title="Adding a New Instance"}}
186 +Delete an instance :
192 192  
193 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
188 +{{code}}
194 194  
190 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
191 +
195 195  {{/code}}
196 196  
197 -{{code title="Delete an Instance :"}}
194 +Adding a new host :
198 198  
199 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
196 +{{code}}
200 200  
198 +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
199 +
201 201  {{/code}}