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

Summary

Details

Page properties
Content
... ... @@ -28,8 +28,6 @@
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 -
33 33  {{/info}}
34 34  
35 35  === Major Improvements over Apple's versions ===
... ... @@ -48,18 +48,16 @@
48 48  
49 49  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.
50 50  
51 -{{note title="ERXMigrations"}}
49 +{{warning title="Database Changes"}}
52 52  
53 -How this works is uncertain if the new version of your application uses ERXMigrations to change your schema (e.g., The old instances might raise exceptions because the database schema changed). *Try it out on a test server first and then update this page so everyone knows\!*
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 +{note}
54 54  
55 -{{/note}}
54 +h4. Statistics
56 56  
57 -==== Statistics ====
56 +If you call {noformat:nopanel=true}http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics{noformat}, JavaMonitor will send you back statistics, in JSON format, about instances, per application.
58 58  
59 -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 :
60 -
61 -{{code}}
62 -
58 +{code:title=Statistics Example Results}
63 63  (
64 64   {
65 65   "configuredInstances" = "2";
... ... @@ -94,105 +94,90 @@
94 94   "sumTransactions" = "1";
95 95   }
96 96  )
93 +{code}
97 97  
98 -{{/code}}
95 +If JavaMonitor is configured with a password, and I hope you do, pass _pw=monitorpassword_ as a argument to the query :
99 99  
100 -If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
97 +[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]
101 101  
102 -[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
99 +h4. Direct Actions to many tasks
103 103  
104 -==== Direct Actions to many tasks ====
101 +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 -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.
103 +_?type=all_ : return details about all applications and instances
104 +_?type=app&name=AppName_ : return details about all instances of a specific application
105 +_?type=ins&name=AppName-InstanceNo_ : return details about one specific instance
107 107  
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
111 -
112 112  For example, if you want to get details about all instances and applications, you call :
113 113  
114 -[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
109 +[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]
115 115  
116 -To get details about the //AjaxExample// application :
111 +To get details about the _AjaxExample_ application :
117 117  
118 -[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
113 +[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]
119 119  
120 120  And for a specific instance :
121 121  
122 -[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
117 +[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]
123 123  
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 :
119 +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 125  
126 -{{code}}
127 -
121 +{code}
128 128  [Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
123 +{code}
129 129  
130 -{{/code}}
131 -
132 132  List of available direct actions :
133 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.
127 +_/info_ : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
128 +_/running_ : return YES if the instance is running, NO if not.
129 +_/stopped_ : return NO if the instance is running, YES if not.
130 +_/bounce_: more on it later.
131 +_/clearDeaths_ : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
132 +_/turnScheduledOn_ : turn scheduling on for an application or instance. Call _/turnScheduledOff_ to do the opposite.
133 +_/turnRefuseNewSessionsOn_ : turn "Refuse new sessions" on, call _turnRefuseNewSessionsOff_ to do the opposite.
134 +_/turnAutoRecoverOn_ : guess what? It activate "Auto recover"\! And guess again? _/turnAutoRecoverOff_ do the opposite\!
135 +_/forceQuit_ : force quit an application, might be useful to call it from a monitoring system.
136 +_/stop_ : stop an application/instance the normal way.
137 +_/start_ : start an application/instance the normal way.
145 145  
146 -==== Remote Control via REST Routes ====
139 +h4. Remote Control via REST Routes
147 147  
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.
141 +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.
149 149  
150 150  Examples of REST calls :
151 151  
152 152  Fetching the details of all applications :
153 -
154 -{{code}}
155 -
146 +{code}
156 156  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
148 +{code}
157 157  
158 -{{/code}}
159 -
160 160  Adding a new application :
161 161  
162 -{{code}}
163 -
152 +{code}
164 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
154 +{code}
165 165  
166 -{{/code}}
167 -
168 168  Adding a new instance :
169 169  
170 -{{code}}
171 -
158 +{code}
172 172  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
160 +{code}
173 173  
174 -{{/code}}
175 -
176 176  Delete an application :
177 177  
178 -{{code}}
179 -
164 +{code}
180 180  curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
166 +{code}
181 181  
182 -{{/code}}
183 -
184 184  Delete an instance :
185 185  
186 -{{code}}
187 -
170 +{code}
188 188  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
172 +{code}
189 189  
190 -{{/code}}
191 -
192 192  Adding a new host :
193 193  
194 -{{code}}
195 -
176 +{code}
196 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 197  
198 -{{/code}}
179 +{{/warning}}