Changes for page Wonder JavaMonitor and wotaskd

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Project Wonder additions to wotaskd and JavaMonitor
	1	+Wonder JavaMonitor and wotaskd

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.dholt
	1	+XWiki.simon

Content

...	...	@@ -1,15 +1,70 @@
	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
5		-[[image:LaunchBarScreenSnapz001.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.
6	6
7		-=== Statistics ===
	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.
8	8
9		-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 :
	13	+=== Where To Get Them ===
10	10
	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	+
11	11	{{code}}
	20	+ant frameworks deployment.tools -Dwonder.patch=54 -Ddeployment.standalone=true
	21	+{{/code}}
12	12
	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	+=== Bug Fixes to Apple's Versions ===
	34	+
	35	+==== JavaMonitor ====
	36	+
	37	+* Fixes an issue with the Application Delete page
	38	+* Selection in Application Detail page is now Ajax and is maintained
	39	+
	40	+=== Improvements to Apple's versions ===
	41	+
	42	+==== Automatic archive of SiteConfig.xml ====
	43	+
	44	+On every change you make to an application's configuration, a backup of SiteConfig.xml will be created in, by default, /Library/WebObjects/Configuration.
	45	+
	46	+==== Simplified/Automated Bouncing ====
	47	+
	48	+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 :
	49	+
	50	+* Find the inactive (i.e., not started) instance and start it
	51	+* Find the active instances (minus the one started in the previous step) and enable "Refuse New Session"
	52	+* Bounce the active instances when the minimum session count is reached
	53	+
	54	+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.
	55	+
	56	+{{warning title="Database Changes"}}
	57	+
	58	+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\!*
	59	+
	60	+{{/warning}}
	61	+
	62	+==== Statistics ====
	63	+
	64	+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.
	65	+
	66	+{{code title="Statistics Example Results"}}
	67	+
13	13	(
14	14	{
15	15	"configuredInstances" = "2";
...	...	@@ -49,132 +49,136 @@
49	49
50	50	If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
51	51
52		-[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
	107	+##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]##
53	53
54		-=== Direct Actions to many tasks ===
	109	+==== Direct Actions for Management Tasks ====
55	55
56		-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.
	111	+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.
57	57
58		-//?type=all// : return details about all applications and instances
59		-//?type=app&name=AppName// : return details about all instances of a specific application
60		-//?type=ins&name=AppName-InstanceNo// : return details about one specific instance
	113	+List of available direct actions :
61	61
62		-For example, if you want to get details about all instances and applications, you call :
	115	+* {{{*}info{*}}} : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified
	116	+##info?##{{{}{*}type=all{*}}}
	117	+##info?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	118	+##info?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
63	63
64		-[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
	120	+* {{{*}running{*}}} : Returns {{{*}YES{*}}} if **all** of the specified are running, ##NO## if not
	121	+##running?##{{{}{*}type=all{*}}}
	122	+##running?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	123	+##running?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
65	65
66		-To get details about the //AjaxExample// application :
	125	+* {{{*}stopped{*}}} : Returns {{{*}YES{*}}} if **all** the specified is running, {{{*}NO{*}}} if not.
	126	+##stopped?##{{{}{*}type=all{*}}}
	127	+##stopped?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	128	+##stopped?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
67	67
68		-[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
	130	+* {{{*}bounce{*}}} : Returns {{{*}OK{*}}} after Bouncing (see description above) as specified
	131	+##bounce?##{{{}{*}type=all{*}}}
	132	+##bounce?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
69	69
70		-And for a specific instance :
	134	+* {{{*}clearDeaths{*}}} : Returns {{{*}OK{*}}} after clearing deaths as specified
	135	+##clearDeaths?##{{{}{*}type=all{*}}}
	136	+##clearDeaths?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
71	71
72		-[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
	138	+* {{{*}turnScheduledOn{*}}} : Returns {{{*}OK{*}}} after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.
	139	+##turnScheduledOn?##{{{}{*}type=all{*}}}
	140	+##turnScheduledOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	141	+##turnScheduledOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
73	73
74		-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 :
	143	+* {{{*}turnRefuseNewSessionsOn{*}}} : Returns {{{*}OK{*}}} after turning on "Refuse new sessions" as specified
	144	+##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
	145	+##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	146	+##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
75	75
76		-{{code}}
	148	+* {{{*}turnRefuseNewSessionsOff{*}}} : Returns {{{*}OK{*}}} after turning off "Refuse new sessions" as specified
	149	+##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
	150	+##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	151	+##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
77	77
78		-[Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
	153	+* {{{*}turnAutoRecoverOn{*}}} : Returns {{{*}OK{*}}} after turning on "Auto Recover" as specified
	154	+##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
	155	+##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	156	+##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
79	79
80		-{{/code}}
	158	+* {{{*}turnAutoRecoverOff{*}}} : Returns {{{*}OK{*}}} after turning off "Auto Recover" as specified
	159	+##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
	160	+##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	161	+##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
81	81
82		-List of available direct actions :
	163	+* {{{*}forceQuit{*}}} : Returns {{{*}OK{*}}} after force quitting as specified. This could be useful to call from a monitoring system.
	164	+##forceQuit?##{{{}{*}type=all{*}}}
	165	+##forceQuit?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	166	+##forceQuit?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
83	83
84		-///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
85		-///running// : return YES if the instance is running, NO if not.
86		-///stopped// : return NO if the instance is running, YES if not.
87		-///bounce//: more on it later.
88		-///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
89		-///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
90		-///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
91		-///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
92		-///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
93		-///stop// : stop an application/instance the normal way.
94		-///start// : start an application/instance the normal way.
	168	+* {{{*}stop{*}}} : Returns {{{*}OK{*}}} after calling "Stop" as specified
	169	+##stop?##{{{}{*}type=all{*}}}
	170	+##stop?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	171	+##stop?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
95	95
96		-=== Automatic archive of SiteConfig.xml ===
	173	+* {{{*}start{*}}} : Returns {{{*}OK{*}}} after calling "Start" as specified
	174	+##start?##{{{}{*}type=all{*}}}
	175	+##start?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
	176	+##start?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
97	97
98		-On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
	178	+To get details about all instances of all applications:
	179	+##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]##
99	99
100		-=== Bounce feature ===
	181	+To get details about the **AjaxExample** application:
	182	+##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]##
101	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 :
	184	+To get details about instance **1** of the **AjaxExample** application:
	185	+##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]##
103	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
	187	+==== Remote Control via REST Routes ====
107	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.
	189	+If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via [[REST>>WONDER:ERRest Framework]] calls. Between the two methods (Direct Actions, REST) you have almost full remote-control of JavaMonitor. Just make sure that your JavaMonitor installation is secure Just like with Direct Actions, you need to append ##?pw=XXXX## to the URLs if your JavaMonitor is password protected.
109	109
110		-=== REST routes ===
111		-
112		-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.
113		-
114	114	Examples of REST calls :
115	115
116		-Fetching the details of all applications :
	193	+{{code title="Adding a New Host"}}
117	117
118		-{{code}}
	195	+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
119	119
120		-curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
121		-
122	122	{{/code}}
123	123
124		-Adding a new application :
	199	+{{code title="Fetching Details for All Applications"}}
125	125
126		-{{code}}
	201	+curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
127	127
128		-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
129		-
130	130	{{/code}}
131	131
132		-Adding a new instance :
	205	+{{code title="Adding a New Application"}}
133	133
134		-{{code}}
	207	+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
135	135
136		-curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
137		-
138	138	{{/code}}
139	139
140		-Delete an application :
	211	+{{code title="Delete an Application"}}
141	141
142		-{{code}}
	213	+curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
143	143
144		-curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
145		-
146	146	{{/code}}
147	147
148		-Delete an instance :
	217	+{{code title="Adding a New Instance"}}
149	149
150		-{{code}}
	219	+curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
151	151
152		-curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
153		-
154	154	{{/code}}
155	155
156		-Adding a new host :
	223	+{{code title="Delete an Instance"}}
157	157
158		-{{code}}
	225	+curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
159	159
160		-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
161		-
162	162	{{/code}}
163	163
164		-=== Misc ===
	229	+{{code title="Configuring the Site"}}
165	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/]].
	231	+curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json
167	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	174	{{/code}}
175	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:
	235	+Note that before configuring the site you must first add a host. If you attempt to configure the site prior to adding a host you will get an InvalidStateException.
177	177
178		-{{code}}
179		-ant frameworks
180		-{{/code}}
	237	+=== Troubleshooting ===
	238	+
	239	+If JavaMonitor did not start on your fresh install of WebObjects, check out the [[WOTaskd Didn't Start>>WO:Troubleshooting Deployment]] question in the troubleshooting section.