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

Summary

Details

Page properties
Content
... ... @@ -1,20 +3,16 @@
1 -[[image:WonderJavaMonitor.png||border="1"]]
2 -
3 3  {{toc}}{{/toc}}
4 4  
5 5  === Introduction ===
6 6  
7 -JavaMonitor is a web-based tool used to configure and maintain deployed WebObjects applications. It is capable of handling multiple WebObjects applications, multiple instances of each application, and multiple WebObjects Applications Servers. In most cases you'll have one instance of JavaMonitor controlling all instances of your applications, even if they are spread across multiple Application Servers.
5 +WebObject's wotaskd and JavaMonitor deployment tools were open sourced in WebObjects 5.4. The source was then quickly modified and included in Project Wonder. Substantial improvements in both functionality and look-and-feel have been made over the years since their release as open source. These improved versions of **wotaskd.woa** and **JavaMonitor.woa** are available as full Wonder applications.
8 8  
9 -wotaskd (WebObjects task daemon) is the WebObjects Deployment tool that manages the instances on an Application Server. It's used by Monitor to propagate site configuration changes throughout the site's application hosts.
7 +[[image:WonderJavaMonitor.png||border="1"]]
10 10  
11 -Apple released the original wotaskd and JavaMonitor to the community as open source in WebObjects 5.4. The source was then quickly modified and included in Project Wonder. Substantial improvements in both functionality and look-and-feel have been made over the years. These improved versions of **wotaskd.woa** and **JavaMonitor.woa** are available as standard Wonder applications.
9 +=== Where to get them ===
12 12  
13 -=== Where To Get Them ===
14 -
15 15  You can either download them pre-built from [[Wonder's Hudson build server>>http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]] or build them from the source code.
16 16  
17 -To build them from the [[Wonder source code>>WONDER:Download Wonder Source, Build, Install and Upgrade]], simply run the following command from the Wonder directory at the root of the Wonder source.
13 +To build them from the source, simply run the following Command from the Wonder directory at the root of the Wonder source code directory:
18 18  
19 19  {{code}}
20 20  ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
... ... @@ -28,34 +28,16 @@
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}}
32 32  
33 -=== Major Improvements over Apple's versions ===
34 34  
35 -==== Automatic archive of SiteConfig.xml ====
29 +{{/info}}
36 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.
31 +=== Statistics ===
38 38  
39 -==== Simplified/Automated Bouncing ====
33 +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 :
40 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 :
35 +{{code}}
42 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}
59 59  (
60 60   {
61 61   "configuredInstances" = "2";
... ... @@ -90,90 +90,119 @@
90 90   "sumTransactions" = "1";
91 91   }
92 92  )
93 -{code}
94 94  
95 -If JavaMonitor is configured with a password, and I hope you do, pass _pw=monitorpassword_ as a argument to the query :
72 +{{/code}}
96 96  
97 -[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]
74 +If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
98 98  
99 -h4. Direct Actions to many tasks
76 +[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
100 100  
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.
78 +=== Direct Actions to many tasks ===
102 102  
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
80 +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.
106 106  
82 +//?type=all// : return details about all applications and instances
83 +//?type=app&name=AppName// : return details about all instances of a specific application
84 +//?type=ins&name=AppName-InstanceNo// : return details about one specific instance
85 +
107 107  For example, if you want to get details about all instances and applications, you call :
108 108  
109 -[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]
88 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
110 110  
111 -To get details about the _AjaxExample_ application :
90 +To get details about the //AjaxExample// application :
112 112  
113 -[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]
92 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
114 114  
115 115  And for a specific instance :
116 116  
117 -[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]
96 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
118 118  
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 :
98 +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 :
120 120  
121 -{code}
100 +{{code}}
101 +
122 122  [Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
123 -{code}
124 124  
104 +{{/code}}
105 +
125 125  List of available direct actions :
126 126  
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.
108 +///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
109 +///running// : return YES if the instance is running, NO if not.
110 +///stopped// : return NO if the instance is running, YES if not.
111 +///bounce//: more on it later.
112 +///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
113 +///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
114 +///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
115 +///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
116 +///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
117 +///stop// : stop an application/instance the normal way.
118 +///start// : start an application/instance the normal way.
138 138  
139 -h4. Remote Control via REST Routes
120 +=== Automatic archive of SiteConfig.xml ===
140 140  
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.
122 +On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
142 142  
124 +=== Bounce feature ===
125 +
126 +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 :
127 +
128 +* Find the inactive (eg : not started) instance and start it
129 +* Find the active instances (minus the one started the step below) and enable "Refuse New Session"
130 +* Bounce the active instances when the minimum session count is reached
131 +
132 +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.
133 +
134 +=== REST routes ===
135 +
136 +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.
137 +
143 143  Examples of REST calls :
144 144  
145 145  Fetching the details of all applications :
146 -{code}
141 +
142 +{{code}}
143 +
147 147  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
148 -{code}
149 149  
146 +{{/code}}
147 +
150 150  Adding a new application :
151 151  
152 -{code}
150 +{{code}}
151 +
153 153  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}
155 155  
154 +{{/code}}
155 +
156 156  Adding a new instance :
157 157  
158 -{code}
158 +{{code}}
159 +
159 159  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
160 -{code}
161 161  
162 +{{/code}}
163 +
162 162  Delete an application :
163 163  
164 -{code}
166 +{{code}}
167 +
165 165  curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
166 -{code}
167 167  
170 +{{/code}}
171 +
168 168  Delete an instance :
169 169  
170 -{code}
174 +{{code}}
175 +
171 171  curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
172 -{code}
173 173  
178 +{{/code}}
179 +
174 174  Adding a new host :
175 175  
176 -{code}
182 +{{code}}
183 +
177 177  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
178 178  
179 -{{/warning}}
186 +{{/code}}