Skip to Content
Version 67.1 by Pascal Robert on 2009/08/09 08:24
Hide last authors
Pascal Robert 57.1 1 === Introduction ===
2
Pascal Robert 67.1 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.
Pascal Robert 57.1 4
Pascal Robert 67.1 5 === Statistics ===
Pascal Robert 57.1 6
Pascal Robert 67.1 7 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 :
Pascal Robert 57.1 8
9 {{code}}
10
11 (
12 {
13 "configuredInstances" = "2";
14 "maxSessions" = "0";
15 "maxAvgIdleTime" = "2.078";
16 "avgTransactions" = "44.0000";
17 "sumSessions" = "0";
18 "avgAvgTransactionTime" = "0.0985000";
19 "refusingInstances" = "0";
20 "avgSessions" = "0.0000";
21 "maxTransactions" = "88";
22 "applicationName" = "AjaxExample";
23 "avgAvgIdleTime" = "1.0390000";
24 "maxAvgTransactionTime" = "0.197";
25 "runningInstances" = "2";
26 "sumTransactions" = "88";
27 },
28 {
29 "configuredInstances" = "2";
30 "maxSessions" = "0";
31 "maxAvgIdleTime" = "325.443";
32 "avgTransactions" = "0.5000";
33 "sumSessions" = "0";
34 "avgAvgTransactionTime" = "0.00000";
35 "refusingInstances" = "0";
36 "avgSessions" = "0.0000";
37 "maxTransactions" = "1";
38 "applicationName" = "AjaxExample2";
39 "avgAvgIdleTime" = "162.7215000";
40 "maxAvgTransactionTime" = "0.0";
41 "runningInstances" = "2";
42 "sumTransactions" = "1";
43 }
44 )
45
46 {{/code}}
47
Pascal Robert 59.1 48 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 49
Pascal Robert 67.1 50 http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword
Pascal Robert 57.1 51
Pascal Robert 67.1 52 === Direct Actions to many tasks ===
Pascal Robert 57.1 53
Pascal Robert 67.1 54 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.
Pascal Robert 57.1 55
Pascal Robert 67.1 56 //?type=all// : return details about all applications and instances
57 //?type=app&name=AppName// : return details about all instances of a specific application
58 //?type=ins&name=AppName-InstanceNo// : return details about one specific instance
Pascal Robert 57.1 59
Pascal Robert 67.1 60 For example, if you want to get details about all instances and applications, you call :
Pascal Robert 57.1 61
Pascal Robert 67.1 62 http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all
Pascal Robert 57.1 63
Pascal Robert 67.1 64 To get details about the //AjaxExample// application :
Pascal Robert 57.1 65
Pascal Robert 67.1 66 http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample
Pascal Robert 57.1 67
Pascal Robert 67.1 68 And for a specific instance :
Pascal Robert 57.1 69
Pascal Robert 67.1 70 http:~/~/hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1
Pascal Robert 57.1 71
Pascal Robert 67.1 72 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 :
Pascal Robert 57.1 73
Pascal Robert 67.1 74 {{code}}
Pascal Robert 57.1 75
Pascal Robert 67.1 76 [{"name": "AjaxExample", "id": "1", "host": "leopards.macti.lan", "port": "2001", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
77 "transactions": "88", "activeSessions": "0", "averageIdlePeriod": "2.078", "avgTransactionTime": "0.197"},
78 {"name": "AjaxExample", "id": "2", "host": "leopards.macti.lan", "port": "2002", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
79 "transactions": "0", "activeSessions": "0", "averageIdlePeriod": "0.0", "avgTransactionTime": "0.0"},
80 {"name": "AjaxExample2", "id": "1", "host": "leopards.macti.lan", "port": "2003", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
81 "transactions": "0", "activeSessions": "0", "averageIdlePeriod": "0.0", "avgTransactionTime": "0.0"},
82 {"name": "AjaxExample2", "id": "2", "host": "leopards.macti.lan", "port": "2004", "state": "ALIVE", "deaths": "0", "refusingNewSessions": false, "scheduled": false,
83 "transactions": "1", "activeSessions": "0", "averageIdlePeriod": "325.443", "avgTransactionTime": "0.0"}]
Pascal Robert 57.1 84
85 {{/code}}
86
Pascal Robert 67.1 87 List of available direct actions :
Pascal Robert 57.1 88
Pascal Robert 67.1 89 ///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
90 ///running// : return YES if the instance is running, NO if not.
91 ///stopped// : return NO if the instance is running, YES if not.
92 ///bounce//: more on it later.
93 ///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
94 ///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
95 ///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
96 ///turnAutoRecoverOn// : guess what? It activate "Auto recover"! And guess again? ///turnAutoRecoverOff// do the opposite!
97 ///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
98 ///stop// : stop an application/instance the normal way.
99 ///start// : start an application/instance the normal way.
Pascal Robert 57.1 100
Pascal Robert 67.1 101 === Automatic archive of SiteConfig.xml ===
Pascal Robert 57.1 102
Pascal Robert 67.1 103 On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
Pascal Robert 57.1 104
Pascal Robert 67.1 105 === Bounce feature ===
Pascal Robert 57.1 106
Pascal Robert 67.1 107 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 :
Pascal Robert 57.1 108
Pascal Robert 67.1 109 * Find the inactive (eg : not started) instance and start it
110 * Find the active instances (minus the one started the step below) and enable "Refuse New Session"
111 * Bounce the active instances when the minimum session count is reached
Pascal Robert 57.1 112
Pascal Robert 67.1 113 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.