Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 116.1
edited by David Avendasora
on 2010/11/29 20:01
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,18 +28,34 @@
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 ===
36 36  
37 -==== Statistics ====
35 +==== Automatic archive of SiteConfig.xml ====
38 38  
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 :
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.
40 40  
41 -{{code}}
39 +==== Simplified/Automated Bouncing ====
42 42  
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 (eg : not started) instance and start it
44 +* Find the active instances (minus the one started the step below) 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 +{note}
53 +
54 +h4. Statistics
55 +
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.
57 +
58 +{code:title=Statistics Example Results}
43 43  (
44 44   {
45 45   "configuredInstances" = "2";
... ... @@ -74,127 +74,90 @@
74 74   "sumTransactions" = "1";
75 75   }
76 76  )
93 +{code}
77 77  
78 -{{/code}}
95 +If JavaMonitor is configured with a password, and I hope you do, pass _pw=monitorpassword_ as a argument to the query :
79 79  
80 -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]
81 81  
82 -[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
99 +h4. Direct Actions to many tasks
83 83  
84 -==== 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.
85 85  
86 -=== ===
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
87 87  
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.
89 -
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
93 -
94 94  For example, if you want to get details about all instances and applications, you call :
95 95  
96 -[[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]
97 97  
98 -To get details about the //AjaxExample// application :
111 +To get details about the _AjaxExample_ application :
99 99  
100 -[[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]
101 101  
102 102  And for a specific instance :
103 103  
104 -[[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]
105 105  
106 -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 :
107 107  
108 -{{code}}
109 -
121 +{code}
110 110  [Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
123 +{code}
111 111  
112 -{{/code}}
113 -
114 114  List of available direct actions :
115 115  
116 -///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
117 -///running// : return YES if the instance is running, NO if not.
118 -///stopped// : return NO if the instance is running, YES if not.
119 -///bounce//: more on it later.
120 -///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
121 -///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
122 -///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
123 -///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
124 -///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
125 -///stop// : stop an application/instance the normal way.
126 -///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.
127 127  
128 -==== Automatic archive of SiteConfig.xml ====
139 +h4. Remote Control via REST Routes
129 129  
130 -=== ===
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.
131 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 -
146 -==== Remote Control via REST Routes ====
147 -
148 -=== ===
149 -
150 -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.
151 -
152 152  Examples of REST calls :
153 153  
154 154  Fetching the details of all applications :
155 -
156 -{{code}}
157 -
146 +{code}
158 158  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
148 +{code}
159 159  
160 -{{/code}}
161 -
162 162  Adding a new application :
163 163  
164 -{{code}}
165 -
152 +{code}
166 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
154 +{code}
167 167  
168 -{{/code}}
169 -
170 170  Adding a new instance :
171 171  
172 -{{code}}
173 -
158 +{code}
174 174  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
160 +{code}
175 175  
176 -{{/code}}
177 -
178 178  Delete an application :
179 179  
180 -{{code}}
181 -
164 +{code}
182 182  curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
166 +{code}
183 183  
184 -{{/code}}
185 -
186 186  Delete an instance :
187 187  
188 -{{code}}
189 -
170 +{code}
190 190  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
172 +{code}
191 191  
192 -{{/code}}
193 -
194 194  Adding a new host :
195 195  
196 -{{code}}
197 -
176 +{code}
198 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 199  
200 -{{/code}}
179 +{{/warning}}