Changes for page Wonder JavaMonitor and wotaskd

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,16 +1,20 @@
	1	+[[image:WonderJavaMonitor.png||border="1"]]
	2	+
1	1	{{toc}}{{/toc}}
2	2
3	3	=== Introduction ===
4	4
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.
	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.
6	6
7		-[[image:WonderJavaMonitor.png||border="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.
8	8
9		-=== Where to get them ===
	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.
10	10
	13	+=== Where To Get Them ===
	14	+
11	11	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.
12	12
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:
	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.
14	14
15	15	{{code}}
16	16	ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
...	...	@@ -24,16 +24,36 @@
24	24	* *\-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.
25	25	* *\-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.
26	26
	31	+{{/info}}
27	27
	33	+=== Major Improvements over Apple's versions ===
28	28
29		-{{/info}}
	35	+==== Automatic archive of SiteConfig.xml ====
30	30
31		-=== Statistics ===
	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.
32	32
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 :
	39	+==== Simplified/Automated Bouncing ====
34	34
35		-{{code}}
	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 :
36	36
	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	+
	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	+
37	37	(
38	38	{
39	39	"configuredInstances" = "2";
...	...	@@ -73,9 +73,9 @@
73	73
74	74	If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
75	75
76		-[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
	100	+##http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword##
77	77
78		-=== Direct Actions to many tasks ===
	102	+==== Direct Actions to many tasks ====
79	79
80	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.
81	81
...	...	@@ -117,70 +117,44 @@
117	117	///stop// : stop an application/instance the normal way.
118	118	///start// : start an application/instance the normal way.
119	119
120		-=== Automatic archive of SiteConfig.xml ===
	144	+==== Remote Control via REST Routes ====
121	121
122		-On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
123		-
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	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	137
138	138	Examples of REST calls :
139	139
140		-Fetching the details of all applications :
	150	+{{code title="Adding a New Host"}}
141	141
142		-{{code}}
	152	+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
143	143
144		-curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
145		-
146	146	{{/code}}
147	147
148		-Adding a new application :
	156	+{{code title="Fetching Details for All Applications"}}
149	149
150		-{{code}}
	158	+curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
151	151
152		-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
153		-
154	154	{{/code}}
155	155
156		-Adding a new instance :
	162	+{{code title="Adding a New Application"}}
157	157
158		-{{code}}
	164	+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
159	159
160		-curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
161		-
162	162	{{/code}}
163	163
164		-Delete an application :
	168	+{{code title="Delete an Application"}}
165	165
166		-{{code}}
167		-
168	168	curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
169	169
170	170	{{/code}}
171	171
172		-Delete an instance :
	174	+{{code title="Adding a New Instance"}}
173	173
174		-{{code}}
	176	+curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
175	175
176		-curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
177		-
178	178	{{/code}}
179	179
180		-Adding a new host :
	180	+{{code title="Delete an Instance :"}}
181	181
182		-{{code}}
	182	+curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
183	183
184		-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
185		-
186	186	{{/code}}