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

Summary

Details

Page properties
Content
... ... @@ -28,36 +28,16 @@
28 28  * *\-Dwonder.patch=54*: tells Wonder to build for WebObjects version 5.4. You need this if you are building against Wonder Trunk. Some branches don't need it, but it doesn't hurt either.
29 29  * *\-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  
31 -{{/info}}
32 32  
33 -=== Major Improvements over Apple's versions ===
34 34  
35 -==== Automatic archive of SiteConfig.xml ====
33 +{{/info}}
36 36  
37 -On every change you make to an application's configuration, a backup of SiteConfig.xml will be created in, by default, /Library/WebObjects/Configuration.
35 +=== Statistics ===
38 38  
39 -==== Simplified/Automated Bouncing ====
37 +If you call [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics]], the answer send you back statistics, in JSON format, about instances, per application. Sample :
40 40  
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 :
39 +{{code}}
42 42  
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 -* Bounce the active instances when the minimum session count is reached
46 -
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.
48 -
49 -{{warning title="Database Changes"}}
50 -
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 -
53 -{{/warning}}
54 -
55 -==== Statistics ====
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.
58 -
59 -{{code title="Statistics Example Results"}}
60 -
61 61  (
62 62   {
63 63   "configuredInstances" = "2";
... ... @@ -97,27 +97,27 @@
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]]##
80 +[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]
101 101  
102 -==== Direct Actions to many tasks ====
82 +=== Direct Actions to many tasks ===
103 103  
104 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 -##?type=all## : returns details about all applications and instances
107 -##?type=app&name=AppName## : returns details about all instances of a specific application
108 -##?type=ins&name=AppName-InstanceNo## : returns details about one specific instance
86 +//?type=all// : return details about all applications and instances
87 +//?type=app&name=AppName// : return details about all instances of a specific application
88 +//?type=ins&name=AppName-InstanceNo// : return details about one specific instance
109 109  
110 110  For example, if you want to get details about all instances and applications, you call :
111 111  
112 -[[http://monitorhost:port9/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
92 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
113 113  
114 114  To get details about the //AjaxExample// application :
115 115  
116 -[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
96 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
117 117  
118 118  And for a specific instance :
119 119  
120 -[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
100 +[[http://hostname:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
121 121  
122 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 123  
... ... @@ -141,44 +141,70 @@
141 141  ///stop// : stop an application/instance the normal way.
142 142  ///start// : start an application/instance the normal way.
143 143  
144 -==== Remote Control via REST Routes ====
124 +=== Automatic archive of SiteConfig.xml ===
145 145  
126 +On every change you do to the configuration, a backup of SiteConfig.xml will be done in, by default, /Library/WebObjects/Configuration.
127 +
128 +=== Bounce feature ===
129 +
130 +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 :
131 +
132 +* Find the inactive (eg : not started) instance and start it
133 +* Find the active instances (minus the one started the step below) and enable "Refuse New Session"
134 +* Bounce the active instances when the minimum session count is reached
135 +
136 +This feature, from my understanding, allow you to upload new versions of your app, start up the new version and refuse sessions for the instances running on the older version. I don't know how this will work if your new version use migrations to change your schema (eg : old instances might raise exceptions because of database schema changes), so try it out on a test server before and put your results here.
137 +
138 +=== REST routes ===
139 +
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.
147 147  
148 148  Examples of REST calls :
149 149  
150 -{{code title="Adding a New Host"}}
144 +Fetching the details of all applications :
151 151  
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
146 +{{code}}
153 153  
148 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
149 +
154 154  {{/code}}
155 155  
156 -{{code title="Fetching Details for All Applications"}}
152 +Adding a new application :
157 157  
158 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
154 +{{code}}
159 159  
156 +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
157 +
160 160  {{/code}}
161 161  
162 -{{code title="Adding a New Application"}}
160 +Adding a new instance :
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://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
162 +{{code}}
165 165  
164 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
165 +
166 166  {{/code}}
167 167  
168 -{{code title="Delete an Application"}}
168 +Delete an application :
169 169  
170 -curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
170 +{{code}}
171 171  
172 +curl -X DELETE http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
173 +
172 172  {{/code}}
173 173  
174 -{{code title="Adding a New Instance"}}
176 +Delete an instance :
175 175  
176 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
178 +{{code}}
177 177  
180 +curl -X GET http://127.0.0.1:56789/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
181 +
178 178  {{/code}}
179 179  
180 -{{code title="Delete an Instance :"}}
184 +Adding a new host :
181 181  
182 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
186 +{{code}}
183 183  
188 +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
189 +
184 184  {{/code}}