Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 89.1
edited by ted_archibald
on 2010/11/29 22:14
Change comment: There is no comment for this version
To version 99.1
edited by David Avendasora
on 2010/11/29 21:03
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ted_archibald
1 +XWiki.avendasora
Content
... ... @@ -99,30 +99,10 @@
99 99  
100 100  ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]##
101 101  
102 -==== Direct Actions for Management Tasks ====
102 +==== Direct Actions to many tasks ====
103 103  
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.
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.
105 105  
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 -** ##**?type=all{**##} : Returns {{{*}YES{*}}} if all instances of all applications are running
114 -** ##**?type=app&name=**{##}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}} : Returns {{{*}YES{*}}} if all instances of the specified application are running
115 -** ##**?type=ins&name=**{##}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}} : Returns {{{*}YES{*}}} if the instance of the specified application is running
116 -* {{{*}stopped{*}}} : return NO if the instance is running, YES if not.
117 -* {{{*}bounce{*}}} : more on it later.
118 -* {{{*}clearDeaths{*}}} : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
119 -* {{{*}turnScheduledOn{*}}} : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
120 -* {{{*}turnRefuseNewSessionsOn{*}}} : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
121 -* {{{*}turnAutoRecoverOn{*}}} : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
122 -* {{{*}forceQuit{*}}} : force quit an application, might be useful to call it from a monitoring system.
123 -* {{{*}stop{*}}} : stop an application/instance the normal way.
124 -* {{{*}start{*}}} : start an application/instance the normal way.
125 -
126 126  ##?type=all## : returns details about all applications and instances
127 127  ##?type=app&name=AppName## : returns details about all instances of a specific application
128 128  ##?type=ins&name=AppName-InstanceNo## : returns details about one specific instance
... ... @@ -139,6 +139,28 @@
139 139  
140 140  [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
141 141  
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 +
142 142  ==== Remote Control via REST Routes ====
143 143  
144 144  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.
... ... @@ -147,7 +147,7 @@
147 147  
148 148  {{code title="Adding a New Host"}}
149 149  
150 -curl -X POST -d "{id: 'otherserver.com',type: 'MHost', osType: 'MACOSX',address: '192.168.20.5', name: 'otherserver.com'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mHosts.json
152 +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
151 151  
152 152  {{/code}}
153 153