Changes for page Wonder JavaMonitor and wotaskd

Summary

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

Details

Page properties

Content

...	...	@@ -28,6 +28,8 @@
28	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	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	30
	31	+
	32	+
31	31	{{/info}}
32	32
33	33	=== Major Improvements over Apple's versions ===
...	...	@@ -46,16 +46,18 @@
46	46
47	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	48
49		-{{warning title="Database Changes"}}
	51	+{{note title="ERXMigrations"}}
50	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	+How this works is uncertain if the new version of your application uses ERXMigrations to change your schema (e.g., The old instances might raise exceptions because the database schema changed). *Try it out on a test server first and then update this page so everyone knows\!*
53	53
54		-h4. Statistics
	55	+{{/note}}
55	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	+==== Statistics ====
57	57
58		-{code:title=Statistics Example Results}
	59	+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 :
	60	+
	61	+{{code}}
	62	+
59	59	(
60	60	{
61	61	"configuredInstances" = "2";
...	...	@@ -90,90 +90,105 @@
90	90	"sumTransactions" = "1";
91	91	}
92	92	)
93		-{code}
94	94
95		-If JavaMonitor is configured with a password, and I hope you do, pass _pw=monitorpassword_ as a argument to the query :
	98	+{{/code}}
96	96
97		-[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]
	100	+If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
98	98
99		-h4. Direct Actions to many tasks
	102	+[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
100	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.
	104	+==== Direct Actions to many tasks ====
102	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	+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.
106	106
	108	+//?type=all// : return details about all applications and instances
	109	+//?type=app&name=AppName// : return details about all instances of a specific application
	110	+//?type=ins&name=AppName-InstanceNo// : return details about one specific instance
	111	+
107	107	For example, if you want to get details about all instances and applications, you call :
108	108
109		-[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]
	114	+[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
110	110
111		-To get details about the _AjaxExample_ application :
	116	+To get details about the //AjaxExample// application :
112	112
113		-[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]
	118	+[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
114	114
115	115	And for a specific instance :
116	116
117		-[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]
	122	+[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
118	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 :
	124	+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	120
121		-{code}
	126	+{{code}}
	127	+
122	122	[Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
123		-{code}
124	124
	130	+{{/code}}
	131	+
125	125	List of available direct actions :
126	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.
	134	+///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
	135	+///running// : return YES if the instance is running, NO if not.
	136	+///stopped// : return NO if the instance is running, YES if not.
	137	+///bounce//: more on it later.
	138	+///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
	139	+///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
	140	+///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
	141	+///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
	142	+///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
	143	+///stop// : stop an application/instance the normal way.
	144	+///start// : start an application/instance the normal way.
138	138
139		-h4. Remote Control via REST Routes
	146	+==== Remote Control via REST Routes ====
140	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.
	148	+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	142
143	143	Examples of REST calls :
144	144
145	145	Fetching the details of all applications :
146		-{code}
	153	+
	154	+{{code}}
	155	+
147	147	curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
148		-{code}
149	149
	158	+{{/code}}
	159	+
150	150	Adding a new application :
151	151
152		-{code}
	162	+{{code}}
	163	+
153	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	155
	166	+{{/code}}
	167	+
156	156	Adding a new instance :
157	157
158		-{code}
	170	+{{code}}
	171	+
159	159	curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
160		-{code}
161	161
	174	+{{/code}}
	175	+
162	162	Delete an application :
163	163
164		-{code}
	178	+{{code}}
	179	+
165	165	curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
166		-{code}
167	167
	182	+{{/code}}
	183	+
168	168	Delete an instance :
169	169
170		-{code}
	186	+{{code}}
	187	+
171	171	curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
172		-{code}
173	173
	190	+{{/code}}
	191	+
174	174	Adding a new host :
175	175
176		-{code}
	194	+{{code}}
	195	+
177	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	178
179		-{{/warning}}
	198	+{{/code}}