Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 112.1
edited by David Avendasora
on 2010/11/29 20:24
Change comment: There is no comment for this version
To version 102.1
edited by David Avendasora
on 2010/11/29 21:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -40,8 +40,8 @@
40 40  
41 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 42  
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"
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 45  * Bounce the active instances when the minimum session count is reached
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.
... ... @@ -49,13 +49,15 @@
49 49  {{warning title="Database Changes"}}
50 50  
51 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 53  
54 -h4. Statistics
53 +{{/warning}}
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.
55 +==== Statistics ====
57 57  
58 -{code:title=Statistics Example Results}
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 +
59 59  (
60 60   {
61 61   "configuredInstances" = "2";
... ... @@ -90,90 +90,88 @@
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 :
96 +{{/code}}
96 96  
97 -[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]
98 +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
100 +##[[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.
102 +==== Direct Actions for Management 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
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.
106 106  
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
110 +** **##?type=app&name={{color value="maroon"}}AppName{{/color}}##** : Returns details about all instances of a specific application
111 +** **##?type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}##** : Returns details about one specific instance
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 +
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
126 +
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]
129 +[[http://monitorhost:port9/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
110 110  
111 -To get details about the _AjaxExample_ application :
131 +To get details about the //AjaxExample// application :
112 112  
113 -[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]
133 +[[http://monitorhost:port/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]
137 +[[http://monitorhost:port/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 :
139 +==== Remote Control via REST Routes ====
120 120  
121 -{code}
122 -[Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
123 -{code}
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.
124 124  
125 -List of available direct actions :
143 +Examples of REST calls :
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.
145 +{{code title="Adding a New Host"}}
138 138  
139 -h4. Remote Control via REST Routes
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
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.
149 +{{/code}}
142 142  
143 -Examples of REST calls :
151 +{{code title="Fetching Details for All Applications"}}
144 144  
145 -Fetching the details of all applications :
146 -{code}
147 -curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
148 -{code}
153 +curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
149 149  
150 -Adding a new application :
155 +{{/code}}
151 151  
152 -{code}
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}
157 +{{code title="Adding a New Application"}}
155 155  
156 -Adding a new instance :
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
157 157  
158 -{code}
159 -curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
160 -{code}
161 +{{/code}}
161 161  
162 -Delete an application :
163 +{{code title="Delete an Application"}}
163 163  
164 -{code}
165 -curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
166 -{code}
165 +curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
167 167  
168 -Delete an instance :
167 +{{/code}}
169 169  
170 -{code}
171 -curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
172 -{code}
169 +{{code title="Adding a New Instance"}}
173 173  
174 -Adding a new host :
171 +curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
175 175  
176 -{code}
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
173 +{{/code}}
178 178  
179 -{{/warning}}
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}}