Skip to Content
Version 111.1 by David Avendasora on 2010/11/29 20:24
Show last authors
1 [[image:WonderJavaMonitor.png||border="1"]]
2
3 {{toc}}{{/toc}}
4
5 === Introduction ===
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.
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.
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 {{/info}}
32
33 === Major Improvements over Apple's versions ===
34
35 ==== Automatic archive of SiteConfig.xml ====
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.
38
39 ==== Simplified/Automated Bouncing ====
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 :
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 (
60 {
61 "configuredInstances" = "2";
62 "maxSessions" = "0";
63 "maxAvgIdleTime" = "2.078";
64 "avgTransactions" = "44.0000";
65 "sumSessions" = "0";
66 "avgAvgTransactionTime" = "0.0985000";
67 "refusingInstances" = "0";
68 "avgSessions" = "0.0000";
69 "maxTransactions" = "88";
70 "applicationName" = "AjaxExample";
71 "avgAvgIdleTime" = "1.0390000";
72 "maxAvgTransactionTime" = "0.197";
73 "runningInstances" = "2";
74 "sumTransactions" = "88";
75 },
76 {
77 "configuredInstances" = "2";
78 "maxSessions" = "0";
79 "maxAvgIdleTime" = "325.443";
80 "avgTransactions" = "0.5000";
81 "sumSessions" = "0";
82 "avgAvgTransactionTime" = "0.00000";
83 "refusingInstances" = "0";
84 "avgSessions" = "0.0000";
85 "maxTransactions" = "1";
86 "applicationName" = "AjaxExample2";
87 "avgAvgIdleTime" = "162.7215000";
88 "maxAvgTransactionTime" = "0.0";
89 "runningInstances" = "2";
90 "sumTransactions" = "1";
91 }
92 )
93 {code}
94
95 If JavaMonitor is configured with a password, and I hope you do, pass _pw=monitorpassword_ as a argument to the query :
96
97 [http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]
98
99 h4. Direct Actions to many tasks
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.
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
106
107 For example, if you want to get details about all instances and applications, you call :
108
109 [http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]
110
111 To get details about the _AjaxExample_ application :
112
113 [http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]
114
115 And for a specific instance :
116
117 [http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]
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 :
120
121 {code}
122 [Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
123 {code}
124
125 List of available direct actions :
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.
138
139 h4. Remote Control via REST Routes
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.
142
143 Examples of REST calls :
144
145 Fetching the details of all applications :
146 {code}
147 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
148 {code}
149
150 Adding a new application :
151
152 {code}
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
156 Adding a new instance :
157
158 {code}
159 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
160 {code}
161
162 Delete an application :
163
164 {code}
165 curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
166 {code}
167
168 Delete an instance :
169
170 {code}
171 curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
172 {code}
173
174 Adding a new host :
175
176 {code}
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
179 {{/warning}}