Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 109.1
edited by David Avendasora
on 2010/11/29 20:37
Change comment: There is no comment for this version
To version 101.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.
... ... @@ -54,7 +54,7 @@
54 54  
55 55  ==== Statistics ====
56 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.
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 58  
59 59  {{code title="Statistics Example Results"}}
60 60  
... ... @@ -97,50 +97,45 @@
97 97  
98 98  If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
99 99  
100 -##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]]##
101 101  
102 -==== Direct Actions to many tasks ====
102 +==== Direct Actions for Management Tasks ====
103 103  
104 -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 +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.
105 105  
106 -//?type=all// : return details about all applications and instances
107 -//?type=app&name=AppName// : return details about all instances of a specific application
108 -//?type=ins&name=AppName-InstanceNo// : return details about one specific instance
106 +List of available direct actions :
109 109  
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 +
110 110  For example, if you want to get details about all instances and applications, you call :
111 111  
112 -[[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]]
113 113  
114 114  To get details about the //AjaxExample// application :
115 115  
116 -[[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]]
117 117  
118 118  And for a specific instance :
119 119  
120 -[[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]]
121 121  
122 -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 :
123 -
124 -{{code}}
125 -
126 -[Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
127 -
128 -{{/code}}
129 -
130 -List of available direct actions :
131 -
132 -///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
133 -///running// : return YES if the instance is running, NO if not.
134 -///stopped// : return NO if the instance is running, YES if not.
135 -///bounce//: more on it later.
136 -///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
137 -///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
138 -///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
139 -///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
140 -///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
141 -///stop// : stop an application/instance the normal way.
142 -///start// : start an application/instance the normal way.
143 -
144 144  ==== Remote Control via REST Routes ====
145 145  
146 146  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,36 +149,36 @@
149 149  
150 150  {{code title="Adding a New Host"}}
151 151  
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
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
153 153  
154 154  {{/code}}
155 155  
156 156  {{code title="Fetching Details for All Applications"}}
157 157  
158 -curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
153 +curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
159 159  
160 160  {{/code}}
161 161  
162 162  {{code title="Adding a New Application"}}
163 163  
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 +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
165 165  
166 166  {{/code}}
167 167  
168 168  {{code title="Delete an Application"}}
169 169  
170 -curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
165 +curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
171 171  
172 172  {{/code}}
173 173  
174 174  {{code title="Adding a New Instance"}}
175 175  
176 -curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
171 +curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
177 177  
178 178  {{/code}}
179 179  
180 180  {{code title="Delete an Instance :"}}
181 181  
182 -curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
177 +curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
183 183  
184 184  {{/code}}