wasp IM GUI Reference

Contents
uimpga-ga
wasp_IM
 
Contents
 
 
 
You can configure the probe by double-clicking it in Infrastructure Manager. This launches the probe configuration UI.
  wasp_Setup_tab  
The wasp window consists of two tabs:
  •  
    Setup tab
    Allows you to specify data and communication sources, and logging parameters for 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.
  wasp_Setup_tab_general_logging_tabs2  
The General Tab
This tab allows you to change many of the parameters found in the <setup> section of the wasp configuration window.
  wasp_General_tab  
  •  
    Log Level
    Sets the level of detail for messages in the wasp.log file.
     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.
  •  
    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 UIM 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 seconds the pool waits 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 UIM 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.
     At least one port must be configured. Raw Configure provides additional port configuration options for wasp.
  •  
    Java startup parameters
    Sets the default and maximum heap size at startup for the Java Virtual Machine (JVM) running wasp.
  •  
    Nimpool
    These parameters define the properties of the UIM bus request pool. The UIM bus request pool is used to maximize performance when multiple requests are made to the same probe.
     Web applications must use the Nimpool Library in order to use the following Nimpool parameters.
  •  
    Probe addresses
    Specifies addresses for the data_engine and dashboard_engine probes.
  •  
    Extra Java VM arguments
    Allows you to enter additional JVM arguments which are passed directly to the Java command line during wasp startup.
The Logging Tab
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.
 
  wasp_Logging_tab_Edit_logger  
The Webapps Tab
The Webapps tab lists the available web applications that wasp controls. To edit the default parameters of a web application, select the web application, then right-click inside the pane and select 
Edit
.
  wasp_Webapps_tab_right-click  
This launches the 
WebApp
 dialog.
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.
  wasp_webapp_General_tab  
 
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.
  • 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
.
  wasp_webapp_JDBC_tab  
This launches the 
JDBC driver dialog
.
  •   wasp_JDBC_driver_for_webapp  
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.
  •  
    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 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
.
  wasp_Webapps_tab_Logging_tab_edit  
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.
  wasp_webapp_Custom_tab_edit  
Advanced Configuration Settings
This section describes how to use Raw Configure, which allows you to modify additional configuration settings for the probe.
 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
    .
    WASP--Raw Configure for wasp  
  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.
  WASP--Raw Configure for wasp (2)  
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. 
 
 
logsize
 
Sets the size of the wasp.log file in KB until it rolls over. The default size is 100 KB.
 log_size is a duplicate for this key, but is given precedence if present.
 
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 UIM bus request pool, and can also be set under 
Nimpool
 in the wasp configuration UI. .
 
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.
 
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.
 
http_port, https_port, ajp_port
 
Specifies the protocols and corresponding ports wasp uses for incoming connections.
 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 article Implement HTTPS in UMP 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 articles Configure Multiple UMP Servers 
and Set up Access to UMP through a DMZ 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.
dbcp
<dbcp> is a section within the <setup> section, and allows you to pass through additional configuration parameters for the UIM database connection pool.
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 in the section below.
ump_common
The ump_common raw configure folder contains the addresses for other required probes.
Configure the 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.
 Do not attempt to modify the parameters described in this section unless you are proficient with Tomcat web server. Refer to and other Tomcat resources for additional information.
  •  
    http_port, https_port, ajp_port
    Specifies the protocols and corresponding ports wasp uses for incoming connections.
  •  
    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
    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.
       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.
    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 .
  •  
    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 .
 
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>
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.
Configure the CA UIM Database Connection Pool
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.
 
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>
Configure Account Lock
Bad actors can use brute-force methods to guess your users' passwords and log in through the UMP portal. Use the account lock feature to prevent such bad actors. The following values can be configured in the wasp.cfg file:
  •  
    account_lock_enabled
     - Enables the account lock feature. Set the value to True to enable the account lock feature. Default: False
  •  
    reset_account_lockout_after
     - Resets the account lockout after n minutes. Default: 5
  •  
    account_lockout_threshold
     - Attempts to login before the account is locked out. Default: 5
Enable Account Lock Feature
You need to enable the account lock feature manually by modifying the wasp.cfg.
 
Follow these steps:
 
  1. Navigate to the system where wasp is installed.
  2. Navigate to the 
    wasp.cfg
     file located in the following location:
    <UMP or UIM server_Installation>\Nimsoft\probes\service\wasp\wasp.cfg
     
  3. Open the 
    wasp.cfg
     file in a text editor.
  4. Locate the 
    account_lock_enabled
     key. By default, the 
    account_lock_enabled
     key is set to False.
  5. Restart the wasp probe.