Skip to Content
Version 103.1 by David Avendasora on 2010/11/29 21:39
Hide last authors
David Avendasora 77.1 1 [[image:WonderJavaMonitor.png||border="1"]]
2
3 {{toc}}{{/toc}}
4
Pascal Robert 57.1 5 === Introduction ===
6
David Avendasora 77.1 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.
Pascal Robert 57.1 8
David Avendasora 77.1 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.
Pascal Robert 57.1 10
David Avendasora 77.1 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.
Pascal Robert 57.1 12
David Avendasora 77.1 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
Pascal Robert 57.1 19 {{code}}
David Avendasora 77.1 20 ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
21 {{/code}}
Pascal Robert 57.1 22
David Avendasora 77.1 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
David Avendasora 83.1 33 === Major Improvements over Apple's versions ===
David Avendasora 77.1 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 (i.e., not started) instance and start it
44 * Find the active instances (minus the one started in the previous step) 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
53 {{/warning}}
54
55 ==== Statistics ====
56
57 If you call ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics]]##, JavaMonitor will send you back statistics, in JSON format, about instances, per application.
58
59 {{code title="Statistics Example Results"}}
60
Pascal Robert 57.1 61 (
62 {
63 "configuredInstances" = "2";
64 "maxSessions" = "0";
65 "maxAvgIdleTime" = "2.078";
66 "avgTransactions" = "44.0000";
67 "sumSessions" = "0";
68 "avgAvgTransactionTime" = "0.0985000";
69 "refusingInstances" = "0";
70 "avgSessions" = "0.0000";
71 "maxTransactions" = "88";
72 "applicationName" = "AjaxExample";
73 "avgAvgIdleTime" = "1.0390000";
74 "maxAvgTransactionTime" = "0.197";
75 "runningInstances" = "2";
76 "sumTransactions" = "88";
77 },
78 {
79 "configuredInstances" = "2";
80 "maxSessions" = "0";
81 "maxAvgIdleTime" = "325.443";
82 "avgTransactions" = "0.5000";
83 "sumSessions" = "0";
84 "avgAvgTransactionTime" = "0.00000";
85 "refusingInstances" = "0";
86 "avgSessions" = "0.0000";
87 "maxTransactions" = "1";
88 "applicationName" = "AjaxExample2";
89 "avgAvgIdleTime" = "162.7215000";
90 "maxAvgTransactionTime" = "0.0";
91 "runningInstances" = "2";
92 "sumTransactions" = "1";
93 }
94 )
95
96 {{/code}}
97
Pascal Robert 59.1 98 If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
Pascal Robert 57.1 99
David Avendasora 77.1 100 ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]##
Pascal Robert 57.1 101
David Avendasora 101.1 102 ==== Direct Actions for Management Tasks ====
Pascal Robert 57.1 103
David Avendasora 101.1 104 You can do most of the standard management tasks you'd normally do in JavaMonitor's web UI by calling standard WebObjects Direct Actions. Instead of using the ##/wa/## request handler though, these management tasks use a new ##/admin/## request handler. These Direct Actions can be very useful, especially if you need to restart instances or other do tasks from the command line, from within Ant or other build or deployment systems.
Pascal Robert 57.1 105
David Avendasora 101.1 106 List of available direct actions :
107
108 * **##info##** : returns the details (number of deaths, state, etc.; see example above), in JavaScript Object Notation (JSON)
109 ** **##?type=all##** : Returns details about all instances of all applications
David Avendasora 103.1 110 ** **##?type=app&name=##**{{color value="blue"}}{{AppName}}{{/color}} : Returns details about all instances of a specific application
111 ** **##?type=ins&name={{color value="blue"}}{{AppName}}{{/color}}-{{color value="blue"}}{{InstanceNumber}}{{/color}}##** : Returns details about one specific instance
David Avendasora 101.1 112 * **##running##** : Returns **##YES##** or **##NO##**
113 * **##stopped##** : return NO if the instance is running, YES if not.
114 * **##bounce##** : more on it later.
115 * **##clearDeaths##** : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
116 * **##turnScheduledOn##** : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
117 * **##turnRefuseNewSessionsOn##** : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
118 * **##turnAutoRecoverOn##** : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
119 * **##forceQuit##** : force quit an application, might be useful to call it from a monitoring system.
120 * **##stop##** : stop an application/instance the normal way.
121 * **##start##** : start an application/instance the normal way.
122
David Avendasora 97.1 123 ##?type=all## : returns details about all applications and instances
124 ##?type=app&name=AppName## : returns details about all instances of a specific application
125 ##?type=ins&name=AppName-InstanceNo## : returns details about one specific instance
Pascal Robert 57.1 126
David Avendasora 97.1 127 For example, if you want to get details about all instances and applications, you call :
Pascal Robert 57.1 128
David Avendasora 97.1 129 [[http://monitorhost:port9/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
Pascal Robert 57.1 130
David Avendasora 97.1 131 To get details about the //AjaxExample// application :
Pascal Robert 57.1 132
David Avendasora 97.1 133 [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
Pascal Robert 57.1 134
David Avendasora 97.1 135 And for a specific instance :
Pascal Robert 57.1 136
David Avendasora 97.1 137 [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
Pascal Robert 57.1 138
David Avendasora 77.1 139 ==== Remote Control via REST Routes ====
140
David Avendasora 97.1 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.
David Avendasora 77.1 142
143 Examples of REST calls :
144
145 {{code title="Adding a New Host"}}
146
David Avendasora 91.1 147 curl -X POST -d "{id: 'otherserver.com',type: 'MHost', osType: 'MACOSX',address: '192.168.20.5', name: 'otherserver.com'}" http://monitorhost:port/apps/WebObjects/JavaMonitor.woa/ra/mHosts.json
David Avendasora 77.1 148
Pascal Robert 57.1 149 {{/code}}
150
David Avendasora 77.1 151 {{code title="Fetching Details for All Applications"}}
Pascal Robert 57.1 152
David Avendasora 77.1 153 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
154
155 {{/code}}
156
157 {{code title="Adding a New Application"}}
158
159 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://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
160
161 {{/code}}
162
163 {{code title="Delete an Application"}}
164
165 curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
166
167 {{/code}}
168
169 {{code title="Adding a New Instance"}}
170
171 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
172
173 {{/code}}
174
175 {{code title="Delete an Instance :"}}
176
177 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
178
179 {{/code}}