1 <?xml version="1.0" encoding="UTF-8"?>
\r
2 <!DOCTYPE html PUBLIC "XHTML 1.0 Strict"
\r
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
4 <html xmlns="http://www.w3.org/1999/xhtml">
\r
6 <meta name="Last-modified" content="Mon, 4 Apr 2011 12:00:00 GMT"/>
\r
7 <title>Java Bioinformatics Analyses Web Services (JABAWS) Server Configuration manual</title>
\r
8 <link href="ws.css" rel="stylesheet" type="text/css" media=
\r
9 "screen, projection, handheld, tv" />
\r
10 <link rel="stylesheet" type="text/css" media="print" href=
\r
12 <script type="text/javascript" src="prototype-1.6.0.3.js"></script>
\r
18 <tr><td style="width:158px;"><a href="http://www.dundee.ac.uk"><img src="images/uod_lt_long.gif" alt="University of Dundee" width="158" height="90" class="logo" title="University of Dundee" longdesc="http://www.dundee.ac.uk"/></a></td>
\r
19 <td class="bg"><img src="images/jabaws2.png" alt="JABAWS-2.0" title="Java Bioinformatics Analysis Web Services version 2.0"/></td>
\r
20 <td class="bg"><img src="images/banner_right.png" alt="Disorder" width="200" height="80"/></td>
\r
23 </div><!-- banner end-->
\r
26 <div id="panel"><a href="index.html">Home</a>
\r
27 <a href="quick_start.html">Getting Started</a>
\r
28 <a class="selected" href="man_about.html">Manual</a>
\r
30 <a href="man_about.html">About</a>
\r
31 <a href="man_servervm.html" title="JABAWS Server as Virtual Appliance">Server VA</a>
\r
32 <a href="man_awscloud.html" title="JABAWS Server in the Amazon EC2 Cloud">Server in the Cloud</a>
\r
33 <a href="man_serverwar.html" title="JABAWS Server as Web Application aRchive">Server WAR</a>
\r
34 <a class="selected" href="man_configuration.html" >Server<br/>
\r
36 <a href="man_client.html" title="JABAWS Command Line Client">CMD Client</a>
\r
37 <a href="man_stats.html" title="JABAWS Usage Statistics">Usage Statistics</a>
\r
38 <a href="man_dev.html" title="Accessing JABAWS from your program">Accessing<br/>
\r
40 <a href="man_server_dev.html" >JABAWS Development</a>
\r
42 <a href="http://www.compbio.dundee.ac.uk/downloads/jabaws">Download</a>
\r
43 <a href="PublicAnnualStat" title="JABAWS usage statistics">Usage Statistics</a>
\r
44 <a href="ServiceStatus" title="JABAWS webservices status. Click to test all web services. Please be patient while the services are being checked">Services Status</a>
\r
45 <a href="contacts.html">Contact Us</a>
\r
46 <a href="http://www.compbio.dundee.ac.uk" title="University of Dundee, The Barton Group" >Barton Group</a>
\r
51 <h2 id="headtitle">JABAWS MANUAL</h2>
\r
53 <h2>JABAWS Server Configuration </h2>
\r
55 <li><a href="#defjabaconf">JABAWS Configuration </a></li>
\r
56 <li><a href="#locEngConf">Local Engine Configuration</a></li>
\r
57 <li><a href="#clustEngConf">Cluster Engine Configuration</a></li>
\r
58 <li><a href="#exec">Executable Configuration</a></li>
\r
59 <li><a href="#setexecenv">Defining Environment Variables for
\r
60 Executables</a></li>
\r
61 <li><a href="#mafftconf">Configure JABAWS to Work
\r
63 <li><a href="#settinglimit">Limiting the size of the job accepted by JABAWS Server </a></li>
\r
64 <li><a href="#diffbin">Using a different version of the alignment program with JABAWS</a></li>
\r
65 <li><a href="#mixuse">Load balancing </a></li>
\r
66 <li><a href="#testingJaba">Testing JABA Web Services</a></li>
\r
67 <li><a href="#logs">JABAWS requests logging </a></li>
\r
68 <li><a href="#logfiles">JABAWS internal logging </a></li>
\r
69 <li><a href="#warfile">JABAWS War File Content</a></li>
\r
70 <li><a href="#ga">JABAWS and Google Analytics</a></li>
\r
72 <h3><a name="defjabaconf" id="defjabaconf"></a>JABAWS Configuration </h3>
\r
73 <p>There are three parts of the system you can configure. The local
\r
74 and the cluster engines, and the paths to the individual executables for
\r
75 each engine. These settings are stored in configuration files
\r
76 within the web application directory (for an overview, then take a
\r
77 look at the <a href="#warfile">war file content table</a>). </p>
\r
78 <p>Initially, JABAWS is configured with only the local engine
\r
79 enabled, with job output written to directory called "jobsout"
\r
80 within the web application itself. This means that JABAWS will work
\r
81 out of the box, but may not be suitable for serving a whole lab or
\r
83 <h3><a name="locEngConf" id="locEngConf"></a>Local Engine Configuration</h3>
\r
85 <p>The Local execution engine configuration is defined in the
\r
86 properties file <span class="hightlight">conf/Engine.local.properties. </span>The supported
\r
87 configuration settings are:<br />
\r
88 <span class="hightlight">engine.local.enable=true</span> - #
\r
89 enable or disable local engine, valid values true | false<br />
\r
91 "hightlight">local.tmp.directory=D:\\clusterengine\\testoutput</span>
\r
92 - a directory to use for temporary files storage, optional,
\r
93 defaults to java temporary directory<br />
\r
94 <span class="hightlight">engine.local.thread.number=4</span> -
\r
95 Number of threads for tasks execution (valid values between 1 and
\r
96 2x cpu. Where x is a number of cores available in the system).
\r
97 Optional defaults to the number of cores for core number <=4 and
\r
98 number of cores-1 for greater core numbers.</p>
\r
100 <p>If the local engine going to be heavily loaded (which is often the case if you do not have a cluster) it is a good idea to increase
\r
101 the amount of memory available for the web application server. If
\r
102 you are using Apache-Tomcat, then you can define its memory
\r
103 settings in the JAVA_OPTS environment variable. To specify which
\r
104 JVM to use for Apache-Tomcat, put the full path to the JRE
\r
105 installation in the JAVA_HOME environment variable (We would
\r
106 recommend using Sun Java Virtual Machine (JVM) in preference to
\r
107 Open JDK). Below is an example of code which can be added to <span
\r
108 class="hightlight"><tomcat_dir>/bin/setenv.sh</span> script
\r
109 to define which JVM to use and a memory settings for Tomcat server.
\r
110 Tomcat server startup script (<span class=
\r
111 "hightlight">catalina.sh</span>) will execute <span class=
\r
112 "hightlight">setenv.sh</span> on each server start
\r
113 automatically.<br />
\r
114 <span class="code">export
\r
115 JAVA_HOME=/homes/ws-dev2/jdk1.6.0_17/<br />
\r
116 export JAVA_OPTS="-server -Xincgc -Xms512m -Xmx1024m"</span></p>
\r
118 <h3><a name="clustEngConf" id="clustEngConf"></a>Cluster Engine Configuration</h3>
\r
120 <p>Supported configuration settings:<br />
\r
121 <span class="hightlight">engine.cluster.enable=true</span> - #
\r
122 enable or disable local engine true | false, defaults to
\r
125 "hightlight">cluster.tmp.directory=/homes/clustengine/testoutput-</span>
\r
126 a directory to use for temporary files storage. The value must be
\r
127 an absolute path to the temporary directory. Required. The value
\r
128 must be different from what is defined for local engine. This
\r
129 directory must be accessible from all cluster nodes.<br />
\r
130 For the cluster engine to work, the SGE_ROOT and LD_LIBRARY_PATH
\r
131 environment variables have to be defined. They tell the cluster
\r
132 engine where to find DRMAA libraries. These variables
\r
133 should be defined when the web application server starts up, e.g.</p>
\r
135 <p class="code">SGE_ROOT=/gridware/sge<br />
\r
136 LD_LIBRARY_PATH=/gridware/sge/lib/lx24-amd64</p>
\r
138 <p>Finally, do not forget to configure executables for the cluster
\r
139 execution, they may be the same as for the local execution but may
\r
140 be different. Please refer to the executable configuration section
\r
141 for further details.</p>
\r
143 <h3><a name="exec" id="exec"></a>Executable Configuration</h3>
\r
145 <p>All the executable programs
\r
146 are configured in <span class="hightlight">conf/Executable.properties</span> file. Each executable
\r
147 is configured with a number of options. They are: <span class=
\r
148 "code">local.X.bin.windows=<path to executable under windows
\r
149 system, optional><br />
\r
150 local.X.bin=<path to the executable under non-windows system,
\r
152 cluster.X.bin=<path to the executable on the cluster, all
\r
153 cluster nodes must see it, optional><br />
\r
154 X.bin.env=<semicolon separated list of environment variables
\r
155 for executable, use hash symbol as name value separator,
\r
157 X.--aamatrix.path=<path to the directory containing
\r
158 substitution matrices, optional><br />
\r
159 X.presets.file=<path to the preset configuration file, optional
\r
161 X.parameters.file=<path to the parameters configuration file,
\r
163 X.limits.file=<path to the limits configuration file,
\r
165 X.cluster.settings=<list of the cluster specific options,
\r
166 optional></span></p>
\r
168 <p>Where X is either clustal, muscle, mafft, probcons or tcoffee. </p>
\r
170 <p>Default JABAWS configuration includes path to local executables
\r
171 to be run by the local engine only, all cluster related settings
\r
172 are commented out, but they are there for you as example. Cluster
\r
173 engine is disabled by default. To configure executable for cluster
\r
174 execution un comment the X.cluster settings and change them
\r
175 appropriately. </p>
\r
176 <p>By default limits are set well in excess of what you may want to offer to the users outside your lab, to make sure that the tasks are never rejected. The default limit is 100000 sequences of 100000 letters on average for all of the JABA web services. You can adjust the limits according to your needs by editing <span class="hightlight">conf/settings/<X>Limit.xml</span> files.<br />
\r
177 After you have completed the editing your configuration may look like
\r
178 this:<span class="code">local.mafft.bin.windows=<br />
\r
179 local.mafft.bin=binaries/mafft<br />
\r
180 cluster.mafft.bin=/homes/cengine/mafft<br />
\r
181 mafft.bin.env=MAFFT_BINARIES#/homes/cengine/mafft;FASTA_4_MAFFT#/bin/fasta34;<br />
\r
182 mafft.--aamatrix.path=binaries/matrices<br />
\r
183 mafft.presets.file=conf/settings/MafftPresets.xml<br />
\r
184 mafft.parameters.file=conf/settings/MafftParameters.xml<br />
\r
185 mafft.limits.file=conf/settings/MafftLimits.xml<br />
\r
186 mafft.cluster.settings=-q bigmem.q -l h_cpu=24:00:00 -l
\r
187 h_vmem=6000M -l ram=6000M</span></p>
\r
188 <p>Please not that relative paths must only be specified for the
\r
189 files that reside inside web application directory, all other paths
\r
190 must be supplied as absolute!</p>
\r
192 <p>Furthermore, you should avoid using environment variables within the paths or options - since these will not be evaluated correctly. Instead, please explicitly
\r
193 specify the absolute path to anything
\r
194 normally evaluated from an environment variable at execution time.</p>
\r
196 <p>If you are using JABAWS to submit jobs to the cluster (with
\r
197 cluster engine enabled), executables must be available from all
\r
198 cluster nodes the task can be sent to, also paths to the
\r
199 executables on the cluster e.g. <span class=
\r
200 "hightlight">cluster.<exec_name>.bin</span> must be
\r
203 <p>Executables can be located anywhere in your system, they do not
\r
204 have to reside on the server as long as the web application server
\r
205 can access and execute them.</p>
\r
207 <p>Cluster settings are treated as a black box, the system will
\r
208 just pass whatever is specified in this line directly to the
\r
209 cluster submission library. This is how DRMAA itself treats this
\r
210 settings. More exactly DRMAA <span class="hightlight">JobTemplate.setNativeSpecification()</span> function will be called.</p>
\r
211 <p>For further details and examples of configuration please refer to the <span class="hightlight">Executable.properties</span> file supplied with JABAWS.</p>
\r
212 <h3><a name="setexecenv" />Defining Environment Variables for
\r
215 <p>Environment variables can be defined in property <span class=
\r
216 "code">x.bin.env</span> Where <span class="hightlight">x</span> is
\r
217 one of five executables supported by JABAWS. Several environment
\r
218 variables can be specified in the same line. For example.<br />
\r
220 "code">mafft.bin.env=MAFFT_BINARIES#/homes/cengine/mafft;FASTA_4_MAFFT#/bin/fasta34;</span></p>
\r
222 <p>The example above defines two environment variables with names
\r
223 MAFFT-BINARIES and FASTA_4_MAFFT and values /homes/cengine/mafft
\r
224 and /bin/fasta34 respectively. Semicolon is used as a separator
\r
225 between different environment variables whereas hash is used as a
\r
226 separator for name and value of the variable.</p>
\r
228 <h3><a name="mafftconf" id="mafftconf"></a>Configure JABAWS to Work
\r
231 <p>If you use default configuration you do not need to read any
\r
232 further. The default configuration will work for you without any
\r
233 changes, however, if you want to install Mafft yourself then there
\r
234 is a couple of more steps to do.</p>
\r
236 <p>Mafft executable needs to know the location of other files
\r
237 supplied with Mafft. In addition some Mafft functions depends on
\r
238 the fasta executable, which is not supplied with Mafft, but is a
\r
239 separate package. Mafft needs to know the location of fasta34
\r
242 <p>To let Mafft know where the other files from its package are
\r
243 change the value of MAFFT-BINARIES environment variables. To let
\r
244 Mafft know where is the fasta34 executable set the value of
\r
245 FASTA_4_MAFFT environment variable to point to a location of
\r
246 fasta34 program. The latter can be added to the PATH variable
\r
247 instead. If you are using executables supplied with JABAWS, the
\r
248 path to Mafft binaries would be like <span class=
\r
249 "hightlight"><relative path to web application
\r
250 directory>/binaries/src/mafft/binaries</span> and the path to
\r
251 fasta34 binary would be <span class="hightlight"><relative path
\r
253 directory>/binaries/src/fasta34/fasta34</span>. You can specify
\r
254 the location of Mafft binaries as well as fasta34 program elsewhere
\r
255 by providing an absolute path to them. All these settings are
\r
256 defined in <span class=
\r
257 "hightlight">conf/Executable.properties</span> file.</p>
\r
258 <h3><a name="settinglimit" id="settinglimit"></a>Limiting the size of the job accepted by JABAWS </h3>
\r
259 <p>JABAWS can be configured to reject excessively large tasks. This is useful if you operate JABAWS service for many users. By defining a maximum allowed task size you can provide an even service for all users and prevents waist of resources on the tasks too large to complete successfully. You can define the maximum number of sequences and the maximum average sequence length that JABAWS accepts for each JABA Web Service independently.
\r
260 Furthermore, you can define different limits for different presets of the same web service. <br />
\r
261 By default limits are disabled. You can enable them by editing <span class="hightlight">conf/Executable.properties</span> file. You can adjust the limits according to your needs by editing <span class="hightlight">conf/settings/<X>Limit.xml</span> files. </p>
\r
262 <h3><a name="diffbin" id="diffbin"></a>Using a different version of the alignment program with JABAWS</h3>
\r
263 <p>JABAWS supplied with binaries and source code of the executables which version it supports. So normally you would not need to install your own executables. However, if you have a different version of an executable (e.g. an alignment program) which you prefer, you could use it as long as it supports all the functions JABAWS executable supported. This could be the case with more recent executable. If the options supported by your chosen executable is different when the standard JABAWS executable, than you need to edit <em>ExecutableName</em>Paramaters.xml configuration file. </p>
\r
264 <h3><a name="mixuse" id="mixuse"></a>Load balancing </h3>
\r
265 <p>If your cluster is busy and have significant waiting times you can achieve a faster response by allowing the server machine to calculate small tasks and the reserve the cluster for bigger jobs. This works especially well if your server is a powerful machine with many CPUs. To do this you need to enable and configure both the cluster and the local engines. Once this is done decide on the maximum size of a task to be run on the server locally. Then, edit <span class="hightlight">"# LocalEngineExecutionLimit #" </span>preset in<span class="hightlight"> <ServiceName>Limits.xml</span> file accordingly. JABAWS server then will balance the load according to the following rule: If the task size is smaller then the maximum task size for local engine, and the local engine has idle threads, then calculate task locally otherwise submit the task to the cluster. </p>
\r
266 <h3><a name="testingJaba" id="testingJaba"></a>Testing JABA Web Services</h3>
\r
267 <p>Access <span class="code"><your_JABAWS_server_URL>/ServiceStatus</span> to test all web services. Each time you access this URL, all services are tested. You can test a particular web service by adding its name at the end of this URL. For example <span class="code">http://localhost:8080/jabaws/ServiceStatus/MuscleWS </span>will test MuscleWS webservice only. For production configuration we recommend prohibiting requests to this URL for non authenticated users to prevent excessive load on the server. </p>
\r
268 <p>Alternatively, you can use a command line client (part of the client only
\r
269 package) to test your JABAWS installation as described <a href="man_client.html">here</a>. If you downloaded a JABAWS
\r
270 server package, you can use <span class=
\r
271 "hightlight"><your_jaba_context_name>/WEB-INF/lib/jaba-client.jar</span> to test JABAWS installation as described in <a href=
\r
272 "man_serverwar.html#usingWsTester">here</a>. If you downloaded the source
\r
273 code, then you could run a number of test suits defined in the
\r
274 build.xml Apache Ant file.</p>
\r
275 <h3><a name="logs" id="logs"></a>JABAWS requests logging </h3>
\r
276 <p>Enable Tomcat log valve. To do this uncomment the following section of <span class="hightlight"><tomcat_root>/conf/server.xml</span> configuration file. </p>
\r
277 <p class="code"> <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" <br />
\r
278 prefix="localhost_access_log." suffix=".txt" pattern="common" resolveHosts="false"/></p>
\r
279 <p> The following information will be logged:</p>
\r
280 <table width="100%" border="0" style="margin:0">
\r
284 <th>Method server_URL protocol </th>
\r
285 <th>HTTP status </th>
\r
286 <th>Response size in bytes </th>
\r
289 <td>10.31.11.159</td>
\r
290 <td>[10/Feb/2010:16:51:32 +0000]</td>
\r
291 <td>"POST /jws2/MafftWS HTTP/1.1"</td>
\r
296 <p>Which can be processed in various programs for log analysis , such as <a href="http://www.webalizer.org/">WebAlizer</a>, <a href="http://www.analog.cx/">Analog</a>, <a href="http://awstats.sourceforge.net/">AWStats</a>. </p>
\r
297 <h3><a name="logfiles" id="logfiles"></a>JABAWS internal logging </h3>
\r
298 <p>JABAWS can be configured to log what it is doing. This comes
\r
299 handy if you would like to see who is using your web services or
\r
300 need to chase some problems. JABAWS uses <a href=
\r
301 "http://logging.apache.org/log4j/1.2/">log4j</a> to do the logging,
\r
302 the example of log4j configuration is bundled with JABAWS war file.
\r
303 You will find it in the <span class=
\r
304 "hightlight">/WEB-INF/classes/log4j.properties</span> file. All the
\r
305 lines in this file are commented out. The reason why the logging is
\r
306 disabled by default it simple, log4j have to know the exact
\r
307 location where the log files should be stored. This is not known up
\r
308 until the deployment time. To enable the logging you need to
\r
309 define<span class="hightlight"> logDir</span> property in the <span
\r
310 class="hightlight">log4j.properties</span> and uncomment section of
\r
311 the file which corresponds to your need. More information is given
\r
312 in the <span class="hightlight">log4j.properties</span> file
\r
313 itself. Restart the Tomcat or the JABAWS web application to apply
\r
315 <p>After you have done this, assuming that you did not change the
\r
316 log4j.properties file yourself, you should see the application log
\r
317 file called <span class="hightlight">activity.log</span>. The
\r
318 amount of information logged can be adjusted using different
\r
319 logging levels, it is reduced in the following order of log levels
\r
320 TRACE, DEBUG, INFO, WARN, ERROR, FATAL.</p>
\r
321 <p>If you would like to know who is using your services, you might
\r
322 want to <a href="#logs">enable Tomcat request
\r
324 <h3><a name="warfile" id="warfile"></a>JABAWS War File Content</h3>
\r
325 <table width="100%">
\r
327 <th style="width:19%">Directory</th>
\r
328 <th style="width:81%">Content description</th>
\r
332 <td>contains configuration files such as Executable.properties,
\r
333 Engine.local.properties, Engine.cluster.properties</td>
\r
336 <td>conf/settings</td>
\r
337 <td>Contains individual executable description files. In particular
\r
338 XXXParameters.xml, XXXPresets.xml, XXXLimits.xml where XXX is the
\r
339 name of the executable</td>
\r
342 <td>ExecutionStatistics</td>
\r
343 <td>The database for storing the execution statistics. </td>
\r
347 <td>Web pages for usage statistics visialization and webservices status queries. </td>
\r
351 <td>Contains directories generated when running an individual executable. E.g. input and output files and some other task
\r
352 related data. (optional)</td>
\r
356 <td>Directory contains native executables - programs,
\r
357 windows binaries (optional)</td>
\r
360 <td>binaries/src</td>
\r
361 <td>Contains source of native executables and Linux i386
\r
365 <td>binaries/windows</td>
\r
366 <td>Contains binaries for MS Windows operating system. </td>
\r
369 <td>binaries/matrices</td>
\r
370 <td>Substitution matrices
\r
371 <!-- what format ? --></td>
\r
375 <td>Web application descriptor</td>
\r
378 <td>WEB-INF/lib</td>
\r
379 <td>Web application libraries</td>
\r
382 <td>WEB-INF/classes</td>
\r
383 <td>log4j.properties - log configuration file (optional)</td>
\r
386 <td colspan="2"><strong>Help Pages</strong> </td>
\r
390 <td>help pages, index.html is the starting page</td>
\r
393 <td>dm_javadoc</td>
\r
394 <td>javadoc for JABAWS client (the link is available from How To
\r
399 <td>documentation for programs that JABAWS uses</td>
\r
403 <td>images referenced by html pages</td>
\r
406 <h3><a name="ga" id="ga"></a>JABAWS and Google Analytics </h3>
\r
407 <p>JABAWS reports web services usage to our group Google Analytics (GA) account. JABAWS usage statistics are collected for funding and reporting purposes, and no private information is collected. The data sent by JABAWS is as follows: </p>
\r
409 <li>The IP address of the JABAWS server machine (the server IP can anonymized see <span class="hightlight">conf/GA.properties</span> config file)</li>
\r
410 <li>The name of the web service that was called. </li>
\r
411 <li>A few details of the system such as JABAWS version, java version, user language, color depth, screen
\r
412 resolution and character encoding.</li>
\r
414 <p> Google Analytics can be disabled or adjusted by removing/editing <span class="hightlight">conf/GA.properties</span> Google Analytics (GA) settings file. We would appreciate it greatly if you could leave it on!</p>
\r
415 <p>All calls to GA are very lightweight, completed asynchronously, create very little overhead and do not influence the server response time or performance.</p>
\r
417 <!-- content end-->
\r
418 <div id="copyright">Last update: 16 September 2011<br />
\r
419 Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of
\r
423 <!-- wrapper end-->
\r
427 <!-- Google analitics -->
\r
428 <script type="text/javascript">
\r
429 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
\r
430 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
\r
432 <script type="text/javascript">
\r
434 var pageTracker = _gat._getTracker("UA-5356328-1");
\r
435 pageTracker._trackPageview();
\r
git://source.jalview.org / jabaws.git / blob