Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 113.1
edited by David Avendasora
on 2010/11/29 19:56
Change comment: There is no comment for this version
To version 111.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,16 +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 +{{/info}}
31 31  
33 +=== Major Improvements over Apple's versions ===
32 32  
33 -{{/info}}
35 +==== Automatic archive of SiteConfig.xml ====
34 34  
35 -=== Statistics ===
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.
36 36  
37 -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 :
39 +==== Simplified/Automated Bouncing ====
38 38  
39 -{{code}}
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 :
40 40  
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}
41 41  (
42 42   {
43 43   "configuredInstances" = "2";
... ... @@ -72,119 +72,90 @@
72 72   "sumTransactions" = "1";
73 73   }
74 74  )
93 +{code}
75 75  
76 -{{/code}}
95 +If JavaMonitor is configured with a password, and I hope you do, pass _pw=monitorpassword_ as a argument to the query :
77 77  
78 -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]
79 79  
80 -[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
99 +h4. Direct Actions to many tasks
81 81  
82 -=== 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.
83 83  
84 -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
85 85  
86 -//?type=all// : return details about all applications and instances
87 -//?type=app&name=AppName// : return details about all instances of a specific application
88 -//?type=ins&name=AppName-InstanceNo// : return details about one specific instance
89 -
90 90  For example, if you want to get details about all instances and applications, you call :
91 91  
92 -[[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]
93 93  
94 -To get details about the //AjaxExample// application :
111 +To get details about the _AjaxExample_ application :
95 95  
96 -[[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]
97 97  
98 98  And for a specific instance :
99 99  
100 -[[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]
101 101  
102 -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 :
103 103  
104 -{{code}}
105 -
121 +{code}
106 106  [Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
123 +{code}
107 107  
108 -{{/code}}
109 -
110 110  List of available direct actions :
111 111  
112 -///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
113 -///running// : return YES if the instance is running, NO if not.
114 -///stopped// : return NO if the instance is running, YES if not.
115 -///bounce//: more on it later.
116 -///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
117 -///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
118 -///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
119 -///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
120 -///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
121 -///stop// : stop an application/instance the normal way.
122 -///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.
123 123  
124 -=== Automatic archive of SiteConfig.xml ===
139 +h4. Remote Control via REST Routes
125 125  
126 -On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
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.
127 127  
128 -=== Bounce feature ===
129 -
130 -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 :
131 -
132 -* Find the inactive (eg : not started) instance and start it
133 -* Find the active instances (minus the one started the step below) and enable "Refuse New Session"
134 -* Bounce the active instances when the minimum session count is reached
135 -
136 -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.
137 -
138 -=== REST routes ===
139 -
140 -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 -
142 142  Examples of REST calls :
143 143  
144 144  Fetching the details of all applications :
145 -
146 -{{code}}
147 -
146 +{code}
148 148  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
148 +{code}
149 149  
150 -{{/code}}
151 -
152 152  Adding a new application :
153 153  
154 -{{code}}
155 -
152 +{code}
156 156  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}
157 157  
158 -{{/code}}
159 -
160 160  Adding a new instance :
161 161  
162 -{{code}}
163 -
158 +{code}
164 164  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
160 +{code}
165 165  
166 -{{/code}}
167 -
168 168  Delete an application :
169 169  
170 -{{code}}
171 -
164 +{code}
172 172  curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
166 +{code}
173 173  
174 -{{/code}}
175 -
176 176  Delete an instance :
177 177  
178 -{{code}}
179 -
170 +{code}
180 180  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
172 +{code}
181 181  
182 -{{/code}}
183 -
184 184  Adding a new host :
185 185  
186 -{{code}}
187 -
176 +{code}
188 188  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
189 189  
190 -{{/code}}
179 +{{/warning}}