vrealize hyperic resource configuration and metrics ......vrealize hyperic resource configuration...

vRealize HypericResource Configurationand MetricsvRealize Hyperic 5.8.4

vRealize Hyperic Resource Configuration and Metrics

VMware, Inc. 2

You can find the most up-to-date technical documentation on the VMware website at:

https://docs.vmware.com/

If you have comments about this documentation, submit your feedback to

[email protected]

Copyright © 2014 VMware, Inc. All rights reserved. Copyright and trademark information.

VMware, Inc.3401 Hillview Ave.Palo Alto, CA 94304www.vmware.com

https://docs.vmware.com/mailto:[email protected]://pubs.vmware.com/copyright-trademark.html

Contents

About vRealize Hyperic 5.8 Configuration and Metrics Guide 9

1 Java Applications 10

Prerequisites and Supported Environments 11

Create an MBean Server in Tomcat 12

Create an MBean Server for a Standalone Application or Other Container 12

Enable Model MBean Export in JBoss Containers 12

Configuring Application Services as a vRealize Operations Manager Application 13

Model MBean Names and Descriptors 15

2 Configuring a tc Server Instance 21

Configure tc Runtime Parameters 21

Spring Insight 30

Managing tc Server Applications 38

Managing tc Runtime JDBC Reference Parameters 50

Managing tc Runtime Services Reference Parameters 54

SpringSource tc Runtime 6.0 Server 60

SpringSource tc Runtime 7.0 Server 71

3 PostgreSQL 84

Supported Versions and Requirements 85

Configuring PostgreSQL 85

Resource Types and Management Functions 87

vPostgreSQL 9.x Server 89

PostgreSQL 9.x Server 94

PostgreSQL 8.x Server 99

4 WebLogic Server 105

WebLogic Configuration Overview 106

Configure WebLogic Server Monitoring 107

Weblogic 9.1 Server 108






Weblogic Admin 9.1 Server 190


VMware, Inc. 3





Weblogic NodeManager 9.1 Server 273






5 RabbitMQ 276

Supported Versions and Requirements 276

RabbitMQ Resources and the vRealize Hyperic Inventory Model 277

SSL Requirements 278

RabbitMQ Configuration Instructions 278

RabbitMQ Resource Types and Management Functions 280

6 GemFire 293

GemFire Resources and the vRealize Hyperic Inventory Model 294

GemFire Configuration Overview 295

GemFire Resource Types and Management Functions 295

GemFire Configuration Instructions 303

GemFire Metric Documentation 306

GemFire Events 309

vRealize Hyperic GemFire View 310

7 Network Platform Services 312

Configuration Requirements and Options for Monitoring Network Services 313

Metrics for Network Services 313

Classes for Monitoring a Network Service 314

Services vRealize Hyperic Can Monitor Over the Network 314

8 Local Platform Services 364

Create a Platform Service 364

Configuration Instructions for Platform Services 365

Event Tracking 367

9 FileServer Directory Service 368

Create FileServer Directory Service 368

FileServer Directory Service Configuration Options 369

FileServer Directory Service Metrics 369


VMware, Inc. 4

10 FileServer Directory Tree Service 370

Create FileServer Directory Tree Service 370

FileServer Directory Tree Service Configuration Options 371

FileServer Directory Tree Metrics 371

11 FileServer File Service 372

Create FileServer File Service 372

FileServer File Service Configuration Options 373

FileServer File Service Metrics 373

12 FileServer Mount Service 374

Create FileServer Mount Service 374

FileServer Mount Service Configuration Options 375

FileServer Mount Service Metrics 375

13 Multiprocess Service 376

Create a Multiprocess Service 376

Multiprocess Service Configuration Options 377

Multiprocess Service Metrics 377

Specifying Multiprocess Queries 378

14 Process Service 379

Specifying Process Queries 379

Create a Process Service 380

Process Service Configuration Options 380

Process Service Metrics 381

Process Controls 381

15 Script Service 383

Create a Script Service 383

Script Service Configuration Options 384

Script Service Metrics 384

16 CPU Service 385

CPU Service Metrics 385

17 NetworkService Interface Service 386

NetworkServer Interface Service Metrics 386

18 Windows Service 388

Windows Service Plugin Function 388


VMware, Inc. 5

Configure the Windows Service 388

Windows Service Metrics 389

Define Windows Service Monitoring Defaults 389

19 Sun JVM 390

Step 1 - Configure JVM for JMX Monitoring 390

Step 2 - Add JVM to Inventory 390

Step 3 - Configure JVM for Monitoring 391

Sun JVM Events 391

20 WebSphere MQ 428

Installation Path 428

WebSphere MQ Metrics 428

21 WebSphere 441

WebSphere Resources and the Hyperic Inventory Model 442

WebSphere Configuration Instructions 442

WebSphere Management Functions 444

WebSphere Metric Documentation 445

22 JBoss 470

JBoss Configuration Tracking 470

JBoss Metrics 471

23 Network Device 570

Network Device Resources and the vRealize Hyperic Inventory Model 570

Network Device Configuration Instructions 571

Privileges Required for Default SNMP Port 574

Network Device Management Functions 575

24 Microsoft SQL Server 581

Microsoft SQL Configuration Instructions 582

Microsoft SQL Resource Types and Management Functions 583

Microsoft SQL Server Metrics 584

25 vFabric Web Server 601

vFabric Web Server Configuration Instructions 601

vFabric Web Server Resource Types and Management Functions 603

vFabric Web Server Metrics 603

26 Hyper-V Plug-in 609


VMware, Inc. 6

27 Microsoft Exchange 612Microsoft Exchange Configuration Instructions 613

Microsoft Exchange Resource Types and Management Functions 614

Microsoft Exchange Metrics 614

28 Microsoft Active Directory 659

Microsoft Active Directory Server Metrics 659

Microsoft Active Directory LDAP Service Metrics 660

Microsoft Active Directory Authentication Service Metrics 661

29 Microsoft IIS 663

Configure vRealize Hyperic to Manage IIS 664


Microsoft IIS 8.x Server Metrics 665





30 Sharepoint 723

SharePoint Supported Versions and Requirements 723

Configuring SharePoint to Work with vRealize Hyperic 723


SharePoint 2010 server 725

SharePoint 2007 server 747

31 Managing tc Server Runtime-Related Alerts 760

tc Server User Permissions 760

Viewing and Changing Preconfigured Alerts 761

32 Preconfigured tc Server Runtime-Related Alerts 764

Change a tc Server Plug-in Metric Collection Interval 764

tc Server Deadlock Detection 765

Excessive Time in Garbage Collection 765

Enable a tc Server Slow or Failed Request Alert 765

Enable JDBC Connection Monitoring 766

33 tc Server Plug-in Metrics 767

34 tc Server Plug-in Troubleshooting 777

Resources Do Not Appear in User Interface 777

Unable to Add Auto-Discovered Resource to vRealize Hyperic Server 778


VMware, Inc. 7

Errors Returned when Starting the vRealize Hyperic Agent on Solaris Platforms 778

Unable to Hot Redeploy Application on Windows 779


VMware, Inc. 8

About vRealize Hyperic 5.8 Configurationand Metrics Guide

The vRealize Hyperic 5.8 Configuration and Metrics Guide documents the configuration requirements andmetrics available for selected VMware vRealize Hyperic product plug-ins. This guide supplements thevRealize Hyperic Administration Guide.

Intended AudienceThis information is intended intended for operations personnel who set up and support thevRealize Hyperic infrastructure.

VMware, Inc. 9

Java Applications 1The vRealize Operations Manager agent can auto-discover and manage Java application services thatadhere to a specified ObjectName naming convention and expose a specified set of service data, usingthe Model MBeans.

You must configure your system to enable vRealize Operations Manager monitoring.

Auto-discovery of Custom MBeansAuto-discovery of custom MBeans enables you to monitor application services, and the hostingapplication server and its internal services.n Prerequisites and Supported Environments

Verify that your environment meets the specific requirements for vRealize Operations Manager auto-discovery and management for Java application services.

n Create an MBean Server in Tomcat

If you have not already set up an MBean server, configure one, together with a JSR-160 connector.

n Create an MBean Server for a Standalone Application or Other Container

You can create a MBean server for an application that runs as standalone, or for a container.

n Enable Model MBean Export in JBoss Containers

To ensure that MBeans are exported as a model Type, and that vRealize Operations Managerdiscovers running services, you must edit the jmx-invoker-service.xml file.

n Configuring Application Services as a vRealize Operations Manager Application

Configuring application services as a vRealize Operations Manager application requires you toprepare the environment and configure the application.

n Model MBean Names and Descriptors

Use this information to name your model MBeans and their descriptors.

VMware, Inc. 10

Prerequisites and Supported EnvironmentsVerify that your environment meets the specific requirements for vRealize Operations Manager auto-discovery and management for Java application services.

Java VersionAuto-discovery of services exposed as Model MBeans requires JRE version 1.5 or later, or JDK version1.5 or later.

Supported ContainersThe capability is supported for applications running in:

n Tomcat 5.5, or later

n WebLogic 9.1, or later

n WebSphere 5.0, or later

n JBoss 3.2, or later

n SpringSource dm Server 1.0, or later

n SpringSource tc Server 6.0, or later

n Other containers that expose a JSR-160 connector

Enable Discovery of a Stand-Alone Instrumented Java ApplicationFollow this process to enable MBean discovery in a stand-alone Java application.

Procedure

1 Instrument your code as specified in Model MBean Naming and Descriptor Data, or use Springframework instrumented JAR files.

2 Start the application with the spring.managed.application.name system property.

For example,

java -Dcom.sun.management.jmxremote -

Dspring.managed.application.name="MyApplicationName" com.sample.MyApp

The application name is set as the name of the discovered resource. For example, when using the codeexample in the procedure, the application name is set as MyApplicationName.


VMware, Inc. 11

Create an MBean Server in TomcatIf you have not already set up an MBean server, configure one, together with a JSR-160 connector.

You create an MBean Server and associated JSR-160 connector by setting the relevant systemproperties at JVM startup.

Procedure

1 Open the Tomcat catalina.shstart script catalina.sh, in the $TOMCAT_HOME/bin/ directory in atext editor.

2 Add the following properties:

[ $1!= "stop" ] && JAVA_OPTS="-Dcom.sun.management.jmxremote \

-Dcom.sun.management.jmxremote.port=6969 \

-Dcom.sun.management.jmxremote.ssl=false \

-Dcom.sun.management.jmxremote.authenticate=false $JAVA_OPTS"

export JAVA_OPTS

3 Save the file.

Create an MBean Server for a Standalone Application orOther ContainerYou can create a MBean server for an application that runs as standalone, or for a container.

Procedure

1 Open the application or container start script in a text editor and set the following JMX remote systemproperties.

-Dcom.sun.management.jmxremote \

-Dcom.sun.management.jmxremote.port=6969 \

-Dcom.sun.management.jmxremote.ssl=false \

-Dcom.sun.management.jmxremote.authenticate=false \

2 Save the file.

The system properties create a local MBean server and remote connector.

Enable Model MBean Export in JBoss ContainersTo ensure that MBeans are exported as a model Type, and that vRealize Operations Manager discoversrunning services, you must edit the jmx-invoker-service.xml file.

Procedure

1 Open the JBOSS_HOME/server/default/deploy/jmx-invoker-service.xml file in a text editor.


VMware, Inc. 12

2 Comment out the following entry:

3 Save the file.

Configuring Application Services as avRealize Operations Manager ApplicationConfiguring application services as a vRealize Operations Manager application requires you to preparethe environment and configure the application.

Procedure

1 Prepare to Configure Application Services as a vRealize Hyperic Application

Before you can configure application services as one

2 Configure Application Services as a vRealize Hyperic Application

You can create a vRealize Hyperic application that groups discovered application services.

Procedure

u

Prepare to Configure Application Services as a vRealize HypericApplicationBefore you can configure application services as one

Prerequisites

n Each Java class or service must instantiate Model MBeans that meet the requirements described in Model MBean Naming and Descriptor Data.

n The vRealize Hyperic agent managing the server instance where your application runs shoulddiscover model MBeans in the MBean server that meet the requirements specified in Model MBeanNaming and Descriptor Data.The server instance that hosts the application appears in the Auto-Discovery portlet on the dashboard of the vRealize Hyperic user interface. After you import the new orchanged server instance to inventory, you can browse to the application services, which appear aschildren of the host server.

Procedure

1 Set up the resources to export model MBeans

If your applications run with Spring-instrumented JARs, they should automatically export modelMBeans with the required name format and descriptors. If your applications expose MBeans usingthe Spring 3.0 JMX annotations (@ManagedResource, @ManagedMetric, @ManagedAttribute,@ManagedOperation), they should automatically be exported with the required descriptors.


VMware, Inc. 13

2 Redeploy your application after enabling export of Model MBeans

To verify that your application services have instantiated model MBeans, use a JMX client to browsethe MBean server.

3 Verify the model MBean export to the MBean server.

4 Verify the service application auto-discovery.

The server instance that hosts the application appears in the Auto-Discovery portlet on the dashboardof the vRealize Hyperic user interface. After you import the new or changed server instance toinventory, you can browse to the application services, which appear as children of the host server.

5 (Optional) Solve problems with service auto-discovery.

If your application services were not discovered, perform some verifications.

a Verify that the hosting application server is enabled for remote JMX remote access.

b Verify that the JMX URL, username, and password properties for the server were auto-discoveredby the vRealize Hyperic agent, or were entered manually.

n If the agent auto-discovered the JMX properties, they appear on the Configuration Propertiespage for the server instance.

n If the agent did not discover the JMX properties, an authorized vRealize Hyperic user mustspecify them on the server instance's Configuration Properties page.

Configure Application Services as a vRealize Hyperic ApplicationYou can create a vRealize Hyperic application that groups discovered application services.

Prerequisites

You must have completed the Prepare to Configure Application Services as a vRealize HypericApplication task.

Procedure

1 In the vRealize Hyperic interface, click Resources > Browse.

2 From the Tools menu, select Application.

3 Type a name for the application in the Name text box and click OK.

4 In the Services section, click Add to List.

The left column on the Edit page for the application lists all of the services in vRealize Hyperic thatyou have permission to view.

When the application name has been specified in ObjectName, the name of a discovered applicationservice includes the name of the application, as specified in the associated model MBean'sObjectName.

5 (Optional) Filter the list by typing a string in the Filter By Name text box, and click the green arrow.


VMware, Inc. 14

6 Select and move the services to add to the application to the right column, and click OK.

Model MBean Names and DescriptorsUse this information to name your model MBeans and their descriptors.

n Model MBean Naming and Descriptor Data

There are various descriptors that Model MBeans must expose to enable a vRealize Hyperic agentto discover and manage Java application resources.

n ModelMBeanInfo Descriptors

Follow these guidelines when specifying ModelMBeanInfo descriptors.

n ModelMBeanAttributeInfo Descriptors

Follow these guidelines when specifying ModelMBeanAttributeInfo descriptors.

n ModelMBeanOperationInfo Descriptors

Follow these guidelines when specifying ModelMBeanOperationInfo descriptors.

Model MBean Naming and Descriptor DataThere are various descriptors that Model MBeans must expose to enable a vRealize Hyperic agent todiscover and manage Java application resources.

Key Facts About Model MBeans and Service Discoveryn vRealize Hyperic translates ModelMBeanInfo into service metadata, ModelMBeanAttributeInfo

into a custom property or metric metadata, and ModelMBeanOperationInfo into control actionmetadata.

n All MBean instances with the same type must have the same attributes, metrics, and operations. Ifthe metadata for a service type changes, the type will be updated in vRealize Hyperic and anyexisting service instances will be deleted and redeployed.

n A service type cannot be deleted from vRealize Hyperic.

Model MBean ObjectName FormatAn ModelMBean's ObjectName must have this format:

spring.application:application=%application%,type=%type%,name=%name%*


VMware, Inc. 15

where:

application The name of the application that contains the resource. If defined, forms aportion of the service name in vRealize Hyperic. Application is optional inthe objectname.

type The vRealize Hyperic service type for the resource. When vRealize Hypericcreates the service to add to inventory, this is the service type that it will beassigned. The value of type also forms a portion of the service name invRealize Hyperic. Type is mandatory in the objectname.

name An identifier that forms a portion of the name of the service invRealize Hyperic. The service name also includes: name of the platform onwhich the service runs, the value of application if specified, and thevRealize Hyperic server type on which the service runs. The order in whichthese components are concatenated into a name varies according to thetype of server on which the service runs. Name is mandatory in theobjectname.

For an MBean whose ObjectName is:

spring.application:application=swf-booking-mvc,

type=MessageListener,name=bookingMessageListener

the vRealize Hyperic agent creates a service in vRealize Hyperic for which:

n Service type is MessageListener

n Name is Platform Name Apache Tomcat 6.0 swf-booking-mvc bookingMessageListenerMessageListener


VMware, Inc. 16

ModelMBeanInfo DescriptorsFollow these guidelines when specifying ModelMBeanInfo descriptors.

Table 1‑1. ModelMBeanInfo DescriptorsModelMBean Field Description Type Requirements Default Value

ModelMBeanInfo.getDescription()

The friendly descriptionof the service

String Must not be null N/A

ModelMBeanInfo.getMBeanDescriptor().getField("typeName")

If supplied, suppliesthe service type for theservice to be created invRealize Hyperic,overriding the defaultvalue - the value oftype from the service'sObjectName.

String Optional Value of the typeproperty in theresource's ObjectName.

ModelMBeanInfo.getMBeanDescriptor().getField("export")

Can be used to preventthe agent from creatinga service for theMBean invRealize Hypericinventory.

String Must be set to True orFalse.

True

ModelMBeanAttributeInfo DescriptorsFollow these guidelines when specifying ModelMBeanAttributeInfo descriptors.

The vRealize Hyperic agent interprets ModelMBeanAttributeInfo as property or metric data. If themetricType descriptor is defined, vRealize Hyperic interprets the data as a metric.

An attribute that represents a property must be JMX SimpleType or an array of JMX SimpleTypes.

An attribute that represents a metric must be numeric JMX SimpleType.


VMware, Inc. 17

Table 1‑2. ModelMBeanAttributeInfo DescriptorsModelMBean Field Description Type Expected Format Default Value

ModelMBeanAttribute

Info.

getDescription()

Description of theproperty or metric.

Note In thevRealize Hyperic userinterface, a property isidentified by itsdescription.

String Must not be null. N/A

ModelMBeanAttribute

Info.

getDescriptor().

getField("metricCat

egory")

Category of a Metric String Allowable values:n PERFORMANCE - a

metric thatprovides time-related information.For example,average elapsedtime per methodcall.

n UTILIZATION - ametric thatindicates resourceusage. Forexample, memoryusage, cache size,thread pool size.

n THROUGHPUT - ametric thatindicates theamount of workdone over a periodof time. Forexample,transactions persecond.

UTILIZATION

ModelMBeanAttribute

Info.

getDescriptor().

getField("displayNa

me")

Name that uniquelyidentifies the metric fora service type.

String This value is used touniquely identify themetric per service type.

Defaults to the name ofthe ModelMBeanattribute.

getDescriptor().

getField("indicator

")

Designates a metric asan Indicator invRealize Hyperic.Indicators arepresented on aresource's Indicatorpage invRealize Hyperic.

String If set to true, the metricis an Indicator, and iscollected by default.

True


VMware, Inc. 18

Table 1‑2. ModelMBeanAttributeInfo Descriptors (Continued)ModelMBean Field Description Type Expected Format Default Value

ModelMBeanAttribute

Info.

getDescriptor().

getField("metricTyp

e")

Indicates how thevalue of the metricchanges over time.

The presence of thisfield indicates theMBeanAttribute is ametric. If not set, theattribute will beconsidered a customproperty.

vRealize Hyperic setsthe collection intervalfor a metric based onthe value ofmetricType.

Counter metrics arecollected every 10minutes.

Gauge metrics arecollected every 5minutes.

String The JMX specificationrequires metricTypehave a value of either:n counter - a metric

whose value doesnot decreaseunless it is reset toa starting value."Number ofrequests received"is an example of acounter metric.Counter metricsusually have apositive integervalue.

n gauge - a metricwhose value caneither increase ordecrease. CacheHit Rate is anexample of agauge metric.

Gauge

ModelMBeanAttribute

Info.

getDescriptor().

getField("units")

The unit in which anmetric is measured.

String Hyperic specifies theseallowable values:n B- Bytes

n KB - Kilobytes

n MB - Megabytes

n GB - Gigabytes

n TB - Terabytes

n epoch-millis - Timesince January 1,1970 inmilliseconds.

n epoch-seconds -Time since January1, 1970 inseconds.

n mu - Microsecondsn MS - Milliseconds.n jiffys - Jiffies

(1/100 sec)n s - Seconds.n cents - Cents

(1/100 of 1 USDollar)

None, if not specified orif set to an unrecognizedunit.


VMware, Inc. 19

ModelMBeanOperationInfo DescriptorsFollow these guidelines when specifying ModelMBeanOperationInfo descriptors.

ModelMBean operation return values and parameters must be JMX SimpleType or arrays of JMXSimpleTypes.

Table 1‑3. ModelMBeanOperationInfo DescriptorsModelMBean Field Description Types Expected Format Default Value

ModelMBeanOperation

Info.

getDescription()

The friendly descriptionof the Operation

String Must not be null. N/A


VMware, Inc. 20

Configuring a tc Server Instance 2This section provides information about configuring a tc Server instance.

The features described in this section are available in tc Server and tc Server Standard Edition.

This section includes the following topics:

n Configure tc Runtime Parameters

n Spring Insight

n Managing tc Server Applications

n Managing tc Runtime JDBC Reference Parameters

n Managing tc Runtime Services Reference Parameters

n SpringSource tc Runtime 6.0 Server

n SpringSource tc Runtime 7.0 Server

Configure tc Runtime ParametersYou can configure the tc Runtime parameters.

n Making Configuration Changes

vRealize Hyperic populates the fields of the tc Runtime configuration pages from the its configurationfiles.

n User Permissions Required to Use the tc Runtime Features

A vRealize Hyperic super-user can use all the tc Runtime features of the vRealize Hypericuserinterface. A user who logs on to the user interface as a non-super-user, requires specificpermissions to be able to use the tc Runtime features.

n Configure General tc Runtime Options

You can configure general tc Runtime options, including changing the shutdown port and shutdowncommand.

n Configure Startup Options

You can configure tc Runtime Start settings, including configuring the JVM where the instance runs,minimum and maximum heap size, garbage collection, and debugging.

VMware, Inc. 21

n Configuring the Context Container

Use this page to configure the context for every Web application deployed to this tc Runtimeinstance.

n Configuring Static Content Defaults

You can configure the behavior of static content in Web applications that run on tc Runtime.

n Using the Advanced Server Configuration Options

You can make advanced server configurations.

n Create and Configure JDBC Data Sources

JDBC datasources enable you to access data in a database server. You can create a new JDBCdatasource, or edit an existing one.

n Create and Configure tc Runtime Services

A tc Runtime service represents the combination of connector components that share a singleengine component for processing incoming requests.

n Create and Configure Connectors

Connectors represent the interface between external clients sending requests to (and receivingresponses from) a particular tc Runtime service.

n Create and Configure Virtual Hosts

A tc Runtime host represents a virtual host, which is an association of a network name for a serverand the specific machine that hosts the tc Runtime instance.

n Configure tc Runtime Logging

You can configure the logging system for the current engine.

Procedure

1 In the vRealize Hyperic user interface, select Resources > Browse.

2 Click the Servers link to list all the tc Runtime instances in inventory.

tc Runtime instances have the server type SpringSource tc Runtime VersionNumber andApache Tomcat instances have the server type Tomcat X.X.

3 Click the name of the tc Runtime instance to which you want to navigate.

4 Click Views > Server Configuration.

There are four tc Runtime configuration pages, three of which have their own tab beneath the mainViews > Server Configuration tab.

Configuration Page Configure general tc Runtime options, such as JVM options, JSPbehavior, and default options for static content.

Resources Page Create, configure, and delete JDBC data sources.


VMware, Inc. 22

Services Page Configure the default Catalina service, and create new services. A tcRuntime service groups together one or more connectors and a singleengine. The engine, in turn, groups together one or more virtual hosts.

Advanced Page Enables you to reload, revert, or upload server configurations.

Making Configuration ChangesvRealize Hyperic populates the fields of the tc Runtime configuration pages from the its configurationfiles.

The files include:

n conf/server.xml

n conf/context.xml

n conf/web.xml

n bin/setenv.sh

n conf/catalina.properties

n conf/logging.properties

Each configuration page includes a Save button for saving the changes made in the user interface to thetc Runtime configuration files. If you try to navigate to a different page without saving your updates,vRealize Hyperic asks you if you want to leave the page and lose these updates.

When you save your changes, a window labeled Changes have been made locally is displayed untilyou either

n Click Push- this writes the configuration changes you have made to the appropriate tc Runtimeconfiguration file (such as server.xml). If you push the changes, vRealize Hyperic overwrites theexisting configuration after saving a backup of the configuration as it was before the changes. Mostsaved changes to the tc Runtime configuration require a server restart to take effect.vRealize Hypericflags these cases and provides a link to restart the tc Runtime.

n Click Undo - this reverts all changes that have been made since the last push or undo.

If you update tc Runtime configuration settings from the vRealize Hyperic user interface, do not manuallyupdate the tc Runtime configuration files at the same time. vRealize Hyperic clears its local memory andreloads the configuration files upon certain events, not continuously.

User Permissions Required to Use the tc Runtime FeaturesA vRealize Hyperic super-user can use all the tc Runtime features of the vRealize Hypericuser interface.A user who logs on to the user interface as a non-super-user, requires specific permissions to be able touse the tc Runtime features.

In vRealize Hyperic, users are assigned roles that have associated permissions, such as View andControl.


VMware, Inc. 23

Use this table to determine which role you should assign a user that will be managing tc Runtimeinstances.

Table 2‑1. vRealize Hyperic Roles and PermissionsPermission Additional Effect on tc Server HQ Plug-in Features

View Allows a user to:n View the deployed Web applications in the Views >

Application Management tab .n View the current configuration of a tc Runtime instance in

the Views > Server Configuration tab.

Modify Allows a user to:n Use the application life-cycle commands of theViews >

Application Management tab to start, stop, reload, orundeploy a Web application.

n Update the fields in theViews > Server Configuration taband then push the data to the configuration files associatedwith the tc Runtime instance, such as server.xml.

Control Allows a user to use the commands in the Control tab to start,stop, and restart a tc Runtime instance.

Configure General tc Runtime OptionsYou can configure general tc Runtime options, including changing the shutdown port and shutdowncommand.

Procedure

1 Click the General link on the Configuration tab of the tc Runtime configuration page.

2 Make your changes.

3 Click Save.

What to do next

To write your changes to the tc Runtime configuration files, click Push in the Changes have been madelocally window. See Making Configuration Changes.

Configure Startup OptionsYou can configure tc Runtime Start settings, including configuring the JVM where the instance runs,minimum and maximum heap size, garbage collection, and debugging.

vRealize Hyperic populates the tc Runtime Start page with information from theCATALINA_HOME/bin/setenv.sh file of the server instance you are configuring, specifically theJVM_OPTS environment variable. If you have not set the JVM_OPTS environment variable in this file, thefields in the Server Start page are empty.


VMware, Inc. 24

You can add your own command line arguments to the JVM. Take care when adding your own argumentsbecause vRealize Hyperic does not validate the options, but only adds them to the Java command thatstarts the tc Runtime instance. If you add them incorrectly, an error is returned when you start the tcRuntime instance.

Procedure

1 Click the Server Start link on the Configuration tab of the tc Runtime configuration page.


You can add your own JVM command line arguments by clicking the Advanced link and enter thearguments in the form -Xoptionvalue or -XX:option=value, separating options with a space.

3 Click Save.

What to do next

Click Push in the Changes have been made locally window to write your changes to the tc Runtimeconfiguration files. See Making Configuration Changes.

Configuring the Context ContainerUse this page to configure the context for every Web application deployed to this tc Runtime instance.

Procedure

1 Click the Context Container link on the Configuration tab of the tc Runtime configuration page.


3 Click Save.

What to do next


Configuring Static Content DefaultsYou can configure the behavior of static content in Web applications that run on tc Runtime.

Procedure

1 Click the Server Defaults: Static Content link on the Configuration tab of the tc Runtimeconfiguration page.


3 Click Save.

What to do next



VMware, Inc. 25

Using the Advanced Server Configuration OptionsYou can make advanced server configurations.

The Advanced section of the main Server Configuration tab includes options for reverting or reloadingconfiguration values in the event that you do not want to save any of the recent updates you made usingthe vRealize Hyperic user interface.

The Advanced section also includes an option to upload a local configuration file in its entirety, forexample, server.xml. The following sections provide more information about these options. Use cautionwhen implementing any of these options.

n Reload Settings From Server

You can undo changes that you made to the tc Runtime via the vRealize Hyperic by reloadingsettings from the server.

n Revert to a Previously Saved Configuration

Each time you push changes from the vRealize Hyperic user interface to the tc Runtimeconfiguration files, the tc Server plug-in makes a time-stamped backup copy of the previousconfiguration before overwriting the relevant configuration file .

n Upload a Configuration File

You can use the Upload a Configuration File link to upload a local configuration file and copy it tothe appropriate tc Runtime instance directory.

Reload Settings From ServerYou can undo changes that you made to the tc Runtime via the vRealize Hyperic by reloading settingsfrom the server.

Procedure

u Click the Reload Settings From Server link to reload the server configuration currently contained inthe tc Runtime configuration files.

All local changes to the tc Runtime instance that you have not yet pushed to the instance are lost.

Revert to a Previously Saved ConfigurationEach time you push changes from the vRealize Hyperic user interface to the tc Runtime configurationfiles, the tc Server plug-in makes a time-stamped backup copy of the previous configuration beforeoverwriting the relevant configuration file .

With this option, you can revert back to the most recent backup copy in the event that there was aproblem with the most recent changes that you pushed. If you revert to a backup copy, any local changesto the current tc Runtime instance made using the user interface are lost.

If you have not pushed configuration changes from the user interface to the tc Runtime instance, nobackup file exists to which the tc Server plug-in can revert.


VMware, Inc. 26

Procedure

u Click the Revert To a Previously Saved Configuration link to revert to the most recent backup copyof the tc Runtime configuration.

Upload a Configuration FileYou can use the Upload a Configuration File link to upload a local configuration file and copy it to theappropriate tc Runtime instance directory.

Procedure

1 Click the Upload a Configuration File link.

You can use the Browse button to browse for the file on your local computer.

2 From the Configuration File list, specify the type of configuration file you are uploading.

3 Copy the file to the appropriate tc Runtime instance directory.

The tc Server plug-in creates a time-stamped backup copy of the current configuration file before itoverwrites it with the one you uploaded. In the event that you do not want to use the uploadedconfiguration file, you can revert to the backup copy.

Create and Configure JDBC Data SourcesJDBC datasources enable you to access data in a database server. You can create a new JDBCdatasource, or edit an existing one.

A datasource defines a pool of JDBC connections that, in turn, connect to a specific database using aspecified URL, username, and so on.

You can create two types of JDBC data sources:

Database ConnectionPool Datasource

The Database Connection Pool (DBCP) datasource is the standarddatasource provided by tc Runtime that uses the commons-dbcp package.Although this datasource is adequate for simple applications, it is single-threaded which means that, in order to be thread-safe, tc Runtime mustlock the entire pool, even during query validation. As a result, thedatasource is not suitable for highly concurrent environments. Thedatasource can also be slow, which can negatively affect the performanceof Web applications.

Tomcat Datasource The Tomcat datasource includes all the functionality of the DBCPdatasource, but adds features to support highly-concurrent environmentsand multiple core/CPU systems. The Tomcat datasource typically performsmuch better than the DBCP datasource.


VMware, Inc. 27

Additional features include:

n Dynamic implementation of the interfaces, meaning that the datasourcesupports the java.sql and javax.sql interfaces for your runtimeenvironment (assuming that is supported by your JDBC driver), evenwhen compiled with a lower version of the JDK.

n Validation intervals so that tc Runtime does not have to validate everytime that the application uses the connection, which improvesperformance.

n A Run-Once query, which is a configurable query that the tc Runtimeinstance runs only once when the connection to the database isestablished. This function is useful to configure session settings thatyou want to exist during the entire time the connection is established.

n Ability to configure custom interceptors to enhance the functionality ofthe datasource. You can use interceptors to gather query stats, cachesession states, reconnect the connection upon failures, retry queries,cache query results, and so on. The interceptors are dynamic and nottied to a JDK version of a java.sql/javax.sql interface.

n Asynchjava.sqlronous connection retrieval that enables you toqueue your request for a connection and receive a Future back.

Procedure

1 Click the JDBC Data Sources link on the Resources tab of the tc Runtime configuration page.

2 Select the action to perform.

n To create a new data source, click Create a New Tomcat/DBCP Data Source.

n To edit an existing data source, click its name in the table and make your changes.

3 Click Save.

What to do next

Click Push in the Changes have been made locally window to write your changes to the tc Runtimeconfiguration files. See Making Configuration Changes.

Create and Configure tc Runtime ServicesA tc Runtime service represents the combination of connector components that share a single enginecomponent for processing incoming requests.

A tc Runtime instance can have one or more services configured. The default service is catalina.

Procedure

1 Click the Services tab in the tc Runtime configuration pages.


VMware, Inc. 28


n To create a new service, click New Service.

n To edit an existing service, for example the default catalina service, click its name in theservices table and then configure, or add, any of the following components of the service.

n Connectors

n Engine

n Virtual Host

n Logging System

3 Click Save.

Create and Configure ConnectorsConnectors represent the interface between external clients sending requests to (and receivingresponses from) a particular tc Runtime service.

A tc Runtime instance can have one or more connectors, one for each supported message protocol. Thedefault connector, configured for each tc Runtime, is the HTTP connector.

You can configure, or create new connectors for the selected tc Runtime service.

Procedure

1 Select the service for which you want to create or configure a connector from the table in theServices tab.

2 Click the Connectors link in the list on the left.


n To create a new connector, click the New AJP Connector link, or the New HTTP(S) Connectorlink, depending on the type of connector you are creating.

n To edit an existing connector, click its name in the table and make your changes.

4 Click Save.

Create and Configure Virtual HostsA tc Runtime host represents a virtual host, which is an association of a network name for a server andthe specific machine that hosts the tc Runtime instance.

To be effective, the name must be registered in the Domain Name Service (DNS) server that managesyour Internet domain.

Procedure

1 Select the service for which you want to create or configure a virtual host from the table in theServices tab.


VMware, Inc. 29


n To create a new virtual host, click the New Host link.

n To edit an existing host, click its name in the table and make your changes.

3 Click Save.

Configure tc Runtime LoggingYou can configure the logging system for the current engine.

You can also configure logging for a host by configuring the specific Host component.

Procedure

1 Select the service for which you want to configure loggin from the table in the Services tab.

2 Click the Logging link in the list on the left.

3 Make your changes in the table.

4 Click Save.

Spring InsightThis section provides information on the nature and functions of Spring Insight.

Spring Insight Operations captures Web application events known as traces. A trace represents a threadof execution. Traces are usually started by an HTTP request but can also be started by a background job.A trace contains operations, which represent significant points in the execution of the trace, for example,a JDBC query or transaction commit. Insight Operations uses trace data to calculate summary informationthat helps identify the root cause of application performance issues.

Insight Operations has a two-tiered architecture that consists of Spring Insight Dashboard and SpringInsight agent. tc Server instances that run production Web applications run the Spring Insight agentapplication. Insight Agent collects trace data and sends it to a single, dedicated tc Runtime instancerunning Spring Insight Dashboard. Insight Dashboard provides a user interface for monitoring applicationsacross all servers and to get detailed statistics from individual servers.

n Functionality of Hyperic Spring Insight Plugin

This topic details the functionality of the vRealize Hyperic Spring Insight plugin.

n Spring Insight Supported Versions and Requirements

This section details the supported versions and requirements for the Spring Insight plugin.

n Spring Insight Resources and the Hyperic Inventory Model

This section details the resource types in Hyperic that map to managed Spring Insight entities.

n Spring Insight Installation Environment

This section explains the requirements and parameters for installation of Spring Insight.


VMware, Inc. 30

n Spring Insight Configuration Instructions

This sections provides instructions for configuring the Spring Insight plugin.

n Spring Insight Resource Types and Management Functions

This section describes the management functions the Spring Insight plugin performs.

n Spring Insight Metric Collection

These sections definte the metrics for each Spring Insight resource type.

n Spring Insight Pre-Configured Alert Definitions

This section details the pre-configured alert definitions for Spring Insight Application resources.

n Spring Insight Applications View

This section explains the Spring Insight applications view.

Functionality of Hyperic Spring Insight PluginThis topic details the functionality of the vRealize Hyperic Spring Insight plugin.

Hyepric's Spring Insight plugin:

n Collects application metrics from a Spring Insight Dashboard as described below in Spring InsightMetric Collection.

n Provides two built-in resource type alerts that apply to all Spring Insight Application resources. Thealerts are described in Spring Insight Pre-Configured Alert Definitions.

n Provides a user interface for viewing the health of Spring Insight Applications and for analyzingapplication health and performance issues. For more information, see Spring Insight ApplicationsView.

Spring Insight Supported Versions and RequirementsThis section details the supported versions and requirements for the Spring Insight plugin.

The Spring Insight plugin requires:

n vRealize Hyperic 4.6 or later.

n Spring Insight Operations 1.5.1.


VMware, Inc. 31

Spring Insight Resources and the Hyperic Inventory ModelThis section details the resource types in Hyperic that map to managed Spring Insight entities.

Table 2‑2. Spring Insight Resource TypesHyperic Resource Type Description Hyperic Inventory Type

Spring Insight Represents the Insight Dashboardapplication. A tcServer runtime createdwith the Insight-Dashboard template.

server

Spring Insight Application A Spring application that is monitored byInsight. An application running in a tcServer runtime created with the Insight-Agent template.

service

Note The right column indicates the inventory level for each type in the Hyperic inventory model.

Spring Insight Installation EnvironmentThis section explains the requirements and parameters for installation of Spring Insight.

You must install and configure a vRealize Hyperic agent on both of the following:

n The Insight Dashboard host.

n Each host that runs an Insight Agent reporting to the Insight Dashboard.

If your application server is monitored by a vRealize Hyperic agent, performance metrics for the serverinstance that a Spring Insight application runs are available in the Spring Insight plugin user interface,described in Spring Insight Applications View.

If your application has a database tier, if the database server is managed by a vRealize Hyperic agent,the Spring Application View will include database metrics, along with metrics for the application,application server, and platform tiers.

If you want to see database metrics in the Spring Application View, you must install and configure avRealize Hyperic agent on the database server host.

Spring Insight Configuration InstructionsThis sections provides instructions for configuring the Spring Insight plugin.

n Step 1: Install vRealize Hyperic Agents

This topic explains how to install vRealize Hyperic agents.

n Step 2: Import Insight Dashboard to vRealize Hyperic Inventory

This section explains how to import the Insight Dashboard to vRealize Hyperic Inventory.


VMware, Inc. 32

n Step 3: Tailor Plugin Monitoring Defaults (Optional)

This section explains how to tailor the plugin monitoring defaults for Spring Insight and Spring InsightApplication Resources. This step is optional.

n Step 4: Tailor Alert Definitions (Optional)

This section explains how to tailor the alert definitions for Spring Insight Application Resources. Thisstep is optional.

Step 1: Install vRealize Hyperic AgentsThis topic explains how to install vRealize Hyperic agents.

Procedure

u If you have not already done so, install and start a vRealize Hyperic agent on the host where theInsight Dashboard runs, and on each host of each Insight Agent reporting to the Insight Dashboard.

See Getting Started with vRealize Hyperic for instructions.

Step 2: Import Insight Dashboard to vRealize Hyperic InventoryThis section explains how to import the Insight Dashboard to vRealize Hyperic Inventory.

After you start the vRealize Hyperic agent on the Insight Dashboard, and it discovers the InsightDashboard, the dashboard server resource appears in the Auto-Discovery Portet on the vRealize Hypericdashboard.

Procedure

u Import the resource to inventory to start monitoring the Insight Applications reporting to the dasboard.

Step 3: Tailor Plugin Monitoring Defaults (Optional)This section explains how to tailor the plugin monitoring defaults for Spring Insight and Spring InsightApplication Resources. This step is optional.

See Spring Insight Metric Collection for the default metric collection settings for Spring Insight and SpringInsight Application resources.

You can enable and disable metrics, select indicator metrics, and change the collection interval for aresource type on its Monitoring Defaults page.

Procedure

1 Click on the Administration tab and select Monitoring Defaults.

2 Scroll down to the desired resource type - Spring Insight or Spring Insight Application - and click EditMetric Template.


VMware, Inc. 33

Step 4: Tailor Alert Definitions (Optional)This section explains how to tailor the alert definitions for Spring Insight Application Resources. This stepis optional.

The Spring Insight plugin provides two built-in resource type alerts for Spring Insight Applicationresources, described in Spring Insight Pre-Configured Alert Definitions.

To view and edit one of the alert definitions:

Procedure

1 Click on the Administration tab and select Monitoring Defaults.

The Monitoring Defaults page displays key information about the alert.

2 Scroll down to the Spring Insight Application resource type and click Edit Alerts.

3 From the Spring Insight Application services page you can:

a Disable an alert definition by placing a checkmark next to it, and toggling the Set Active controlfrom "Yes" to "No".

b Create a new alert definition for the Spring Insight Application resource type, by clicking New.

c View or edit an alert definition, by clicking its name in the Alert Definition column.

Spring Insight Resource Types and Management FunctionsThis section describes the management functions the Spring Insight plugin performs.

Spring Insight Auto-DiscoveryThis section explains the auto-discovery process for Spring Insight.

The Spring Insight plugin performs a Sigar process query to discover a local Insight Dashboard process,and creates a server of type "Spring Insight".

Once the "Spring Insight" resource is imported to inventory, the plugin creates a service of type "SpringInsight Application" for each application reporting to the dashboard.

n Spring Insight Auto-Discovery Spring Insight

This section details the properties of server type "Spring Insight".

n Spring Insight Auto-Discovery Spring Insight Application

This section details the properties of server type "Spring Insight Application".


VMware, Inc. 34

Spring Insight Auto-Discovery Spring Insight

This section details the properties of server type "Spring Insight".

Table 2‑3. Spring Insight Server PropertiesProperty Description

resource name The plugin forms the Hyperic name for a Spring InsightDashboard by concatenating: parent platforms FQDN, a space,and the string "Spring Insight Dashboard".

Description N/A

Instance Port N/A

Spring Insight Auto-Discovery Spring Insight Application

This section details the properties of server type "Spring Insight Application".

Table 2‑4. Application PropertiesProperty Description

resource name The plugin forms the Hyperic name for a Spring InsightDashboard Application by concatenating: parents resourcename, a space, "application name", and the string "Application".

Description The plugin forms the description.

Owner The Hyperic user account under which the resource wascreated.

Spring Insight Metric CollectionThese sections definte the metrics for each Spring Insight resource type.

n Spring Insight Dashboard Metrics

This topic details the Spring Insight Dashboard Metrics metrics.

n Spring Insight Application Metrics

This topic details the Spring Insight Application Metrics metrics.

n Spring Insight Application Server Metrics

This section explains which metrics can be charted that you collect for tcServer Runtime on theSpring Insight Applications view.

n Spring Insight Database Metrics

This section explains which metrics you collect for the database can be presented in the SpringInsight Applications view.

n Spring Insight Platform Metrics

This section explains which metrics can be charted that you collect for the platform where theapplication server runs on the Spring Insight Applications view.


VMware, Inc. 35

Spring Insight Dashboard MetricsThis topic details the Spring Insight Dashboard Metrics metrics.

Table 2‑5. Spring Insight Dashboard MetricsName Alias Units Category Default On Default Interval

Availability Availability percentage AVAILABILITY true 5 min

Spring Insight Application MetricsThis topic details the Spring Insight Application Metrics metrics.

Table 2‑6. Spring Insight Application MetricsName Alias Units Category Default On Default Interval

Availability Availability percentage AVAILABILITY true 5 min

Health Health[rangeLabel=Last 5minutes].score

percentage PERFORMANCE true 5 min

Total InvocationCount

MetricDataSummaries[metric=invocationCount,label=Last 5 minutes].value

none UTILIZATION true 5 min

FrustratedInvocation Count

MetricDataSummaries[metric=tag.frustrated,label=Last5 minutes].value


Satisfied InvocationCount

MetricDataSummaries[metric=tag.satisfied,label=Last 5minutes].value


Tolerated InvocationCount

MetricDataSummaries[metric=tag.tolerated,label=Last 5minutes].value


Error Rate MetricDataSummaries[metric=errorCount/invocationCount,label=Last 5minutes].value

percentage PERFORMANCE true 5 min

Spring Insight Application Server MetricsThis section explains which metrics can be charted that you collect for tcServer Runtime on the SpringInsight Applications view.

You can chart any metric you collect for tcServer Runtime on the Spring Insight Applications view.


VMware, Inc. 36

Spring Insight Database MetricsThis section explains which metrics you collect for the database can be presented in the Spring InsightApplications view.

If your application accesses a database server that is managed by a vRealize Hyperic agent, any of themetrics you collect for the database can be presented in the Spring Insight Applications view.

Spring Insight Platform MetricsThis section explains which metrics can be charted that you collect for the platform where the applicationserver runs on the Spring Insight Applications view.

You can chart any metric you collect for the platform where the application server runs on the SpringInsight Applications view.

Spring Insight Pre-Configured Alert DefinitionsThis section details the pre-configured alert definitions for Spring Insight Application resources.

The Spring Insight plugin provides two pre-configured alert definitions for Spring Insight Applicationresources. The built-in alert definitions specify resource type alerts - alerts that are assigned at theresource type level, rather than to individual resource instances.

n Spring Insight Application Health Alert

This section details the properties for the Application Health Alert.

n Spring Insight Application Error Alert

This section details the properties for the Application Error Alert.

Spring Insight Application Health AlertThis section details the properties for the Application Health Alert.

The properties for this alert are:

n Name - Application health is degrading.

n Description - Application error rate for the last 5 minutes is high.

n If Condition - Health < 85.0%.

n Enable Action(s) - Each time conditions are met. Generate one alert and then disable alert definitionuntil fixed.

Spring Insight Application Error AlertThis section details the properties for the Application Error Alert.

The properties for this alert are:

n Name - Application error rate is high.


VMware, Inc. 37

n Description - Application error rate for the last 5 minutes is high.

n If Condition - Error Rate > 10.0%.

n Enable Action(s) - Each time conditions are met. Generate one alert and then disable alert definitionuntil fixed.

Spring Insight Applications ViewThis section explains the Spring Insight applications view.

The Spring Insight Application page is available on the Resources tab if you have Insight Operationscomponents under Hyperic management. This view presents health metrics for an Insight applicationalong with metrics for related resources (for example, the application server where the application runs,the machine that hosts the application server, or a database that the application reads and updates) overthe same timeframe.

When the "Insight Application View" indicates an application performance issue, you can investigate byjumping from the Hyperic user interface into the Insight Dashboard application, into the same applicationcontext as the problem occurred.

Managing tc Server ApplicationsIf you have installed the tc Server plug-in, and have appropriate user privileges, you can manage tcServer applications that are deployed on a selected tc Runtime instance, or are deployed for a group,using the vRealize Hyperic Application Management page.

If you are a vRealize Hyperic super-user, you can use all the tc Runtime features in thevRealize Hypericuser interface. If you are logged on to vRealize Hyperic as a non-super-user, you requirespecific permissions to use the tc Runtime features.

Compatible GroupsA vRealize Hyperic group is a set of managed resources. A group whose members are all of the sameresource type is referred to as a compatible group. Grouping tc Runtime instances enables you manageapplications across multiple tc Runtime instances.

If you have sufficient privileges, you can create a group and assign resources to it. You can manage andmonitor the resources in a compatible group at group level.

A compatibility group is not equivalent to a tc Runtime cluster.

n Navigate to a tc Runtime Instance Or Group

Navigate to the Application Management page of a tc Runtime instance or group to manage tcServer applications.

n Create tc Runtime Groups

Grouping tc Runtime instances enables you to deploy an application to multiple tc Runtimeinstances with a single command, instead of deploying to each instance individually.


VMware, Inc. 38

n Deploying Applications

You can deploy an application to a single tc Runtime instance or to a group of tc Runtime instances.

n Viewing Deployed tc Server Applications

You can see a list of all applications deployed to all servers in the group in the Deployed Applicationssection of the Application Management page for a server instance or group .

n Undeploy an Application

Undeploying an application removes it from the tc Runtime instance or group.

n Start an Application

Starting an application makes it available to users. You must have previously deployed theapplication to be able to start it.

n Stop an Application

Stopping an application makes it unavailable to users.

n Reload an Application

When you reload an existing application, it shuts down and then reloads.

n Managing tc Server Configuration

You can configure various tc Server parameters.

Navigate to a tc Runtime Instance Or GroupNavigate to the Application Management page of a tc Runtime instance or group to manage tc Serverapplications.

Procedure

1 Click Resources > Browseat the top of the vRealize Hypericdashboard.

a (Optional) To browse to a server instance, click Servers to view a list of the servers to which youhave access. tc Runtime instances have the server type SpringSource tc Runtime 6.0.Apache Tomcat server instances have the server type Tomcat X.X.

b To browse to a group of servers, click Compatible Groups/Clusters to view a list all thecompatible groups to which you have access. Groups of tc Runtime have the type SpringSourcetc Runtime 6.0.

2 In the table, click the name of the tc Runtime instance or group to which you want to navigate.

3 Click Views > Application Management.


VMware, Inc. 39

Create tc Runtime GroupsGrouping tc Runtime instances enables you to deploy an application to multiple tc Runtime instances witha single command, instead of deploying to each instance individually.

Procedure

1 Click Resources > Browseat the top of the vRealize Hypericdashboard.

2 Click Servers to view a list of of the servers to which you have access. tc Runtime instances have theserver type SpringSource tc Runtime 6.0. Apache Tomcat server instances have the server typeTomcat X.X.

3 Select the checkbox to the left of each tc Runtime instance you want to include in the new group andclick Group.

4 Provide a name and description for the group and click OK.

Deploying ApplicationsYou can deploy an application to a single tc Runtime instance or to a group of tc Runtime instances.

If you deploy to a group, the application is deployed to each of tc Runtime instances in that group,meaning that you can run the application from any of the tc Runtime instances in the group.

You can deploy an application from a WAR file located:

n on your local file system (on the same machine as the browser you are using to connect tovRealize Hyperic)

n on the computer on which the tc Runtime resource is running

Whether the WAR file is local or remote, you can either enter a new context path or use the default value.

The context path is a string that uniquely identifies the Web application in the URL used to invoke theapplication.

The default value is the name of the WAR file, without the .war extension.

Procedure

1 In the Application Management page for a tc Runtime instance or group, select the WAR file for theapplication.

Depending on the location of the WAR file,

n Click Browse in the Deploy Application From Local Machine section to browse to the file'slocation.

n Enter the full path to the WAR file on the computer hosting the tc Runtime resource in the DeployApplication from Server Machine section.

2 (Optional) Enter a context path in the Context path text box.


VMware, Inc. 40

3 (Optional) Select the Use cold deployment strategy checkbox to invoke the tc Runtime instance toshutdown, deploy the application, and then start up again.

By default, the tc Runtime instance hot-deploys the application, which means it does not shutdownthen restart, but deploys the application while the instance is still running.

Use the cold deployment strategy to avoid common hot deployment errors, such as running out ofPermGen space. The PermGen space holds the metadata about classes that have beenloaded/created in the JVM.

4 Click Upload and Deploy or Deploy, according to your requirements.

If you deployed the application to tc Runtime, the application is started.

The outcome of the application deployment appears in the See the Results of the last operation section.

Viewing Deployed tc Server ApplicationsYou can see a list of all applications deployed to all servers in the group in the Deployed Applicationssection of the Application Management page for a server instance or group .

Only applications on running tc Runtime instances appear. vRealize Hyperic returns an error forapplication hosts that are not running.

When viewing information in the table, consider the following information.

n The status, Running or Stopped, indicates that all instances of the application on all servers in thegroup have that state. A numeric status value indicates the number of servers on which theapplication's state is Running.

n The value in the Sessions column indicates the number of current active sessions for the application.

n The value in the Revision column indicates the current revision of the application. vRealize Hypericcreates a new revision each time you deploy an application that uses an existing context path.

Undeploy an ApplicationUndeploying an application removes it from the tc Runtime instance or group.

To temporarily prevent users from accessing an application, stop it rather than undeploy it. See Stop anApplication.

Procedure

1 In the Deployed Applications section of the Application Management page of a tc Runtime instance orgroup, select the checkbox to the left of one or more applications you want to undeploy.

2 Click Undeploy.

vRealize Hypericremoves the application from the list of deployed applications.


VMware, Inc. 41

Start an ApplicationStarting an application makes it available to users. You must have previously deployed the application tobe able to start it.

Procedure

1 In the Deployed Applications section of the Application Management page of a tc Runtime instance orgroup, select the checkbox to the left of one or more applications you want to start.

2 Click Start.

The application begins to run and the status of the application changes to Running.

Stop an ApplicationStopping an application makes it unavailable to users.

Procedure

1 In the Deployed Applications section of the Application Management page of a tc Runtime instance orgroup, select the checkbox to the left of one or more applications you want to stop.

2 Click Stop.

The application stops and the status of the application changes to Stopped.

Reload an ApplicationWhen you reload an existing application, it shuts down and then reloads.

Procedure

1 In the Deployed Applications section of the Application Management page of a tc Runtime instance orgroup, select the checkbox to the left of one or more applications you want to reload.

2 Click Reload.

The application begins to run and the status of the application changes to Running.

Managing tc Server ConfigurationYou can configure various tc Server parameters.

Configuration changes are made under Views > Server Configuration > Configuration in thevRealize Hyperic user interface.


VMware, Inc. 42

tc Server General Configuration ParametersThis topic lists the parameters in the General Configuration section.

Table 2‑7. Server PropertiesField Name Description

Shutdown Port The TCP/IP port where the tc Runtime instance listens for ashutdown command. The connection must be initiated from thesame server computer that is running this instance of tcRuntime.

Valid values are -1, 1, 2, ... up to 65535.

When the -1 default setting is specified, no shutdown port isenabled. This means that the only way that the server instancecan be shut down is by a local kill statement to the serverprocess.

Shutdown Command The command to issue via a TCP/IP connection to theShutdown Port to shut down tc Runtime.

JMX Listener

The JMX Listener section configures the component of the tc Runtime instance that listens for JavaManagement Extensions (JMX) connections from management tools, such as the vRealize Hypericagent. By default, tc Runtime enables JMX connectivity.

Table 2‑8. JMX Listener PropertiesField Name Description

Enabled Specifies whether the tc Runtime instance's pre-configured JMXlistener is enabled.

The vRealize Hyperic agent uses JMX to connect to tc Runtime.If you disable the JMX listener, you cannot configure tc Runtimeinstances or groups from the vRealize Hyperic user interface,unless you configure JMX for tc Runtime through some othermechanism.

Port Specifies the port on which tc Runtime listens for JMX/RMIconnections. Specify a port number that is not in use by anotherprocess.

IP Address Specifies the IP address on which tc Runtime listens forJMX/RMI connections. If the IP address is the same as the tcRuntime instance, you can enter 127.0.0.1.

Protocols Specifies a comma-separated list of enabled SSL/TLS protocols.If you do not enter a value for this property, the default protocolsare enabled.


VMware, Inc. 43

Table 2‑8. JMX Listener Properties (Continued)Field Name Description

Authenticate Specifies if tc Runtime authenticates users that connect to theserver using the JMX port.

If you enable this field, tc Runtime looks up the user andpassword in the files specified by the Access File andPassword File fields. If tc Runtime finds the username andpassword in the files, the user is authenticated and allowed JMXaccess. If you disable this property, all users may access tcRuntime via JMX.

You configure the JMX user and password in vRealize Hypericon server instances on the Inventory > ConfigurationPropertiespage.The default JMX user and password is configured by defaultwhen you install tc Server. If you change the name or passwordof the user in the access and password files, you must alsochange the configured user/password in the vRealize Hypericuser interface.

Access File Specifies the full path name of the tc Runtime file that containsthe list of users allowed to access tc Runtime using JMX. Thisfile resides on the computer that hosts the tc Runtime instance,not the computer that hosts the vRealize Hyperic server.

The access file contains one line per user. Each line contains ausername and permission level:n readwrite - The user can view and modify the tc Runtime

configuration.

The default name for the access file is jmxremote.access.

The default location is the CATALINA_BASE/conf directoryof the tc Runtime instance.

Each tc Runtime instance is configured by default with anadmin user with readwrite permission.

n readonly - The user can only view tc Runtime configuration .

Password File Specifies the full pathname of the tc Runtime file that containspasswords for the users listed in the access file.

The password file contains one line for each user listed in theaccess file; each line contains a username and password. Thedefault name for the password file is jmxremote.password.

The default location is the CATALINA_BASE/conf directory of thetc Runtime instance. The password for the pre-configured adminuser is springsource.

Use SSL Specifies whether to use secure sockets layer (SSL) for users'JMX connections to tc Runtime.

To use SSL, you must first set up a digital certificate on thecomputer that hosts the tc Runtime instance and then configurethe SSL settings on this page. You can use the command-lineutility keytool to manage digital certificates.


VMware, Inc. 44

Table 2‑8. JMX Listener Properties (Continued)Field Name Description

Client Authentication Specifies whether client authentication is required when usingSSL.

If you enable this property, tc Runtime authenticates JMX/SSLclients using certificate authentication rather than file-basedauthentication. This means that tc Runtime must find the client'scertificate in its truststore or it will deny the client JMX access.This implies that only clients with known SSL certificates areallowed access to tc Runtime.

Use JDK Client Factory Specifies whether the vRealize Hyperic agent uses the requiredclient libraries from the JDK. The required libraries are used topass SSL-specific properties (such as the trust store andpassword) to the tc Runtime instance. If you disable thisproperty, you must manually set up the vRealize Hyperic agent'sCLASSPATH to find these client libraries.

Cipher Suites Specifies a comma-separated list of enabled SSL/TLS ciphersuites. A cipher suite is a combination of cryptographicparameters that define the security algorithms and key sizesused for authentication, key agreement, encryption, and integrityprotection.

If you do not enter a value for this property, the default ciphersuites are enabled.

Truststore File Specifies the full pathname of the truststore file used by SSL.

A truststore is a special kind of keystore file that is used whenmaking decisions about what to trust. If you receive some datafrom an entity that you already trust, and if you can verify thatthe entity is the one it claims to be, you can assume that thedata came from that entity. This means that the key of atruststore file typically contains an entity's identity and a publickey, as opposed to a private key contained in a more restrictedkeystore file.

Truststore Pass Specifies the password used to access the truststore file.

Keystore File Specifies the full pathname of the keystore file.

A keystore is a database of key material. Key material is usedfor a variety of purposes, including authentication and dataintegrity. There are various types of keystores available,including "PKCS12" and Sun's "JKS." Typically, the key of akeystore consists of an entity's identity and its private key.

Keystore Pass Specifies the password used to access the keystore file.

Server Start Configuration ParametersThe fields in this section are populated by vRealize Hyperic with information from theCATALINA_HOME/bin/setenv.sh file of the tc Runtime instance you are configuring.

If setenv.sh does not exist, or does not define JVM_OPTS, the Server Start fields are blank. Edits that youmake to Server Start fields in the vRealize Hyperic user interface are written to setenv.sh.


VMware, Inc. 45

Table 2‑9. General ParametersField Name Description

Java Home Specifies the full pathname to the JDK or JRE used by the tcRuntime instance.

Use Server Hotspot VM Select the checkbox to use the Java HotSpot Virtual Machine.

Min Heap Size Specifies the initial size, in MB, of the memory allocation pool.

Max Heap Size Specifies the maximum size, in MB, of the memory allocationpool.

Thread Stack Size Specifies the amount of memory, in KB, allocated to a singleJVM thread.

Sun-Specific JVM Options

The options in the following table are specific to Sun JVMs. Modify the option values with caution. If youuse a non-Sun VM, altering the values might have unintended effects.

Table 2‑10. Sun Specific JVM ParametersField Name Description

Memory

Min Young Generation Size Specifies the default size, in MB, of new generation.

Max Young Generation Size Specifies the maximum size, in MB, of new generation.

Min Perm Gen Size Specifies the initial size, in MB, of the permanent generation.

Max Perm Gen Size Specifies the maximum size, in MB, of the permanentgeneration.

Garbage Collection

Max GC Pause Sends a hint to the virtual machine that pause times of thespecified milliseconds or less are preferred. The VM adjusts theJava heap size and other garbage collection-related parametersin an attempt to keep garbage collection-induced pauses shorterthan the specified value.

Note This may cause the VM to reduce overall throughput, andin some cases the VM will not be able to meet the preferredpause time goal.

Max GC Minor Pause Sends a hint to the virtual machine that pause times of thespecified milliseconds or greater are preferred. The VM adjuststhe Java heap size and other garbage collection-relatedparameters in an attempt to keep garbage collection-inducedpauses greater than the specified value.

Debug

Heap Dump on Out of Memory Error Directs the JVM to generate a heap dump when an allocationfrom the Java heap or the permanent generation cannot besatisfied.


VMware, Inc. 46

Table 2‑10. Sun Specific JVM Parameters (Continued)Field Name Description

Print Message at GC Specifies whether the JVM should print messages to thegarbage collection log file every time it performs a garbagecollection.

Print Heap at GC Specifies whether the JVM should print detailed information,including heap occupancy before and after a garbage collection,to the garbage collection log file.

Print GC Application Stopped Time Specifies whether the JVM should print the amount of time anapplication is stopped during a garbage collection to thegarbage collection log file.

Print GC Timestamps Specifies whether the JVM should print time stamps related togarbage collection to the garbage collection log file.

Print GC Details Specifies whether the JVM should print detailed informationrelating to garbage collection to the garbage collection log file.

GC Log File Specifies the name of the garbage collection log file to which allgarbage collection information is printed. Default value isCATALINA_BASE/logs/gc.log.

Advanced Parameters

Table 2‑11. Advanced ParametersField Name Description

Command Line Arguments Enter additional options to the CATALINA_OPTS environmentvariables if they are not available as text fields on theconfiguration page. Use one of these forms with a spacebetween options:n -XOptionValue

n -XX:Option=Value

For example: -Xms512M -Xmx512M -XX:NewSize=128M

Context Container Parameters

The fields described in the following table configure the context for every Web application deployed to thetc Runtime instance. vRealize Hyperic loads and updates the values from theCATALINA_BASE/conf/context.xml file for the tc Runtime instance.

Table 2‑12. Context Container ParametersField Names Description

Static Resource Cache

Allow Caching If selected, specifies that tc Runtime uses the cache for staticresources.

Max Cache Size Maximum size, in KB, of the static resource cache. Default valueis 10240 (10 megabytes).

Cache TTL Amount of time, in milliseconds, between cache entriesrevalidation. Default value is 5000 (5 seconds).


VMware, Inc. 47

Table 2‑12. Context Container Parameters (Continued)Field Names Description

Web Application Logger

Swallow Output If selected, specifies that tc Runtime redirects the bytes outputby the Web application to System.out and System.err to theWeb application logger.

Server Defaults - JSP

The fields described in the following table configure JSP-related init params for every Web applicationdeployed to the tc Runtime instance. vRealize Hyperic loads and updates the values from theCATALINA_BASE/conf/web.xml file for the tc Runtime instance.

Table 2‑13. Server Defaults - JSP ParametersField Names Description

Recompile Check Interval (s) Specifies the interval, in seconds, at which tc Runtime checks tosee if a JSP and its dependent file must be recompiled. Defaultvalue is 0. If you set this field to a value greater than zero, andDevelopment Mode is not selected, tc Runtime performs thecompilation in the background.

Development Mode Specifies that tc Runtime is working in development mode.When this value is selected, you can specify the frequency atwhich JSPs are checked for modification using the ModificationTest Interval field.

Modification Test Interval (s) Specifies the interval, in seconds, for tc Runtime to wait beforechecking JSPs and their dependent files for modifications. If youset this field to 0, tc Runtime checks the JSPs every time theyare accessed. Default value is 4 seconds. This feature isenabled only when Development Mode is selected.

Compiler Specifies the JSPs compiler used by tc Runtime. If not specified,tc Runtime uses the default Eclipse JDT Java compiler.

Compiler Target VM Specifies the JDK version with which the generated files arecompatible. Default value is JDK 1.4.

Compiler Source VM Specifies the JDK version with which the source files arecompatible. Default value is JDK 1.4

Compile Class With Debug Information Specifies whether the JSP class should be compiled with debuginformation.

Classpath Specifies the CLASSPATH for tc Runtime to use when compilingthe generated servlets. tc Runtime creates the defaultCLASSPATH dynamically, based on the current Web application.

Fork JSP Page Compile to Separate JVM Specifies whether tc Runtime should fork the compilation ofJSPs so that they are performed in a JVM other than tcRuntime .

Enable Tag Handler Pooling Enables tag handler pooling.


VMware, Inc. 48

Table 2‑13. Server Defaults - JSP Parameters (Continued)Field Names Description

Internet Explorer class-id for Tags Specifies the class-id value that tc Runtime sends to InternetExplorer when using the tags. Default value is clsid:8AD9C840-044E-11D1-B3E9-00805F499D93.

Java File Encoding Specifies the Java file encoding to use for generating Javasource files. Default value is UTF8.

Keep Generated Source Code Specifies whether tc Runtime keeps or delets the generatedsource code for each page.

Generate One Print Statement Per Input Line Specifies whether tc Runtime generates static content with oneprint statement per input line, to ease debugging.

Trim Spaces In Template Text Specifies whether tc Runtime trims white spaces in template textbetween actions or directives.

Suppress SMAP Information Specifies whether tc Runtime suppresses the generation ofSMAP information for JSR-45 debugging.

Dump SMAP Information Specifies whether tc Runtime dumps SMAP information forJSR-45 debugging to a file. If you set this field to true (selected),clear Suppress SMAP Information.

Generate Strings as Char Arrays Specifies whether strings are generated as character arrays.Selecting this field sometimes increases the performance ofJSPs.

Issue Error For Invalid useBean Class Attribute Specifies whether tc Runtime issues an error when the value ofthe class attribute in a useBean action is not a valid bean class.

Scratch Directory Specifies the scratch directory that tc Runtime uses whencompiling JSP pages. The default value is the work directory forthe current Web application.

Add X-Powered-By Response Header Specifies whether the generated servlet adds the the X-Powered-By response header.

Server Defaults - Static Content

The fields described in the following table configure static content-related init parameters for every Webapplication deployed to the tc Runtime instance. vRealize Hyperic loads and updates the values from theCATALINA_BASE/conf/web.xml file for the tc Runtime instance.

Table 2‑14. Server Defaults - Static Content ParametersField Names Description

Debug Level Specifies the level of detail contained in the debuggingmessages from the current servlet. Default value is 0 (nodebugging.)

File Encoding Specifies the encoding that tc Runtime uses when reading staticresources. The default value is the same as the file encoding ofthe platform on which tc Runtime is running.

Input Buffer Size Specifies the size, in bytes, of the input buffer that tc Runtimeuses when reading resources to be served. Default value is2048.

vrealize hyperic resource configuration and metrics ......vrealize hyperic resource configuration...

Documents