Oracle TSAM Deployment Guide

Oracle TSAM Deployment Guide

This chapter contains the following sections:

•

Deploying Oracle TSAM Agent

•

Deploying Oracle TSAM Manager

Deploying Oracle TSAM Agent

The Local Monitor Server (LMS) is an Oracle Tuxedo system server provided by the Oracle TSAM Agent.

To properly deploy the Oracle TSAM Agent, you must add the LMS to each Oracle Tuxedo machine section of the UBBCONFIG file. Listing 1 shows an example of how to add the LMS to the UBBCONFIG file.

Listing 1 LMS Added to UBBCONFIG File

...
*MACHINES
MACHINEA
...
*GROUPS
...
LMSGRP LMID=MACHINEA
...
*SERVERS
LMS SRVGRP=LMSGRP SRVID=1 CLOPT=”-A -- -l tsamweb.abc.com:8080/tsam”
...

The “-l” option specifies the Oracle TSAM Data Server address which is configured in the Oracle TSAM Manager. For more information, see the Oracle TSAM Reference Guide. The Oracle TSAM Data Server uses the same port number as the Oracle TSAM Manager Console.

Note:

LMS can also be added to a running Oracle Tuxedo application using TMIB.

Deploying Oracle TSAM Manager

This section contains the following topics:

•

Overview

•

Oracle TSAM Manager Database Server Deployment

•

Oracle TSAM Application Server Deployment

•

Changing Configuration Parameters

•

Starting Up and Shutting Down Oracle TSAM Manager

Overview

The Oracle TSAM Manager functions as a Web application in a Servlet/JSP container. It uses the DBMS (Database Management System) to store persistent Oracle Tuxedo performance and monitoring data. Before using Oracle TSAM Manager, it must be deployed to a database server and a Web application container.

If you select "Bundled Derby database", "An existing Derby database" or "An existing Oracle database" during installation, Oracle TSAM Manager is deployed on the specified database server automatically; otherwise, you must deploy Oracle TSAM Manager to a database server using the "Database Deployment Utility".

If you select "Bundled Tomcat server", "An existing Tomcat server" or "An existing WebLogic server" during installation, Oracle TSAM Manager is deployed on the specified application server automatically; otherwise you must deploy Oracle TSAM Manager to an application server using the "Application Server Deployment Utility" or manually.

Oracle TSAM Manager Database Server Deployment

If you choose to deploy Oracle TSAM 11gR1 to an existing database server after installation, you must add an Oracle TSAM database after installation using the database deployment utilities.

Database Deployment Utilities

Oracle TSAM provides the following database deployment utilities:

•

UNIX Database Deployment: DatabaseDeployer.sh

•

Windows Database Deployment: DatabaseDeployer.cmd

The database deployment utilize do the following:

•

Creates the Oracle TSAM database

•

Creates a super user with the name "admin" and the password specified by the parameter "-adminpassword"

•

Updates the database connection URL in the tsam.ear file (located at < TSAM_DIR >/deploy)

Listing 2 and Listing 3 show UNIX and Windows database deployment utility examples accordingly.

Note:

The database utility has the following restrictions:

•

If the specified database uses OS authentication, the user name and password should be null. For an Oracle database, the user name must be "tsam"; it must be created before you use this utility

•

If you select the parameter "-overwrite yes", the existing TSAM database is always overwritten and the database connection URL in the tsam.ear file is updated; If you select the parameter "-overwrite no", the database connection URL is updated, but the existing TSAM database is not overwritten

•

The database connection URL in the tsam.ear file is overwritten after you run the database deployment utility. You must redeploy the tsam.ear file on the application.

For more information, see the Oracle TSAM Installation Guide.

Listing 2 UNIX Database Deployment Utility Example

1.

Deploy TSAM to a Derby database

cd < TSAM_DIR >/deploy

./ DatabaseDeployer.sh -type derby -hostname localhost -port 1527 -dbname TSAM -overwrite no -adminpassword admin1

2.

Deploy TSAM to a Derby database with the user "app" and the password "app"

cd < TSAM_DIR >/deploy

./ DatabaseDeployer.sh -type derby -hostname localhost -port 1527 -dbname TSAM -user app -password app -overwrite no -adminpassword admin1

3.

Deploy TSAM to an Oracle database with the user "tsam" and the password "tsam"

cd < TSAM_DIR >/deploy

./ DatabaseDeployer.sh -type oracle -hostname localhost -port 1521 -dbname TSAM -user tsam -password tsam -overwrite no -adminpassword admin1

Listing 3 Windows Database Deployment Utility Example

1.

Deploy TSAM to a Derby database

cd < TSAM_DIR >\deploy

DatabaseDeployer.cmd -type derby -hostname localhost -port 1527 -dbname TSAM -overwrite no -adminpassword admin1

2.

Deploy TSAM to a Derby database with the user "app" and the password "app"

cd < TSAM_DIR >/deploy

DatabaseDeployer.cmd -type derby -hostname localhost -port 1527 -dbname TSAM -user app -password app -overwrite no -adminpassword admin1

3.

Deploy TSAM to an Oracle database with the user "tsam" and the password "tsam"

cd < TSAM_DIR >/deploy

DatabaseDeployer.cmd -type oracle -hostname localhost -port 1521 -dbname TSAM -user tsam -password tsam -overwrite no -adminpassword admin1

Oracle TSAM Application Server Deployment

If you choose to deploy Oracle TSAM 11gR1 to an existing application server after installation, you must deploy it to an existing application server (WebLogic or Tomcat) after installation using the application server utilities, or manually.

•

Application Server Deployment Utilities

•

Manual Application Server Deployment

Note:

The WebLogic server has the following restrictions:

•

The WebLogic Server is expected to be located on the local installation machine. Remote existing WebLogic Servers are not supported.

•

Oracle TSAM Manager requires the WebLogic server with the Oracle TopLink and Application Development Framework (ADF) components installed. It is recommended that you use the JDeveloper with the embedded WebLogic Server package.

For more information, see http://www.oracle.com/tools/toplink_adf.html.

•

Oracle TSAM Manager requires the WebLogic Domain created with the component "Oracle JRF".

•

The Oracle TSAM database must be started when deploying to the WebLogic Server

Application Server Deployment Utilities

Oracle TSAM provides the following application server deployment utilities:

UNIX Application Server Deployment: AppServerDeployer.sh

Windows Application Server Deployment: AppServerDeployer.cmd

UNIX and Windows application deployment utility examples are shown in Listing 4 and Listing 5 accordingly.

Listing 4 UNIX Application Server Deployment Utility Example

1.

Deploy TSAM to a WebLogic server

cd < TSAM_DIR >/deploy

./AppServerDeployer.sh -type weblogic -adminurl localhost:7001 -directory /home/oracle/wlserver_10.3 -user weblogic -password weblogic1

2.

Deploy TSAM to a Tomcat server

cd < TSAM_DIR >/deploy

./AppServerDeployer.sh -type tomcat -directory /home/oracle/apache-tomcat-6.0.24

Listing 5 Windows Application Server Deployment Utility Example

1.

Deploy TSAM to a WebLogic server

cd < TSAM_DIR >\deploy

AppServerDeployer.cmd -type weblogic -adminurl localhost:7001 -directory C:\oracle\wlserver_10.3 -user weblogic -password weblogic1

2.

Deploy TSAM to a Tomcat server

cd < TSAM_DIR >/deploy

AppServerDeployer.sh -type tomcat -directory C:\oracle\apache-tomcat-6.0.24

Manual Application Server Deployment

Oracle TSAM Manager provides deployment scripts for the following application servers:

•

Oracle TSAM Manual Apache Tomcat Server Deployment

•

Oracle TSAM Manual Oracle WebLogic Server Deployment

Oracle TSAM Manual Apache Tomcat Server Deployment

Execute the commands shown in Listing 6 and Listing 7 for Unix and Windows accordingly to deploy Oracle TSAM on an Apache Tomcat Server.

Note:

Replace < TSAM_DIR > and < TOMCAT_DIR > with the actual TSAM and TOMCAT paths on your disk.

Listing 6 Oracle TSAM Manual Apache Tomcat Server Deployment (Unix)

TSAMDIR=< TSAM_DIR >; export TSAMDIR
TOMCATDIR=< TOMCAT_DIR >; export TOMCATDIR
JAVA_HOME=$TSAMDIR/jdk; export JAVA_HOME
PATH=$TSAMDIR/jdk/bin:$PATH; export PATH
cd $TSAMDIR/deploy
mkdir tsam
cd tsam
jar xf ../tsam.ear
mkdir tsam
cd tsam
jar xf ../tsam.war
cp ../../adflib/* WEB-INF/lib/
jar cf ../tsam.war *
cd ..
rm -rf $TOMCATDIR/webapps/tsam
rm -rf $TOMCATDIR/webapps/tsamhelp
cp tsam.war $TOMCATDIR/webapps/
cp tsamhelp.war $TOMCATDIR/webapps/
cd ..
cp adflib/* $TOMCATDIR/lib/
rm -rf tsam

Listing 7 Oracle TSAM Manual Apache Tomcat Server Deployment (Windows)

set TSAMDIR=< TSAM_DIR >
set TOMCATDIR=< TOMCAT_DIR >
set JAVA_HOME=%TSAMDIR%\jdk
set PATH=%JAVA_HOME%\bin;%PATH%
cd /d %TSAMDIR%\deploy
mkdir tsam
cd tsam
jar xf ..\tsam.ear
mkdir tsam
cd tsam
jar xf ..\tsam.war
copy ..\..\adflib\* WEB-INF\lib\
jar cf ..\tsam.war *
cd ..
rd %TOMCATDIR%\webapps\tsam /s/q
rd %TOMCATDIR%\webapps\tsamhelp /s/q
copy tsam.war %TOMCATDIR%\webapps\
copy tsamhelp.war %TOMCATDIR%\webapps\
cd ..
copy adflib\* %TOMCATDIR%\lib\
rd tsam /s/q

Oracle TSAM Manual Oracle WebLogic Server Deployment

After installing Oracle WebLogic Server, do the following steps to deploy Oracle TSAM:

1.

Start your WebLogic Domain and launch Oracle WebLogic Server Administration Console using the following URL: http://localhost:7001/console.

2.

In the Change Center of the Administration Console, click Lock & Edit.

3.

In the left panel of the Administration Console, select Deployments.

4.

In the right panel, click Install.

5.

In the Install Application Assistant, locate the tsam.ear file in the $TSAMDIR/deploy directory.

6.

Click Next.

7.

Choose the installation targeting style as an application.

8.

Click Next.

9.

Select the servers where you want to deploy the tsam.ear file.

10.

Click Next.

11.

Optionally update additional deployment settings. These settings include:

•

The deployed name of the application or module.

•

The security model that is applied to the application or module.

•

How the source files are made available to all targeted Managed Servers.

Typically, the default values are adequate.

12.

Click Next.

13.

Review the configuration settings you have specified, and click Finish to complete the installation.

At the Settings for TSAM page, you can modify specific settings for TSAM at Configuration - > General. For example, Session Timeout (in seconds).

14.

If you chose to immediately go to the deployment configuration screen, click the tabs to set additional TSAM configuration settings. If you chose to change this information later, you are returned to the Deployments table, which now includes the TSAM installation.

15.

To activate these changes, in the Change Center of the Administration Console, click Activate Changes.

Changing Configuration Parameters

Apache Tomcat Server Configuration

You can directly run Oracle TSAM Manager without changing any Apache Tomcat configuration parameters.

If required, you can change the default for the following parameters:

•

Configure Apache Tomcat Listening Port

•

Configure Session Timeout

•

Configure HTTP KeepAlive

•

Configure POST Maximum Byte Size

•

Configure Maximum Thread Simultaneous Processing

•

Configure Maximum Incoming Connection Requests

Configuration parameters for Apache Tomcat Server are located in the following files:

•

< TSAM_DIR >/apache-tomcat-6.0.24/conf/server.xml

•

< TSAM_DIR >/apache-tomcat-6.0.24/conf/web.xml

Configure Apache Tomcat Listening Port

The default Apache Tomcat port number is 8080. You can change the default based on your environment. The port is defined in <TSAM_DIR>/apache-tomcat-6.0.24/conf/server.xml file. For example, you could change to port 9090 by doing the following:



<Connector port=”9090” acceptCount="100" connectionTimeout="20000" disableUploadTimeout="true" enableLookups="false" maxHttpHeaderSize="8192" maxSpareThreads="75" maxThreads="150" minSpareThreads="25" redirectPort="8443"/>

The Oracle TSAM Manager console and data server URLs depend on the Apache Tomcat port setting. The following example assumes the default port “8080” used:

•

Oracle TSAM Manager console URL: http://host:8080/tsam.

The “host” is the full domain name or IP address where the Oracle TSAM Manager is installed. The Oracle TSAM Agent LMS must be set correctly using the Oracle TSAM Manager data server URL.

Configure Session Timeout

The session timeout can be configured by modifying the <session-config> element in <TSAM_DIR>/apache-tomcat-6.0.24/conf/web.xml file . For example, the following configuration invalidates an inactive session after 30 minutes.

<session-config>
<session-timeout>30</session-timeout>
</session-config>

Configure HTTP KeepAlive

This is the maximum number of HTTP requests that can be pipelined until the connection is closed by the server. Apache Tomcat provides an attribute maxKeepAliveRequests in the <TSAM_DIR>/apache-tomcat-6.0.24/conf/server.xml file for custom control. Setting this attribute to 1 disables HTTP/1.0 keep-alive, as well as HTTP/1.1 keep-alive and pipelining. Setting this to -1 allows an unlimited pipeline amount or keep-alive HTTP requests. If not specified, this attribute is set to 100.

For example:

<Connector port="8080" ... maxKeepAliveRequests="-1"/>

Configure POST Maximum Byte Size

You must configure the maximum size in bytes of the POST, maxPostSize, that is handled by the container FORM URL parameter parsing. The limit can be disabled by setting this attribute to a value less than or equal to 0. If not specified, this attribute is set to 2097152 KB (2 megabytes). maxPostSize is modified in the <TSAM_DIR>/apache-tomcat-6.0.24/conf/server.xml file.

For example:



<Connector maxPostSize="0" acceptCount="100" connectionTimeout="20000" disableUploadTimeout="true" enableLookups="false" maxHttpHeaderSize="8192" maxSpareThreads="75" maxThreads="150" minSpareThreads="25" port="8080" redirectPort="8443"/>

If Oracle TSAM has huge amount of monitoring data in the database, and maxPostSize is not adequate, an exception message, “javax.servlet.ServletException: Post too large”, is given when any operations fail.

Note:

It is recommended that maxPostSize is set to 0.

Configure Maximum Thread Simultaneous Processing

This is the maximum number of request processing threads created by Apache Tomcat, maxThreads, which determines the maximum number of simultaneous requests that can be handled by Apache Tomcat. If not specified, this attribute is set to 200. maxThreads is modified in the Apache Tomcat server.xml file. Oracle TSAM keeps a thread-level JDBC connection if the thread has database access. When you configure this attribute, you need to consider the DBMS capability.

Configure Maximum Incoming Connection Requests

This is the maximum queue length, acceptCount, for incoming connection requests when all possible request processing threads in Apache Tomcat are in use. Any requests received when the queue is full are refused. The default value is 100. Setting acceptCount to a larger number allows the Apache Tomcat queue to accept more HTTP requests if Apache Tomcat is busy. The acceptCount parameter is modified in the Apache Tomcat server.xml file.

The following is a maxPostSize, maxThreads, acceptCount example:



<Connector maxPostSize="0" acceptCount="1000" connectionTimeout="20000" disableUploadTimeout="true" enableLookups="false" maxHttpHeaderSize="8192" maxSpareThreads="75" maxThreads="130" minSpareThreads="25" port="8080" redirectPort="8443"/>

For more information, see the Apache Tomcat Web site.

WebLogic Server Configuration

You can directly run the Oracle TSAM Manager without changing any Oracle WebLogic configuration parameters.

If required, you can change the default for the following parameters:

•

Configure Oracle WebLogic Listening Port

•

Configure Session Timeout

•

Configure HTTP KeepAlive

•

Configure POST Maximum Byte Size

•

Configure Maximum Thread Simultaneous Processing

•

Configure Maximum Incoming Connection Requests

Configure Oracle WebLogic Listening Port

The default Oracle WebLogic Server Listening port number is 7001. To change the default Listening Port, do the following steps:

1.

Launch Oracle WebLogic Server Administration Console using the following URL: http://localhost:port/console. Where: "localhost" is the host name of the machine running WebLogic Server, "port" is the port number where WebLogic Server listens for requests.

2.

In the Change Center of the Administration Console, click Lock & Edit.

3.

In the left panel of the Administration Console, under Environment, click the Servers.

4.

Click the Server, e.g., exampleServer, where Oracle TSAM is deployed.

5.

Change default Listen Port at tab of Configuration -> General.

6.

To activate these changes, in the Change Center of the Administration Console, click Activate Changes.

Configure Session Timeout

To configure Session Timeout, do the following steps:

1.

Launch Oracle WebLogic Server Administration Console using the following URL: http://localhost:port/console. Where: "localhost" is the host name of the machine running WebLogic Server, "port" is the port number where WebLogic Server listens for requests (7001 by default).

2.

In the Change Center of the Administration Console, click Lock & Edit.

3.

In the left panel of the Administration Console, under Environment, click the Servers.

4.

Click TSAM application deployed.

5.

Change Session Timeout at tab of Configuration -> General.

6.

To activate these changes, in the Change Center of the Administration Console, click Activate Changes.

Configure HTTP KeepAlive

To enable and disable HTTP KeepAlive, do the following steps:

1.

Launch Oracle WebLogic Server Administration Console using the following URL: http://localhost:port/console. Where: "localhost" is the host name of the machine running WebLogic Server, "port" is the port number where WebLogic Server listens for requests (7001 by default).

2.

In the Change Center of the Administration Console, click Lock & Edit.

3.

In the left panel of the Administration Console, under Environment, click the Servers.

4.

Click the Server, e.g., exampleServer, which your TSAM deployed.

5.

Enable or disable HTTP KeepAlive by selecting Protocols -> HTTP.

6.

To activate these changes, in the Change Center of the Administration Console, click Activate Changes.

Configure POST Maximum Byte Size

To set the maximum size in bytes of the POST unlimited, do the following steps:

1.

Launch Oracle WebLogic Server Administration Console using the following URL: http://localhost:7001/console.

2.

In the Change Center of the Administration Console, click Lock & Edit.

3.

In the left panel of the Administration Console, under Environment, click the Servers.

4.

Click the Server, e.g., exampleServer, which your TSAM deployed.

5.

Change Max Post Size at tab of Protocols -> HTTP.
Note: Set Max Post Size less than 0, which indicates an unlimited size.

6.

To activate these changes, in the Change Center of the Administration Console, click Activate Changes.

Configure Maximum Thread Simultaneous Processing

Maximum Thread Simultaneous Processing is mapped into Maximum Threads Constraint at WebLogic Server. To configure Maximum Threads Constraint, do the following steps:

1.

Launch Oracle WebLogic Server Administration Console using the following URL: http://<hostname>:<port>/console, where <hostname> is the host name of the machine running WebLogic Server, and <port> is the port number that WebLogic Server listens for requests (7001 by default).

2.

In the Change Center of the Administration Console, click Lock & Edit, if you have not already done so.

3.

In the left pane of the Administration Console, click Work Managers under Environment.

4.

Click the Work Manager whose "Targets" includes the WebLogic Server where TSAM Manager web application is deployed. If no such work manager exists (usually called “WebLogic.wsee.mdb.DispatchPolicy”), create a new Work Manager and assign it to the right server.

5.

Change Maximum Threads Constraint at tab of Configuration, if no constraint is configured, click New to create one.

6.

To activate these changes, in the Change Center of the Administration Console, click Activate Changes.

Configure Maximum Incoming Connection Requests

Maximum Incoming Connection Requests is mapped into Capacity Constraint at WebLogic Server. To configure Capacity Constraint, do the following steps:

1.

Launch Oracle WebLogic Server Administration Console using the following URL: http://<hostname>:<port>/console, where <hostname> is the host name of the machine running WebLogic Server, and <port> is the port number that WebLogic Server listens for requests (7001 by default).

2.

In the Change Center of the Administration Console, click Lock & Edit, if you have not already done so.

3.

In the left pane of the Administration Console, click Work Managers under Environment.

4.

Click the Work Manager whose "Targets" includes the WebLogic Server where TSAM Manager web application is deployed. If no such work manager exists (usually called “WebLogic.wsee.mdb.DispatchPolicy”), create a new Work Manager and assign it to the right server.

5.

Change Capacity Constraint at tab of Configuration, if no constraint is configured, click New to create one.

6.

To activate these changes, in the Change Center of the Administration Console, click Activate Changes.

Note:

If you do not see “Lock & Edit” in the Change Center of the Administration Console, WebLogic Server Configuration editing is enabled.

Click Preferences. Uncheck the Automatically Acquire Lock and Activate Changes checkbox, then click Save.

For more information, see the Oracle WebLogic Web site.

Starting Up and Shutting Down Oracle TSAM Manager

If you chose the bundled Apache Tomcat Server and the bundled Derby database during installation, startup/shutdown script files for both are installed in the Oracle TSAM bin folder.

If you only choose the bundled Apache Tomcat Server, the installed startup/shutdown script only deals with Apache Tomcat Server. If you only choose the bundled Derby database, startupderby/shutdownderby script files are installed in the Oracle TSAM bin folder.

Bundled Apache Tomcat Server Start Up/Shut Down

If you run Oracle TSAM Manager with the bundled Apache Tomcat Server (with or without the Bundled Derby database), use the following steps to start and shut down Oracle TSAM Manager:

1.

Start Oracle TSAM Manager

UNIX:

a.

cd <TSAM_DIR>/bin

b.

./startup.sh

Windows:

a.

cd <TSAM_DIR>/bin

b.

startup.cmd

2.

Shut down Oracle TSAM Manager

UNIX:

a.

cd <TSAM_DIR>/bin

b.

./shutdown.sh

Windows:

a.

cd <TSAM_DIR>/bin

b.

shutdown.cmd

Bundled Derby Database Start Up/Shut Down

If you run Oracle TSAM Manager with the bundled Derby database (without the bundled Apache Tomcat Server), use the following steps to start and shut down Derby:

Note:

If you do not choose the bundled Apache Tomcat Server, you must set up your JAVA environment (JDK 1.6 or above) and boot up your existing application server manually.

1.

Start the bundled Derby database

UNIX:

a.

cd <TSAM_DIR>/bin

b.

./startupderby.sh

Windows:

a.

cd <TSAM_DIR>/bin

b.

startupderby.cmd

2.

Shut down the bundled Derby database

UNIX:

a.

cd <TSAM_DIR>/bin

b.

./shutdownderby.sh

Windows:

a.

cd <TSAM_DIR>/bin

b.

shutdownderby.cmd

See Also

•

Oracle TSAM Installation Guide

•

Oracle TSAM Console Users Guide