Changes for page Wonder JavaMonitor and wotaskd
Last modified by Pascal Robert on 2023/08/10 22:21
From version 167.1
edited by Pascal Robert
on 2012/02/11 08:42
on 2012/02/11 08:42
Change comment:
There is no comment for this version
To version 179.1
edited by Maik Musall
on 2013/04/23 11:54
on 2013/04/23 11:54
Change comment:
Migrated to Confluence 5.3
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. probert1 +XWiki.mmusall - Content
-
... ... @@ -1,6 +1,6 @@ 1 -[[image:WonderJavaMonitor.png ||border="1"]]1 +[[image:attach:WonderJavaMonitor.png]] 2 2 3 -{{toc }}{{/toc}}3 +{{toc/}} 4 4 5 5 === Introduction === 6 6 ... ... @@ -8,25 +8,21 @@ 8 8 9 9 wotaskd (WebObjects task daemon) is the WebObjects Deployment tool that manages the instances on an Application Server. It's used by Monitor to propagate site configuration changes throughout the site's application hosts. 10 10 11 -Apple released the original wotaskd and JavaMonitor to the community as open source in WebObjects 5.4. The source was then quickly modified and included in Project Wonder. Substantial improvements in both functionality and look-and-feel have been made over the years. These improved versions of **wotaskd.woa** and **JavaMonitor.woa** are available as standard Wonder applications.11 +Apple released the original wotaskd and JavaMonitor to the community as open source in WebObjects 5.4. The source was then quickly modified and included in Project Wonder. Substantial improvements in both functionality and look-and-feel have been made over the years. These improved versions of **wotaskd.woa** and **JavaMonitor.woa** are available as standard Wonder applications. 12 12 13 13 === Where To Get Them === 14 14 15 -You can either download them pre-built from [[Wonder's Jenkins build server>>http://jenkins.wocommunity.org/job/Wonder/lastSuccessfulBuild/ ]] or build them from the source code.15 +You can either download them pre-built from [[Wonder's Jenkins build server>>url:http://jenkins.wocommunity.org/job/Wonder/lastSuccessfulBuild/||shape="rect"]] or build them from the source code. 16 16 17 -To build them from the [[Wonder source code>>W ONDER:Getting the Wonder Source Code]], simply run the following command from the Wonder directory at the root of the Wonder source.17 +To build them from the [[Wonder source code>>doc:WEB.Getting the Wonder Source Code]], simply run the following command from the Wonder directory at the root of the Wonder source. 18 18 19 -{{code}} 20 -ant frameworks deployment.tools -Ddeployment.standalone=true 21 -{{/code}} 19 +{{code}}ant frameworks deployment.tools -Ddeployment.standalone=true{{/code}} 22 22 23 23 {{info title="What this command does:"}} 24 - 25 -* *ant*: calls Apache Ant. It is assumed that you have this already installed. 26 -* *frameworks*: tells Ant to build the "frameworks" target. This may not be needed if you already have Wonder built and installed in a location Ant can find automatically. 27 -* *deployment.tools*: tells Ant to build the "deployment.tools" target. This is the target that builds both wotaskd.woa and JavaMonitor.woa. You absolutely need this one. 28 -* *\-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. 29 - 22 +* **ant**: calls Apache Ant. It is assumed that you have this already installed. 23 +* **frameworks**: tells Ant to build the "frameworks" target. This may not be needed if you already have Wonder built and installed in a location Ant can find automatically. 24 +* **deployment.tools**: tells Ant to build the "deployment.tools" target. This is the target that builds both wotaskd.woa and JavaMonitor.woa. You absolutely need this one. 25 +* **-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 {{/info}} 31 31 32 32 === Bug Fixes to Apple's Versions === ... ... @@ -51,19 +51,17 @@ 51 51 * Stop the active instances that are refusing new sessions when the minimum session count is reached 52 52 * Restart all but one of the instances that were just stopped and turn on "Auto-Recover" 53 53 54 -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. This is designed to work so that you always have just **one** inactive instance that is only used while the bounce is performed. While waiting for the existing sessions to end you will have only one instance of your app accepting new sessions; you need to determine if this is acceptable for your app or not.50 +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. This is designed to work so that you always have just **one** inactive instance that is only used while the bounce is performed. While waiting for the existing sessions to end you will have only one instance of your app accepting new sessions; you need to determine if this is acceptable for your app or not. 55 55 56 56 {{warning title="Database Changes"}} 57 - 58 -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\!* 59 - 53 +It is uncertain what will happen if the new version of your application makes changes to your database schema (e.g., uses [[ERXMigrations>>doc: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!** 60 60 {{/warning}} 61 61 62 62 ==== Statistics ==== 63 63 64 -If you call ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics]]##, JavaMonitor will send you back statistics, inJSONformat, about instances, per application.58 +If you call [[http:~~/~~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics>>url:http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics||shape="rect"]]{{code language="none"}}{{/code}}, JavaMonitor will send you back statistics, in serialized Property List format, about instances, per application. 65 65 66 -{{code title="Statistics Example Results"}} 60 +{{code 0="none" title="Statistics Example Results"}} 67 67 68 68 ( 69 69 { ... ... @@ -102,138 +102,236 @@ 102 102 103 103 {{/code}} 104 104 99 +{{info}} 105 105 If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query : 106 106 107 - ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]##102 +{{code}} 108 108 109 - ==== DirectActionsforManagementTasks====104 +http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword 110 110 111 - You can do most of the standard management tasks you'd normally doinJavaMonitor'sweb UI bycalling standardWebObjectsDirect Actions. Instead of using the ##/wa/## request handler though, these managementtasks use a new##/admin/## requesthandler. These Direct Actions can be veryuseful, especially if youneed to restart instances or other do tasks fromthecommand line, fromwithin Antor other build ordeploymentsystems.106 +wget http://monitorhost:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/stop?type=app&name=InstanceName&pw=yourPassword 112 112 108 +{{/code}} 109 +{{/info}} 110 + 111 +==== Direct Actions in JavaMonitor for Management Tasks ==== 112 + 113 +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 {{code language="none"}}/wa/{{/code}} request handler though, these management tasks use a new {{code language="none"}}/admin/{{/code}} 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. 114 + 113 113 List of available direct actions : 114 114 115 -* {{{*}info{*}}} : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified116 - ##info?##{{{}{*}type=all{*}}}117 - ##info?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}118 - ##info?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}117 +* **info**{{code language="none"}}{{/code}} : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified 118 + {{code language="none"}}info?{{/code}}**type=all**{{code language="none"}}{{/code}} 119 + {{code language="none"}}info?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 120 + {{code language="none"}}info?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 119 119 120 -* {{{*}running{*}}} : Returns{{{*}YES{*}}} if **all** of the specified are running,##NO##if not121 - ##running?##{{{}{*}type=all{*}}}122 - ##running?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}123 - ##running?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}122 +* **running**{{code language="none"}}{{/code}} : Returns **YES**{{code language="none"}}{{/code}} if **all** of the specified are running, {{code language="none"}}NO{{/code}} if not 123 + {{code language="none"}}running?{{/code}}**type=all**{{code language="none"}}{{/code}} 124 + {{code language="none"}}running?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 125 + {{code language="none"}}running?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 124 124 125 -* {{{*}stopped{*}}} : Returns{{{*}YES{*}}} if **all** the specified is running,{{{*}NO{*}}} if not.126 - ##stopped?##{{{}{*}type=all{*}}}127 - ##stopped?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}128 - ##stopped?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}127 +* **stopped**{{code language="none"}}{{/code}} : Returns **YES**{{code language="none"}}{{/code}} if **all** the specified is running, **NO**{{code language="none"}}{{/code}} if not. 128 + {{code language="none"}}stopped?{{/code}}**type=all**{{code language="none"}}{{/code}} 129 + {{code language="none"}}stopped?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 130 + {{code language="none"}}stopped?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 129 129 130 -* {{{*}bounce{*}}} : Returns{{{*}OK{*}}} after Bouncing (see description above) as specified131 - ##bounce?##{{{}{*}type=all{*}}}132 - ##bounce?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}132 +* **bounce**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after Bouncing (see description above) as specified 133 + {{code language="none"}}bounce?{{/code}}**type=all**{{code language="none"}}{{/code}} 134 + {{code language="none"}}bounce?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}} 133 133 134 -* {{{*}clearDeaths{*}}} : Returns{{{*}OK{*}}} after clearing deaths as specified135 - ##clearDeaths?##{{{}{*}type=all{*}}}136 - ##clearDeaths?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}136 +* **clearDeaths**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after clearing deaths as specified 137 + {{code language="none"}}clearDeaths?{{/code}}**type=all**{{code language="none"}}{{/code}} 138 + {{code language="none"}}clearDeaths?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}} 137 137 138 -* {{{*}turnScheduledOn{*}}} : Returns{{{*}OK{*}}} after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.139 - ##turnScheduledOn?##{{{}{*}type=all{*}}}140 - ##turnScheduledOn?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}141 - ##turnScheduledOn?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}140 +* **turnScheduledOn**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite. 141 + {{code language="none"}}turnScheduledOn?{{/code}}**type=all**{{code language="none"}}{{/code}} 142 + {{code language="none"}}turnScheduledOn?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 143 + {{code language="none"}}turnScheduledOn?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 142 142 143 -* {{{*}turnRefuseNewSessionsOn{*}}} : Returns{{{*}OK{*}}} after turning on "Refuse new sessions" as specified144 - ##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}145 - ##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}146 - ##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}145 +* **turnRefuseNewSessionsOn**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning on "Refuse new sessions" as specified 146 + {{code language="none"}}turnRefuseNewSessionsOn?{{/code}}**type=all**{{code language="none"}}{{/code}} 147 + {{code language="none"}}turnRefuseNewSessionsOn?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 148 + {{code language="none"}}turnRefuseNewSessionsOn?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 147 147 148 -* {{{*}turnRefuseNewSessionsOff{*}}} : Returns{{{*}OK{*}}} after turning off "Refuse new sessions" as specified149 - ##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}150 - ##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}151 - ##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}150 +* **turnRefuseNewSessionsOff**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning off "Refuse new sessions" as specified 151 + {{code language="none"}}turnRefuseNewSessionsOff?{{/code}}**type=all**{{code language="none"}}{{/code}} 152 + {{code language="none"}}turnRefuseNewSessionsOff?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 153 + {{code language="none"}}turnRefuseNewSessionsOff?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 152 152 153 -* {{{*}turnAutoRecoverOn{*}}} : Returns{{{*}OK{*}}} after turning on "Auto Recover" as specified154 - ##turnAutoRecoverOn?##{{{}{*}type=all{*}}}155 - ##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}156 - ##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}155 +* **turnAutoRecoverOn**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning on "Auto Recover" as specified 156 + {{code language="none"}}turnAutoRecoverOn?{{/code}}**type=all**{{code language="none"}}{{/code}} 157 + {{code language="none"}}turnAutoRecoverOn?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 158 + {{code language="none"}}turnAutoRecoverOn?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 157 157 158 -* {{{*}turnAutoRecoverOff{*}}} : Returns{{{*}OK{*}}} after turning off "Auto Recover" as specified159 - ##turnAutoRecoverOn?##{{{}{*}type=all{*}}}160 - ##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}161 - ##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}160 +* **turnAutoRecoverOff**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning off "Auto Recover" as specified 161 + {{code language="none"}}turnAutoRecoverOn?{{/code}}**type=all**{{code language="none"}}{{/code}} 162 + {{code language="none"}}turnAutoRecoverOn?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 163 + {{code language="none"}}turnAutoRecoverOn?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 162 162 163 -* {{{*}forceQuit{*}}} : Returns{{{*}OK{*}}} after force quitting as specified. This could be useful to call from a monitoring system.164 - ##forceQuit?##{{{}{*}type=all{*}}}165 - ##forceQuit?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}166 - ##forceQuit?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}165 +* **forceQuit**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after force quitting as specified. This could be useful to call from a monitoring system. 166 + {{code language="none"}}forceQuit?{{/code}}**type=all**{{code language="none"}}{{/code}} 167 + {{code language="none"}}forceQuit?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 168 + {{code language="none"}}forceQuit?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 167 167 168 -* {{{*}stop{*}}} : Returns{{{*}OK{*}}} after calling "Stop" as specified169 - ##stop?##{{{}{*}type=all{*}}}170 - ##stop?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}171 - ##stop?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}170 +* **stop**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after calling "Stop" as specified 171 + {{code language="none"}}stop?{{/code}}**type=all**{{code language="none"}}{{/code}} 172 + {{code language="none"}}stop?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 173 + {{code language="none"}}stop?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 172 172 173 -* {{{*}start{*}}} : Returns{{{*}OK{*}}} after calling "Start" as specified174 - ##start?##{{{}{*}type=all{*}}}175 - ##start?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}176 - ##start?##{{{}{*}type=ins&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{colorvalue="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}175 +* **start**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after calling "Start" as specified 176 + {{code language="none"}}start?{{/code}}**type=all**{{code language="none"}}{{/code}} 177 + {{code language="none"}}start?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%) 178 + {{code language="none"}}start?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}} 177 177 178 178 To get details about all instances of all applications: 179 - ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]##181 + [[http:~~/~~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all>>url:http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all||shape="rect"]]{{code language="none"}}{{/code}} 180 180 181 181 To get details about the **AjaxExample** application: 182 - ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]##184 + [[http:~~/~~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample>>url:http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample||shape="rect"]]{{code language="none"}}{{/code}} 183 183 184 184 To get details about instance **1** of the **AjaxExample** application: 185 - ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]##187 + [[http:~~/~~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1>>url:http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1||shape="rect"]]{{code language="none"}}{{/code}} 186 186 187 -==== Remote Control via REST Routes ==== 189 +==== Remote Control via REST Routes (for JavaMonitor) ==== 188 188 189 -If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via [[REST>> WONDER:ERRest Framework]] calls. Between the two methods (Direct Actions, REST) you have almost full remote-control of JavaMonitor. Just make sure that your JavaMonitor installation is secure Just like with Direct Actions, you need to append##?pw=XXXX##to the URLs if your JavaMonitor is password protected.191 +If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via [[REST>>doc:ERRest Framework]] calls. Between the two methods (Direct Actions, REST) you have almost full remote-control of JavaMonitor. Just make sure that your JavaMonitor installation is secure! Just like with Direct Actions, you need to append {{code language="none"}}?pw=XXXX{{/code}} to the URLs if your JavaMonitor is password protected. 190 190 191 191 Examples of REST calls : 192 192 193 -{{code title="Adding a New Host"}} 194 - 195 +{{code 0="none" title="Adding a New Host"}} 195 195 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 197 +{{/code}} 196 196 197 -{{/code}} 199 +{{code 0="none" title="Fetching Details for All Applications"}} 200 +curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json 201 +{{/code}} 198 198 199 -{{code title="Fetching Details for All Applications"}} 203 +{{code 0="none" title="Adding a New Application"}} 204 +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 205 +{{/code}} 200 200 201 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json 207 +{{code 0="none" title="Delete an Application"}} 208 +curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json 209 +{{/code}} 202 202 203 -{{/code}} 211 +{{code 0="none" title="Adding a New Instance"}} 212 +curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost 213 +{{/code}} 204 204 205 -{{code title="Adding a New Application"}} 215 +{{code 0="none" title="Delete an Instance"}} 216 +curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1 217 +{{/code}} 206 206 207 - 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.json219 +{{code 0="none" title="Configuring the Site"}} 208 208 221 +curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json 222 + 209 209 {{/code}} 210 210 211 - {{code title="DeleteanApplication"}}225 +Note that before configuring the site you must first add a host. If you attempt to configure the site prior to adding a host you will get an InvalidStateException. 212 212 213 - curl-XDELETEhttp://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json227 +==== Remote Control via REST Routes (for wotaskd) ==== 214 214 215 -{{/code}} 229 +Starting on August 10th 2012, wotaskd also have REST routes. By using them, you can do most of the tasks using REST and you might not even need JavaMonitor. Just like the JavaMonitor REST and Direct Actions, you need to append {{code language="none"}}?pw=XXXX{{/code}} to the URLs if wotaskd is password protected. 216 216 217 -{{code title="Adding a New Instance"}} 231 +{{code 0="none" title="Fetching Details for All Applications"}} 232 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json 233 +{{/code}} 218 218 219 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost 235 +{{code 0="none" title="Adding a New Application"}} 236 +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://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json 237 +{{/code}} 220 220 221 -{{/code}} 239 +{{code 0="none" title="Delete an Application"}} 240 +curl -X DELETE http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json 241 +{{/code}} 222 222 223 -{{code title="Delete an Instance"}} 243 +{{code 0="none" title="Adding a New Instance"}} 244 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost 245 +{{/code}} 224 224 225 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1 247 +{{code 0="none" title="Delete an Instance"}} 248 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1 249 +{{/code}} 226 226 227 -{{/code}} 251 +{{code 0="none" title="Configuring the Site"}} 252 +curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json 253 +{{/code}} 228 228 229 -{{code title="Configuring the Site"}} 255 +{{code 0="none" title="Starting all applications"}} 256 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/start 257 +{{/code}} 230 230 231 -curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json 259 +{{code 0="none" title="Starting a specific application (AjaxExample in this example)"}} 260 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/start 261 +{{/code}} 232 232 233 -{{/code}} 263 +{{code 0="none" title="Starting a specific instance of an application (instance 1 of AjaxExample in this example)"}} 264 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/start?id=1 265 +{{/code}} 234 234 235 -Note that before configuring the site you must first add a host. If you attempt to configure the site prior to adding a host you will get an InvalidStateException. 267 +{{code 0="none" title="Stopping all applications"}} 268 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/stop 269 +{{/code}} 236 236 271 +{{code 0="none" title="Stopping a specific application (AjaxExample in this example)"}} 272 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/stop 273 +{{/code}} 274 + 275 +{{code 0="none" title="Stopping a specific instance of an application (instance 1 of AjaxExample in this example)"}} 276 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/stop?id=1 277 +{{/code}} 278 + 279 +{{code 0="none" title="Force quit all applications"}} 280 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/forceQuit 281 +{{/code}} 282 + 283 +{{code 0="none" title="Force quit a specific application (AjaxExample in this example)"}} 284 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/forceQuit 285 +{{/code}} 286 + 287 +{{code 0="none" title="Force quit a specific instance of an application (instance 1 of AjaxExample in this example)"}} 288 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/forceQuit?id=1 289 +{{/code}} 290 + 291 +{{code 0="none" title="Information about all applications"}} 292 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/info 293 +{{/code}} 294 + 295 +{{code 0="none" title="Information about a specific application (AjaxExample in this example)"}} 296 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/info 297 +{{/code}} 298 + 299 +{{code 0="none" title="Information about a specific instance of an application (instance 1 of AjaxExample in this example)"}} 300 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/info?id=1 301 +{{/code}} 302 + 303 +{{code 0="none" title="Check if all applications are running"}} 304 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/isRunning 305 +{{/code}} 306 + 307 +{{code 0="none" title="Check if a specific application is running (AjaxExample in this example)"}} 308 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isRunning 309 +{{/code}} 310 + 311 +{{code 0="none" title="Check if a specific instance of an application is running (instance 1 of AjaxExample in this example)"}} 312 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isRunning?id=1 313 +{{/code}} 314 + 315 +{{code 0="none" title="Check if all applications are stopped"}} 316 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/isStopped 317 +{{/code}} 318 + 319 +{{code 0="none" title="Check if a specific application is stopped (AjaxExample in this example)"}} 320 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isStopped 321 +{{/code}} 322 + 323 +{{code 0="none" title="Check if a specific instance of an application is stopped (instance 1 of AjaxExample in this example)"}} 324 + 325 +curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isStopped?id=1 326 + 327 +{{/code}} 328 + 237 237 === Troubleshooting === 238 238 239 -If JavaMonitor won't start up check the [[troubleshooting deployment>>WO:Troubleshooting Deployment]] section. In particular pay attention to the [[WOTaskd Didn't Start>>WO:Troubleshooting Deployment]] Q&A.331 +If JavaMonitor won't start up check the [[troubleshooting deployment>>doc:Troubleshooting Deployment]] section. In particular pay attention to the [[WOTaskd Didn't Start>>doc:Troubleshooting Deployment]] Q&A.