Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 147.1
edited by Pascal Robert
on 2009/08/10 15:31
Change comment: There is no comment for this version
To version 130.1
edited by David Avendasora
on 2010/11/29 19:56
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.probert
1 +XWiki.avendasora
Content
... ... @@ -1,10 +1,40 @@
1 +[[image:WonderJavaMonitor.png||border="1"]]
2 +
3 +{{toc}}{{/toc}}
4 +
1 1  === Introduction ===
2 2  
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.
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.
4 4  
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.
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.
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 +
5 5  === Statistics ===
6 6  
7 -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 +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 :
8 8  
9 9  {{code}}
10 10  
... ... @@ -47,7 +47,7 @@
47 47  
48 48  If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
49 49  
50 -http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword
80 +[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
51 51  
52 52  === Direct Actions to many tasks ===
53 53  
... ... @@ -59,28 +59,21 @@
59 59  
60 60  For example, if you want to get details about all instances and applications, you call :
61 61  
62 -http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all
92 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
63 63  
64 64  To get details about the //AjaxExample// application :
65 65  
66 -http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample
96 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
67 67  
68 68  And for a specific instance :
69 69  
70 -http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1
100 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
71 71  
72 72  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 :
73 73  
74 74  {{code}}
75 75  
76 -[{"name": "AjaxExample", "id": "1", "host": "leopards.macti.lan", "port": "2001", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
77 - "transactions": "88", "activeSessions": "0", "averageIdlePeriod": "2.078", "avgTransactionTime": "0.197"},
78 -{"name": "AjaxExample", "id": "2", "host": "leopards.macti.lan", "port": "2002", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
79 -"transactions": "0", "activeSessions": "0", "averageIdlePeriod": "0.0", "avgTransactionTime": "0.0"},
80 -{"name": "AjaxExample2", "id": "1", "host": "leopards.macti.lan", "port": "2003", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
81 -"transactions": "0", "activeSessions": "0", "averageIdlePeriod": "0.0", "avgTransactionTime": "0.0"},
82 -{"name": "AjaxExample2", "id": "2", "host": "leopards.macti.lan", "port": "2004", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
83 -"transactions": "1", "activeSessions": "0", "averageIdlePeriod": "325.443", "avgTransactionTime": "0.0"}]
106 +[Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
84 84  
85 85  {{/code}}
86 86  
... ... @@ -93,7 +93,7 @@
93 93  ///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
94 94  ///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
95 95  ///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
96 -///turnAutoRecoverOn// : guess what? It activate "Auto recover"! And guess again? ///turnAutoRecoverOff// do the opposite!
119 +///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
97 97  ///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
98 98  ///stop// : stop an application/instance the normal way.
99 99  ///start// : start an application/instance the normal way.
... ... @@ -100,7 +100,7 @@
100 100  
101 101  === Automatic archive of SiteConfig.xml ===
102 102  
103 -On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
126 +On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
104 104  
105 105  === Bounce feature ===
106 106  
... ... @@ -112,12 +112,56 @@
112 112  
113 113  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.
114 114  
115 -=== Misc ===
138 +=== REST routes ===
116 116  
117 -wotaskd and JavaMonitor are now full Wonder applications, and needs Ajax.framework, ERExtensions.framework, ERJars.framework, JavaWOExtensions.framework and JavaMonitor.framework to work correctly. If you get wotaskd.woa and JavaMonitor.woa from the //Wonder-latest-Applications-54// archive, those frameworks are NOT embedded inside wotaskd.woa and JavaMonitor.woa, so either build them from source and embed the frameworks or copy the frameworks into the //appserver// user home (on OS X 10.5, it's in ///var/empty//).
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.
118 118  
119 -If you build everything from Wonder source, you can run :
142 +Examples of REST calls :
120 120  
144 +Fetching the details of all applications :
145 +
121 121  {{code}}
122 -ant deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
147 +
148 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
149 +
123 123  {{/code}}
151 +
152 +Adding a new application :
153 +
154 +{{code}}
155 +
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
157 +
158 +{{/code}}
159 +
160 +Adding a new instance :
161 +
162 +{{code}}
163 +
164 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
165 +
166 +{{/code}}
167 +
168 +Delete an application :
169 +
170 +{{code}}
171 +
172 +curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
173 +
174 +{{/code}}
175 +
176 +Delete an instance :
177 +
178 +{{code}}
179 +
180 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
181 +
182 +{{/code}}
183 +
184 +Adding a new host :
185 +
186 +{{code}}
187 +
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 +
190 +{{/code}}