nimsoft monitor wasp guidedocs.nimsoft.com/.../catalog/wasp/3.1/wasp-3.1.pdf · chapter 1: wasp 3.1...

wasp Guide v3.1 series

Nimsoft® Monitor™

Legal Notices Copyright © 2012, CA. All rights reserved.

Warranty

The material contained in this document is provided "as is," and is subject to being changed, without notice, in future editions. Further, to the maximum extent permitted by applicable law, Nimsoft LLC disclaims all warranties, either express or implied, with regard to this manual and any information contained herein, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. Nimsoft LLC shall not be liable for errors or for incidental or consequential damages in connection with the furnishing, use, or performance of this document or of any information contained herein. Should Nimsoft LLC and the user have a separate written agreement with warranty terms covering the material in this document that conflict with these terms, the warranty terms in the separate agreement shall control.

Technology Licenses

The hardware and/or software described in this document are furnished under a license and may be used or copied only in accordance with the terms of such license.

No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Nimsoft LLC as governed by United States and international copyright laws.

Restricted Rights Legend

If software is for use in the performance of a U.S. Government prime contract or subcontract, Software is delivered and licensed as "Commercial computer software" as defined in DFAR 252.227-7014 (June 1995), or as a "commercial item" as defined in FAR 2.101(a) or as "Restricted computer software" as defined in FAR 52.227-19 (June 1987) or any equivalent agency regulation or contract clause. Use, duplication or disclosure of Software is subject to Nimsoft LLC’s standard commercial license terms, and non-DOD Departments and Agencies of the U.S. Government will receive no greater than Restricted Rights as defined in FAR 52.227-19(c)(1-2) (June 1987). U.S. Government users will receive no greater than Limited Rights as defined in FAR 52.227-14 (June 1987) or DFAR 252.227-7015 (b)(2) (November 1995), as applicable in any technical data.

Trademarks

Nimsoft is a trademark of CA.

Adobe®, Acrobat®, Acrobat Reader®, and Acrobat Exchange® are registered trademarks of Adobe Systems Incorporated.

Intel® and Pentium® are U.S. registered trademarks of Intel Corporation.

Java(TM) is a U.S. trademark of Sun Microsystems, Inc.

Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.

Netscape(TM) is a U.S. trademark of Netscape Communications Corporation.

Oracle® is a U.S. registered trademark of Oracle Corporation, Redwood City, California.

UNIX® is a registered trademark of the Open Group.

ITIL® is a Registered Trade Mark of the Office of Government Commerce in the United Kingdom and other countries.

All other trademarks, trade names, service marks and logos referenced herein belong to their respective companies.

Contact Nimsoft

For your convenience, Nimsoft provides a single site where you can access information about Nimsoft products.

At http://support.nimsoft.com/, you can access the following:

■ Online and telephone contact information for technical assistance and customer services

■ Information about user communities and forums

■ Product and documentation downloads

■ Nimsoft Support policies and guidelines

■ Other helpful resources appropriate for your product

Provide Feedback

If you have comments or questions about Nimsoft product documentation, you can send a message to [email protected].

http://support.nimsoft.com/

mailto:[email protected]

Contents 5

Contents

Chapter 1: wasp 3.1 7

Chapter 2: wasp configuration 9

The Setup Tab ............................................................................................................................................................. 10

The General Tab .................................................................................................................................................. 11

The Logging Tab .................................................................................................................................................. 14

The Webapps Tab ....................................................................................................................................................... 15

The WebApp Dialog ............................................................................................................................................ 16

Advanced Configuration Settings ............................................................................................................................... 22

Add a Key ............................................................................................................................................................ 22

Edit a Key ............................................................................................................................................................. 23

Raw Configure Options for wasp ........................................................................................................................ 23

Chapter 3: wasp Metrics 27

Appendix A: Troubleshooting and FAQs 29

Configuring HTTP Connector Handlers ....................................................................................................................... 29

Configuring the NIS Database Connection Pool ......................................................................................................... 31

Chapter 1: wasp 3.1 7

Chapter 1: wasp 3.1

This description applies to wasp probe version 3.11.

The wasp (Web Application Service Provider) is an embedded Tomcat web server running as a probe. It is distributed to the system during the UMP installation, and afterward, appears as a probe in Infrastructure Manager.

Its configuration can be divided into two main areas, the configuration of wasp itself, and the configuration of web applications running under wasp.

This section contains the following topics:

Documentation Changes (see page 8)

The Setup Tab

8 wasp Guide

Documentation Changes

This table describes the version history for this document.

Version Date What's New?

3.1 October 2012 Initial release.

Related Documentation

Documentation for other versions of the wasp probe (../../wasp.html)

The Release Notes for the wasp probe

Getting Started with CA Nimsoft® Probes

Monitor Metrics Reference Information for CA Nimsoft Probes


Chapter 2: wasp configuration

You can configure the probe by double-clicking it in Infrastructure Manager. This launches the probe configuration UI.

The Setup Tab

10 wasp Guide

The wasp UI consists of two tabs:

■ Setup tab

Allows you to specify data and communication sources, and logging parameters for the wasp.

■ Webapps tab

Lists the available web applications controlled by wasp.

The Setup Tab

The Setup tab is further divided into the General and Logging tabs.

The Setup Tab


The General Tab

This tab allows you to configure many of the parameters found in the <setup> section of the wasp configuration.

Log Level

Sets the level of detail for messages in the wasp.log file.

Note: This log level only applies to the internal wasp logger. Each web application can have one or more loggers, which can be set to different log levels.

The Setup Tab

12 wasp Guide

Log Size

Sets the size of the wasp.log file in KB until it rolls over. The default size is 100 KB. When you are configuring log size, be aware that both the internal wasp logger and all of the web application loggers write to the same log file.

Database connection pooling

Contains the following NIS connection pool parameters:

Max active

Sets the maximum number of connections that can be allocated from this pool at the same time.

Max idle

Sets the maximum number of connections that can remain idle in the pool at the same time.

Max wait

Sets the maximum time in milliseconds the pool will wait before throwing an exception when no additional connections are available. Enter -1 for the pool to wait indefinitely.

Override NIS credentials

Select this option to override user name and password credentials for the NIS database. By default, wasp uses the same credentials that data_engine uses. However, for security reasons, you may wish to use credentials that grant web applications fewer privileges.

Port configuration

Displays the ports specified and verified during the UMP installation.

Note: At least one port must be configured. Raw Configure provides additional port configuration options for wasp. See the section setup (see page 23).

http port

Specifies the HTTP port for UMP to use.

ajp port

Specifies the AJP port for UMP to use.

Java startup parameters

Sets the default and maximum heap size at startup for the Java Virtual Machine (JVM) running wasp.

The Setup Tab


Nimpool

These parameters define the properties of the Nimsoft bus request pool. The Nimsoft bus request pool is used to maximize performance when multiple requests are made to the same probe.

Note: Web applications must use the Nimpool Library in order to use the following Nimpool parameters.

Max active

Sets the maximum number of active connections to the same destination.

Max idle

Sets the maximum time in seconds before an idle connection is dropped.

Max wait

Sets the maximum time in seconds before an unused connection is closed.

Timeout

Sets the maximum time in seconds a client will wait for a connection to be established before throwing an exception.

Probe addresses

Specifies addresses for the data_engine and dashboard_engine probes for wasp to use.

Extra Java VM arguments

Allows you to enter additional JVM arguments which are passed directly to the Java command line during wasp startup.

The Setup Tab

14 wasp Guide

The Logging Tab

The wasp has several internal loggers, such as Apache Tomcat loggers. You can control these loggers, and set them to different log levels from this tab.

You can add a logger by right-clicking inside the pane and then selecting New logger package. To edit a logger, select the logger, then right-click inside the pane and select Edit logger.

The Webapps Tab


The Webapps Tab

The Webapps tab lists the available web applications wasp controls. To edit the default parameters of a web application, select the web application, then right-click inside the pane and select Edit.

This launches the WebApp dialog.

The Webapps Tab

16 wasp Guide

The WebApp Dialog

The WebApp dialog consists of four tabs: General, JDBC, Logging, and Custom.

The General Tab

You can use this tab to set the startup mode and path for a web application.

Startup mode

Sets the startup properties for the web application. The available options are:

■ Automatic--this is the default. If selected, the web application is automatically started when wasp starts.

■ Manual--the web application is not activated when wasp starts, and must be started manually.

The Webapps Tab


Path

Specifies the path used in the URL for accessing the web application.

The JDBC Tab

Each web application running under wasp can have several JDBC data sources. To add a new JDBC data source, right-click inside the pane and select New JDBC connection.

The Webapps Tab

18 wasp Guide

This launches the JDBC driver dialog.

The JDBC driver dialog consists of the following fields:

Name

Defines the name of the new data source, which the deployed web application will use to find it.

Driver

Select the correct driver for the database from the drop-down list. Or you can choose Custom driver to specify your own driver.

URL

Specifies the JDBC URL for the driver you selected.

User Name/Password

Specifies the credentials for the user who will connect to the database.

Test

Allows you to verify that you entered valid credentials.

Database connection pooling

Select this option to configure database connection pooling.

Max active

Sets the maximum number of connections that can be allocated from this pool at the same time.

The Webapps Tab


Max idle

Sets the maximum number of connections that can remain idle in the pool at the same time.

Max wait

Sets the maximum time in milliseconds the pool will wait before throwing an exception when no additional connections are available.

Remove Abandoned

Select this option to remove abandoned connections from the pool.

The Webapps Tab

20 wasp Guide

The Logging Tab

Each web application running under wasp can have several loggers. To set a different log level for a logger, right-click on the logger and select Edit logger.

The Webapps Tab


The Custom Tab

This tab allows you to control custom properties for each web application. Right-clicking in the pane, and then selecting Edit. This launches the Key/Value dialog.

Advanced Configuration Settings

22 wasp Guide


This section describes how to use Raw Configure, which allows you to modify additional configuration settings for the probe.

Note: The Raw Configure parameters described in the following sections should only be modified by experienced personnel. Mistaken changes to the wasp configuration can make UMP or some of its portlets inaccessible.

Add a Key

To add a new key in Raw Configure, follow these steps:

1. Locate the probe in Infrastructure Manager.

2. Press the <Ctrl> key as you right-click on the probe, and then select Raw Configure.

3. In Raw Configure, select a section from the tree in the left-hand navigation pane, and then click New Key.



4. Enter a name and value for the key.

Edit a Key

To edit a key in Raw Configure, follow these steps:

1. In Raw Configure, select the appropriate section from the tree in the left-hand navigation pane.

2. Select the key to edit, and then click Edit Key.

Raw Configure Options for wasp

The following sections describe keys and values you can edit to make configuration changes using Raw Configure.

setup

loglevel

Sets the level of detail for messages in the wasp.log file. By default, the log level slider is set to 1. See the section The General Tab (see page 11).

logsize

Sets the size of the wasp.log file in KB until it rolls over. The default size is 100 KB.

Note: log_size is a duplicate for this key, but is given precedence if present.


24 wasp Guide

data_engine

Sets the address of data_engine.

nimpool_max_active, nimpool_max_wait, nimpool_max_idle, nimpool_timeout

These parameters define the properties of the Nimsoft bus request pool, and can also be set under Nimpool in the wasp configuration UI. See the section The General Tab (see page 11).

db_user, db_password_unsecure, db_password

These parameters allow you to override user name and password credentials for the NIS database, and can also be set under Override NIS credentials in the wasp configuration UI. See the section The General Tab (see page 11).

dbcp_max_active, dbcp_max_idle, dbcp_max_wait

These parameters configure the NIS connection pool, and can also be set under Database connection pooling in the wasp configuration UI. See the section The General Tab (see page 11). In addition, see the sections dbcp (see page 25) and Configuring the NIS Database Connection Pool (see page 31).

http_port, https_port, ajp_port

Specifies the protocols and corresponding ports wasp uses for incoming connections.

Note: For security reasons, you can remove http_port if you do not wish to allow HTTP connections. However, there are additional steps required to configure UMP to use an HTTPS connection. See the Nimsoft Unified Management Portal SSL Implementation Guide at docs.nimsoft.com for the complete procedures.

The AJP protocol allows an Apache web server to connect to wasp to provide load balancing or for a DMZ configuration. See the Nimsoft Unified Management Portal Multiple Server Configuration Guide, or the Nimsoft Unified Management Portal DMZ Guide at docs.nimsoft.com for more information.

http_max_threads, https_max_threads, ajp_max_threads

These parameters set the maximum number of request processing threads to be created by this connector. This determines the maximum number of simultaneous requests that can be handled.

http_protocol, https_protocol, ajp_protocol, apr_enabled, apr_ssl_engine

These optional parameters specify the protocol handlers wasp uses for incoming traffic.

Note: These are advanced protocol settings. See the sections http_connector, https_connector, ajp_connector (see page 25) and Configuring HTTP Connector Handlers (see page 29) for additional information.

http://docs.nimsoft.com/




dbcp

<dbcp> is a section within the <setup> section, and allows you to pass through additional configuration parameters for the NIS database connection pool.

See the section Configuring the NIS Database Connection Pool (see page 31).

http_connector, https_connector, ajp_connector

<http_connector>, <https_connector>, and <ajp_connector> are optional sections within the <setup> section of the wasp configuration. If you specify the http_protocol, https_protocol, or ajp_protocol keys, you can add the corresponding connector section for advanced fine-tuning options.

All keys specified in connector sections are passed through to the corresponding connector. The possible configuration parameters and their behavior are described at http://tomcat.apache.org/tomcat-6.0-doc/config/http.html.

In addition, see the section Configuring HTTP Connector Handlers (see page 29).

http://tomcat.apache.org/tomcat-6.0-doc/config/http.html

Chapter 3: wasp Metrics 27

Chapter 3: wasp Metrics

The wasp probe does not generate any QoS. Therefore, there are no probe checkpoint metrics to be configured for this probe.


Appendix A: Troubleshooting and FAQs

This section contains troubleshooting information for the wasp probe.

This section contains the following topics:

Configuring HTTP Connector Handlers (see page 29) Configuring the NIS Database Connection Pool (see page 31)

Configuring HTTP Connector Handlers

To allow wasp to handle a greater number of concurrent requests, or to optimize response times, you can configure several parameters in the <setup> section of the wasp configuration. This topic provides a description of these parameters, and an example of their use.

Note: Do not attempt to modify the parameters described in this section unless you are proficient with Tomcat web server. Refer to http://tomcat.apache.org/tomcat-6.0-doc/config/http.html and other Tomcat resources for additional information.

http_port, https_port, ajp_port

Specifies the protocols and corresponding ports wasp uses for incoming connections.

Note: For security reasons, you can remove http_port if you do not wish to allow HTTP connections. However, there are additional steps required to configure UMP to use an HTTPS connection. See the Nimsoft Unified Management Portal SSL Implementation Guide at docs.nimsoft.com for the complete procedures.

The AJP protocol allows an Apache web server to connect to wasp to provide load balancing or for a DMZ configuration. See the Nimsoft Unified Management Portal Multiple Server Configuration Guide, or the Nimsoft Unified Management Portal DMZ Guide at docs.nimsoft.com for more information.

http_max_threads, https_max_threads, ajp_max_threads

These parameters set the maximum number of request processing threads to be created by this connector. This determines the maximum number of simultaneous requests that can be handled.




Configuring HTTP Connector Handlers

30 wasp Guide

http_protocol, https_protocol, ajp_protocol

These optional parameters specify the protocol handlers wasp uses for incoming traffic. The default value is HTTP/1.1, and configures the org.apache.coyote.http11.Http11Protocol. This is the blocking Java connector.

The possible values for this parameter are as follows:

■ org.apache.coyote.http11.Http11Protocol--this value is the same as HTTP/1.1.

■ org.apache.coyote.http11.Http11NioProtocol--this value is for the non-blocking Java connector.

■ org.apache.coyote.http11.Http11AprProtocol--this is the value for the APR connector.

Note: To use the APR connector, you must set apr_enabled to true and have the Tomcat Native library installed. Be advised that the APR connector has different settings for HTTPS than for the default Java connector.

apr_enabled

Configures the AprLifecycleListener, and loads the Apache Tomcat Native library tcnative-1. By default, this parameter is set to false.

Note: This is an advanced option, and is not recommended unless you absolutely must use the Apache Tomcat Native library. You must have the correct version of the library for your platform, and it must be present in the Nimsoft/lib folder of the UMP installation. The Apache Tomcat Native library is not included with wasp; download and install it according to the instructions at http://tomcat.apache.org/tomcat-6.0-doc/apr.html.

apr_ssl_engine

If APR is enabled, you can use this parameter to enable ssl_engine. The default value is true.

<http_connector>, <https_connector>, <ajp_connector>

All keys specified in connector sections are passed through to the corresponding connector. The possible configuration parameters and their behavior are described at http://tomcat.apache.org/tomcat-6.0-doc/config/http.html.

http://tomcat.apache.org/tomcat-6.0-doc/apr.html


Configuring the NIS Database Connection Pool


NIO Connector Example

The following is an example configuration that uses the NIO connector to handle HTTP requests on port 80. Some parameters for the connector's behavior are fine-tuned in this example:

<setup>

...

http_port = 80

http_max_threads = 200

http_protocol = org.apache.coyote.http11.Http11NioProtocol

<http_connector>

minSpareThreads = 200

acceptorThreadCount = 1

processorCache = 200

maxKeepAliveRequests = 1

acceptCount = 300

connectionTimeout = 60000

</http_connector>

...

</setup>

Note: You can verify that the updated configuration is applied by setting the com.nimsoft.nimbus.probe.service.wasp.Probe logger to level 3, and then restarting wasp. If your changes took effect, the log file will show the values you configured.


To configure the behavior of wasp's database connection pool, you can add or edit several parameters in the <dbcp> section, which is under the <setup> section of the wasp configuration. This section provides examples of these parameters in use.

The possible configuration options are described at http://tomcat.apache.org/tomcat-6.0-doc/jndi-resources-howto.html#JDBC_Data_Sources.

http://tomcat.apache.org/tomcat-6.0-doc/jndi-resources-howto.html#JDBC_Data_Sources

http://tomcat.apache.org/tomcat-6.0-doc/jndi-resources-howto.html#JDBC_Data_Sources


32 wasp Guide

Connection Validation Example

The following is an example that configures the database connection pool to run the SQL query SELECT 1 before the web application borrows the connection. If the test query fails, the pool will try to find another working connection.

<setup>

…

<dbcp>

validationQuery = SELECT 1

testOnBorrow = true

</dbcp>

…

</setup>

Web Application-Specific Connection Pool Example

You can also use the <dbcp> section under individual web applications. In the following example, the initialSize parameter specifies the number of connections that the connection pool creates upon startup.

<webapps>

<ROOT>

…

<jdbc>

<1>

name = jdbc/LiferayPool

<dbcp>

initialSize = 20

</dbcp>

…

</1>

</jdbc>

</ROOT>

nimsoft monitor wasp guidedocs.nimsoft.com/.../catalog/wasp/3.1/wasp-3.1.pdf · chapter 1: wasp 3.1...

Documents