Changes for page Wonder JavaMonitor and wotaskd
Last modified by Pascal Robert on 2023/08/10 22:21
From version 175.1
edited by Maik Musall
on 2013/04/23 11:54
on 2013/04/23 11:54
Change comment:
see https://github.com/projectwonder/wonder/issues/426
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 (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- 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>>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, in serialized Property List format, 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 { ... ... @@ -103,139 +103,127 @@ 103 103 {{/code}} 104 104 105 105 {{info}} 100 +If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query : 106 106 107 - If JavaMonitor isconfiguredwith a password, and I hopeyou do, pass _pw=monitorpassword_ as a argument to the query :102 +{{code}} 108 108 109 -{code} 110 110 http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword 111 111 112 112 wget http://monitorhost:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/stop?type=app&name=InstanceName&pw=yourPassword 113 -{code} 114 114 108 +{{/code}} 115 115 {{/info}} 116 116 117 117 ==== Direct Actions in JavaMonitor for Management Tasks ==== 118 118 119 -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.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. 120 120 121 121 List of available direct actions : 122 122 123 -* {{{*}info{*}}} : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified124 - ##info?##{{{}{*}type=all{*}}}125 - ##info?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}126 - ##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}} 127 127 128 -* {{{*}running{*}}} : Returns{{{*}YES{*}}} if **all** of the specified are running,##NO##if not129 - ##running?##{{{}{*}type=all{*}}}130 - ##running?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}131 - ##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}} 132 132 133 -* {{{*}stopped{*}}} : Returns{{{*}YES{*}}} if **all** the specified is running,{{{*}NO{*}}} if not.134 - ##stopped?##{{{}{*}type=all{*}}}135 - ##stopped?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}136 - ##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}} 137 137 138 -* {{{*}bounce{*}}} : Returns{{{*}OK{*}}} after Bouncing (see description above) as specified139 - ##bounce?##{{{}{*}type=all{*}}}140 - ##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}} 141 141 142 -* {{{*}clearDeaths{*}}} : Returns{{{*}OK{*}}} after clearing deaths as specified143 - ##clearDeaths?##{{{}{*}type=all{*}}}144 - ##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}} 145 145 146 -* {{{*}turnScheduledOn{*}}} : Returns{{{*}OK{*}}} after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.147 - ##turnScheduledOn?##{{{}{*}type=all{*}}}148 - ##turnScheduledOn?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}149 - ##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}} 150 150 151 -* {{{*}turnRefuseNewSessionsOn{*}}} : Returns{{{*}OK{*}}} after turning on "Refuse new sessions" as specified152 - ##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}153 - ##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}154 - ##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}} 155 155 156 -* {{{*}turnRefuseNewSessionsOff{*}}} : Returns{{{*}OK{*}}} after turning off "Refuse new sessions" as specified157 - ##turnRefuseNewSessionsOff?##{{{}{*}type=all{*}}}158 - ##turnRefuseNewSessionsOff?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}159 - ##turnRefuseNewSessionsOff?##{{{}{*}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}} 160 160 161 -* {{{*}turnAutoRecoverOn{*}}} : Returns{{{*}OK{*}}} after turning on "Auto Recover" as specified162 - ##turnAutoRecoverOn?##{{{}{*}type=all{*}}}163 - ##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}164 - ##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}} 165 165 166 -* {{{*}turnAutoRecoverOff{*}}} : Returns{{{*}OK{*}}} after turning off "Auto Recover" as specified167 - ##turnAutoRecoverOn?##{{{}{*}type=all{*}}}168 - ##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}169 - ##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}} 170 170 171 -* {{{*}forceQuit{*}}} : Returns{{{*}OK{*}}} after force quitting as specified. This could be useful to call from a monitoring system.172 - ##forceQuit?##{{{}{*}type=all{*}}}173 - ##forceQuit?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}174 - ##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}} 175 175 176 -* {{{*}stop{*}}} : Returns{{{*}OK{*}}} after calling "Stop" as specified177 - ##stop?##{{{}{*}type=all{*}}}178 - ##stop?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}179 - ##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}} 180 180 181 -* {{{*}start{*}}} : Returns{{{*}OK{*}}} after calling "Start" as specified182 - ##start?##{{{}{*}type=all{*}}}183 - ##start?##{{{}{*}type=app&name=*{}}}{{colorvalue="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}184 - ##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}} 185 185 186 186 To get details about all instances of all applications: 187 - ##[[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}} 188 188 189 189 To get details about the **AjaxExample** application: 190 - ##[[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}} 191 191 192 192 To get details about instance **1** of the **AjaxExample** application: 193 - ##[[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}} 194 194 195 195 ==== Remote Control via REST Routes (for JavaMonitor) ==== 196 196 197 -If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via [[REST>>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. 198 198 199 199 Examples of REST calls : 200 200 201 -{{code title="Adding a New Host"}} 202 - 195 +{{code 0="none" title="Adding a New Host"}} 203 203 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}} 204 204 205 -{{/code}} 206 - 207 -{{code title="Fetching Details for All Applications"}} 208 - 199 +{{code 0="none" title="Fetching Details for All Applications"}} 209 209 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json 201 +{{/code}} 210 210 211 -{{/code}} 212 - 213 -{{code title="Adding a New Application"}} 214 - 203 +{{code 0="none" title="Adding a New Application"}} 215 215 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}} 216 216 217 -{{/code}} 218 - 219 -{{code title="Delete an Application"}} 220 - 207 +{{code 0="none" title="Delete an Application"}} 221 221 curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json 209 +{{/code}} 222 222 223 -{{/code}} 224 - 225 -{{code title="Adding a New Instance"}} 226 - 211 +{{code 0="none" title="Adding a New Instance"}} 227 227 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost 213 +{{/code}} 228 228 229 -{{/code}} 230 - 231 -{{code title="Delete an Instance"}} 232 - 215 +{{code 0="none" title="Delete an Instance"}} 233 233 curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1 217 +{{/code}} 234 234 235 -{{ /code}}219 +{{code 0="none" title="Configuring the Site"}} 236 236 237 -{{code title="Configuring the Site"}} 238 - 239 239 curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json 240 240 241 241 {{/code}} ... ... @@ -244,148 +244,102 @@ 244 244 245 245 ==== Remote Control via REST Routes (for wotaskd) ==== 246 246 247 -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 ##?pw=XXXX##to the URLs if wotaskd is password protected.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. 248 248 249 -{{code title="Fetching Details for All Applications"}} 250 - 231 +{{code 0="none" title="Fetching Details for All Applications"}} 251 251 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json 233 +{{/code}} 252 252 253 -{{/code}} 254 - 255 -{{code title="Adding a New Application"}} 256 - 235 +{{code 0="none" title="Adding a New Application"}} 257 257 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}} 258 258 259 -{{/code}} 260 - 261 -{{code title="Delete an Application"}} 262 - 239 +{{code 0="none" title="Delete an Application"}} 263 263 curl -X DELETE http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json 241 +{{/code}} 264 264 265 -{{/code}} 266 - 267 -{{code title="Adding a New Instance"}} 268 - 243 +{{code 0="none" title="Adding a New Instance"}} 269 269 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost 245 +{{/code}} 270 270 271 -{{/code}} 272 - 273 -{{code title="Delete an Instance"}} 274 - 247 +{{code 0="none" title="Delete an Instance"}} 275 275 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1 249 +{{/code}} 276 276 277 -{{/code}} 278 - 279 -{{code title="Configuring the Site"}} 280 - 251 +{{code 0="none" title="Configuring the Site"}} 281 281 curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json 253 +{{/code}} 282 282 283 -{{/code}} 284 - 285 -{{code title="Starting all applications"}} 286 - 255 +{{code 0="none" title="Starting all applications"}} 287 287 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/start 257 +{{/code}} 288 288 289 -{{/code}} 290 - 291 -{{code title="Starting a specific application (AjaxExample in this example)"}} 292 - 259 +{{code 0="none" title="Starting a specific application (AjaxExample in this example)"}} 293 293 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/start 261 +{{/code}} 294 294 295 -{{/code}} 296 - 297 -{{code title="Starting a specific instance of an application (instance 1 of AjaxExample in this example)"}} 298 - 263 +{{code 0="none" title="Starting a specific instance of an application (instance 1 of AjaxExample in this example)"}} 299 299 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/start?id=1 265 +{{/code}} 300 300 301 -{{/code}} 302 - 303 -{{code title="Stopping all applications"}} 304 - 267 +{{code 0="none" title="Stopping all applications"}} 305 305 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/stop 269 +{{/code}} 306 306 307 -{{/code}} 308 - 309 -{{code title="Stopping a specific application (AjaxExample in this example)"}} 310 - 271 +{{code 0="none" title="Stopping a specific application (AjaxExample in this example)"}} 311 311 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/stop 273 +{{/code}} 312 312 313 -{{/code}} 314 - 315 -{{code title="Stopping a specific instance of an application (instance 1 of AjaxExample in this example)"}} 316 - 275 +{{code 0="none" title="Stopping a specific instance of an application (instance 1 of AjaxExample in this example)"}} 317 317 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/stop?id=1 277 +{{/code}} 318 318 319 -{{/code}} 320 - 321 -{{code title="Force quit all applications"}} 322 - 279 +{{code 0="none" title="Force quit all applications"}} 323 323 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/forceQuit 281 +{{/code}} 324 324 325 -{{/code}} 326 - 327 -{{code title="Force quit a specific application (AjaxExample in this example)"}} 328 - 283 +{{code 0="none" title="Force quit a specific application (AjaxExample in this example)"}} 329 329 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/forceQuit 285 +{{/code}} 330 330 331 -{{/code}} 332 - 333 -{{code title="Force quit a specific instance of an application (instance 1 of AjaxExample in this example)"}} 334 - 287 +{{code 0="none" title="Force quit a specific instance of an application (instance 1 of AjaxExample in this example)"}} 335 335 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/forceQuit?id=1 289 +{{/code}} 336 336 337 -{{/code}} 338 - 339 -{{code title="Information about all applications"}} 340 - 291 +{{code 0="none" title="Information about all applications"}} 341 341 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/info 293 +{{/code}} 342 342 343 -{{/code}} 344 - 345 -{{code title="Information about a specific application (AjaxExample in this example)"}} 346 - 295 +{{code 0="none" title="Information about a specific application (AjaxExample in this example)"}} 347 347 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/info 297 +{{/code}} 348 348 349 -{{/code}} 350 - 351 -{{code title="Information about a specific instance of an application (instance 1 of AjaxExample in this example)"}} 352 - 299 +{{code 0="none" title="Information about a specific instance of an application (instance 1 of AjaxExample in this example)"}} 353 353 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/info?id=1 301 +{{/code}} 354 354 355 -{{/code}} 356 - 357 -{{code title="Check if all applications are running"}} 358 - 303 +{{code 0="none" title="Check if all applications are running"}} 359 359 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/isRunning 305 +{{/code}} 360 360 361 -{{/code}} 362 - 363 -{{code title="Check if a specific application is running (AjaxExample in this example)"}} 364 - 307 +{{code 0="none" title="Check if a specific application is running (AjaxExample in this example)"}} 365 365 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isRunning 309 +{{/code}} 366 366 367 -{{/code}} 368 - 369 -{{code title="Check if a specific instance of an application is running (instance 1 of AjaxExample in this example)"}} 370 - 311 +{{code 0="none" title="Check if a specific instance of an application is running (instance 1 of AjaxExample in this example)"}} 371 371 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isRunning?id=1 313 +{{/code}} 372 372 373 -{{/code}} 374 - 375 -{{code title="Check if all applications are stopped"}} 376 - 315 +{{code 0="none" title="Check if all applications are stopped"}} 377 377 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/isStopped 317 +{{/code}} 378 378 379 -{{/code}} 380 - 381 -{{code title="Check if a specific application is stopped (AjaxExample in this example)"}} 382 - 319 +{{code 0="none" title="Check if a specific application is stopped (AjaxExample in this example)"}} 383 383 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isStopped 321 +{{/code}} 384 384 385 -{{ /code}}323 +{{code 0="none" title="Check if a specific instance of an application is stopped (instance 1 of AjaxExample in this example)"}} 386 386 387 -{{code title="Check if a specific instance of an application is stopped (instance 1 of AjaxExample in this example)"}} 388 - 389 389 curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isStopped?id=1 390 390 391 391 {{/code}} ... ... @@ -392,4 +392,4 @@ 392 392 393 393 === Troubleshooting === 394 394 395 -If JavaMonitor won't start up check the [[troubleshooting deployment>>Troubleshooting Deployment]] section. In particular pay attention to the [[WOTaskd Didn't Start>>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.