Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 120.1
edited by David Avendasora
on 2010/11/29 20:09
Change comment: There is no comment for this version
To version 137.1
edited by David Holt
on 2010/11/26 21:52
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.avendasora
1 +XWiki.dholt
Content
... ... @@ -1,61 +5,11 @@
1 -[[image:WonderJavaMonitor.png||border="1"]]
2 -
3 -{{toc}}{{/toc}}
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.
3 +wotaskd and JavaMonitor were open sourced when WebObjects 5.4 was released in 2007. In 2008 and 2009, the source was modified and included in Project Wonder. This is the list of additions that were added to the Wonder versions of the tools.
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.
5 +[[image:LaunchBarScreenSnapz001.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.
7 +=== Statistics ===
12 12  
13 -=== Where To Get Them ===
14 -
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 -
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.
18 -
19 -{{code}}
20 -ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
21 -{{/code}}
22 -
23 -{{info title="What this command does:"}}
24 -
25 -* *ant*: calls Apache Ant. It is assumed that you have this already installed.
26 -* *frameworks*: tells Ant to build the "frameworks" target. This may not be needed if you already have Wonder built and installed in a location Ant can find automatically.
27 -* *deployment.tools*: tells Ant to build the "deployment.tools" target. This is the target that builds both wotaskd.woa and JavaMonitor.woa. You absolutely need this one.
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 -* *\-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 -
31 -
32 -
33 -{{/info}}
34 -
35 -=== Major Improvements over Apple's versions ===
36 -
37 -==== Automatic archive of SiteConfig.xml ====
38 -
39 -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 -
41 -==== Simplified/Automated Bouncing ====
42 -
43 -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 :
44 -
45 -* Find the inactive (eg : not started) instance and start it
46 -* Find the active instances (minus the one started the step below) and enable "Refuse New Session"
47 -* Bounce the active instances when the minimum session count is reached
48 -
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 -
51 -{{note}}
52 -
53 -How this will work if your new version uses ERXMigrations to change your schema (e.g., The old instances might raise exceptions because the database schema changed), so try it out on a test server first and then update this page so everyone knows!
54 -
55 -{{/note}}
56 -
57 -==== Statistics ====
58 -
59 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 60  
61 61  {{code}}
... ... @@ -101,7 +101,7 @@
101 101  
102 102  [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
103 103  
104 -==== Direct Actions to many tasks ====
54 +=== Direct Actions to many tasks ===
105 105  
106 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.
107 107  
... ... @@ -143,8 +143,22 @@
143 143  ///stop// : stop an application/instance the normal way.
144 144  ///start// : start an application/instance the normal way.
145 145  
146 -==== Remote Control via REST Routes ====
96 +=== Automatic archive of SiteConfig.xml ===
147 147  
98 +On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
99 +
100 +=== Bounce feature ===
101 +
102 +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 :
103 +
104 +* Find the inactive (eg : not started) instance and start it
105 +* Find the active instances (minus the one started the step below) and enable "Refuse New Session"
106 +* Bounce the active instances when the minimum session count is reached
107 +
108 +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.
109 +
110 +=== REST routes ===
111 +
148 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.
149 149  
150 150  Examples of REST calls :
... ... @@ -196,3 +196,21 @@
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 198  {{/code}}
163 +
164 +=== Misc ===
165 +
166 +The community's improved versions of **wotaskd.woa** and **JavaMonitor.woa** are now available as full Wonder applications. You can download them pre-built from the [[Hudson Wonder build server>>http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]].
167 +
168 +Alternatively you can build them from Wonder source and embed the frameworks or copy the frameworks into the //appserver// user home (on OS X 10.5, it's in ///var/empty//).
169 +
170 +If you build everything from Wonder source, you can run :
171 +
172 +{{code}}
173 +ant deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
174 +{{/code}}
175 +
176 +Please note that you have to build the Wonder before calling //ant deployment.tools//, if you get classpath errors when building the deployment tools, first run:
177 +
178 +{{code}}
179 +ant frameworks
180 +{{/code}}