Skip to end of metadata
Go to start of metadata

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

Feedback is welcome. Click Add Comment at the bottom of the page.

tc Runtime Configuration

On this page you can configure the selected tc Runtime instance.

Navigating tc Runtime Configuration Pages

To navigate to the Server Configuration pages of a tc Runtime instance:

  1. Click Resources > Browse in the HQ user interface.
  2. Click Servers link to list all the tc Runtime instances in inventory.
    • tc Runtime instances have the server type "SpringSource tc Runtime 6.0"
    • Apache 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 the Views > Server Configuration tab.

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

  • Configuration - Configure general tc Runtime options, such as JVM options, JSP behavior, and default options for static content.
  • Resources - Create, configure, and delete JDBC data sources.
  • Services  - Configure the default Catalina service, and create new ones. A tc Runtime service groups together one or more connectors and a single engine. The engine, in turn, groups together one or more virtual hosts.

The Advanced section provides links for reloading, reverting, and uploading server configurations.

Saving or Undoing Changes

HQ populates the fields of the tc Runtime configuration pages from the its configuration files, including:

  • conf/server.xml
  • conf/context.xml
  • conf/web.xml
  • bin/setenv.sh
  • conf/catalina.properties
  • conf/logging.properties

(All relative to CATALINA_BASE, the root directory of the tc Runtime instance.)

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

When you click Save to save your changes, a box labeled "Changes have been made locally" is displayed until you click either:

  • Push - to write the configuration changes you have made to the appropriate tc Runtime configuration file (such as server.xml). If you push the changes, HQ overwrites existing configuration, saving a backup of the overwritten configuration. Most saved changes to the tc Runtime configuration require a server restart to take effect; HQ flags these cases and provides a link to easily restart the tc Runtime.
  • Undo - to undo all changes that have been made since the last push or undo.

If you update tc Runtime configuration settings from the HQ user interface, do NOT manually update the tc Runtime configuration files at the same time. HQ clears its local memory and reloads the configuration files upon certain events, not continuously.

User Permissions Required to Use the tc Runtime Features

The HQ super-user can use all the tc Runtime features of the HQ UI.  If, however, you log on to the HQ UI as a non-super-user, then that user must have certain permissions to be able to use the tc Runtime features, as described in this section.

In HQ, users are assigned roles, which in turn are assigned permissions, such as View and Control. For general information about what each permission means with respect to server resources (such as a tc Runtime instance) in HQ, see Permissions to Servers. For general information about the default users in HQ and creating new ones, see User Accounts in Hyperic HQ .

The following table describes the additional effects that some of the HQ permissions have on the tc Runtime features. Use this table to determine which role you should assign a user that will be managing tc Runtime instances.

Permission
Additional Effect on tc Server HQ Plugin Features
View
Allows the user to:
  • View the deployed Web applications in the Views > Application Management tab.
  • View the current configuration of a tc Runtime instance in the Views > Server Configuration tab.
Modify
Allows the user to:
  • Update the fields in the Views > Server Configuration tab and then push the data to the configuration files associated with the tc Runtime instance, such as server.xml.
  • Use the application lifecycle commands of the Views > Application Management tab to start, stop, reload, or undeploy a Web application.
Control
Allows the user to use the commands in the Control tab to start, stop, and restart a tc Runtime instance.

Configuring General tc Runtime Options

The main tc Runtime configuration page includes options to change the Shutdown Port and Shutdown Command.

  1. Navigate to the configuration pages for the tc Runtime instance. For instructions, see Navigating tc Runtime Configuration Pages.
  2. Click the Configuration tab.
  3. Click the General link in the list on the left. For information about the fields on the page, see tc Runtime Configuration Reference.
  4. Make your changes.
  5. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.
  6. To write your changes to the tc Runtime configuration files, click Push in the "Changes have been made locally" box. See Saving or Undoing Changes.

For additional detailed information about configuring the tc Runtime, see The Server Component, in Apache Tomcat documentation.

Configuring Startup Options

The page for configuring tc Runtime Start settings includes options for configuring the JVM where the instance runs, including minimum and maximum heap size, garbage collection, and debugging options.

NOTE: HQ populates the tc Runtime Start page with information from the CATALINA_HOME/bin/setenv.sh file of the server instance you are configuring (specifically the JVM_OPTS environment variable.) If you have not set the JVM_OPTS environment variable in this file, then the fields in the Server Start page will be blank.

The page allows you to add your own command line arguments to the JVM; be careful using this option because HQ does not validate the options but simply adds them to the Java command that starts the tc Runtime instance. If you enter them incorrectly, you will get an error starting the tc Runtime instance.

  1. Navigate to the tc Runtime configuration pages.
  2. Click the Configuration tab.
  3. Click the Server Start link in the list on the left. For information about the fields on this page, see tc Runtime Configuration Reference.
  4. Make your changes. 
  5. To add your own JVM command line arguments, click the Advanced link at the bottom and enter them in the form the form "-Xoptionvalue or -XX:option=value, separating options with a space.
  6. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.
  7. To write your changes to the tc Runtime configuration files, click Push in the "Changes have been made locally" box. See Saving or Undoing Changes.

Configuring the Context Container

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

  1. Navigate to the tc Runtime configuration pages.
  2. Click the Configuration tab.
  3. Click the Context Container link in the list on the left.
  4. Make your changes. For reference information about the fields on this page, see tc Runtime Configuration Reference.
  5. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.
  6. To write your changes to the tc Runtime configuration files, click Push in the "Changes have been made locally" box. See Saving or Undoing Changes.

For additional detailed information about configuring the context container for tc Runtime, see The Context Container, part of the general Apache Tomcat documentation.

Configuring JSP Options

SpringSource tc Runtime implements version 2.1 of the Java Server Pages (JSP) specification. Use this page to configure the behavior of the JSPs that are deployed to a tc Runtime instance.

  1. Navigate to the tc Runtime configuration pages.
  2. Click the Configuration tab.
  3. Click the Server Defaults: JSP link in the list on the left.
  4. Make your changes. For information about the fields on this page, see tc Runtime Configuration Reference.
  5. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.
  6. To write your changes to the tc Runtime configuration files, click Push in the "Changes have been made locally" box. See Saving or Undoing Changes.

For more information about configuring the behavior of JSPs in tc Runtime, see Jasper 2 JSP Engine How To, part of Apache Tomcat documentation.

Configuring Static Content Defaults

Use this page to configure the behavior of static content in Web applications that run on tc Runtime.

  1. Navigate to the tc Runtime configuration pages.
  2. Click the Configuration tab.
  3. Click the Server Defaults: Static Content link in the list on the left.
  4. Make your changes. For  information about the fields on this page, see tc Runtime Configuration Reference.
  5. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.
  6. To write your changes to the tc Runtime configuration files, click Push in the "Changes have been made locally" box. See Saving or Undoing Changes.

For additional detailed information about configuring the behavior of static content in tc Runtime, see Default Servlet Reference, part of the general Apache Tomcat documentation.

Using the Advanced Server Configuration Options

The Advanced section of the main Server Configuration tab includes options for reverting or reloading configuration values in the event you do not want to save any of the recent updates you have made using the HQ user interface. The Advanced section also includes an option to upload a local configuration file in its entirety, such as server.xml. The following sections provide more information about these options.

SpringSource recommends that you use these options with caution.

Reloading Settings From Server

Click the Reload Settings From Server link if you want to reload the server configuration currently contained in the tc Runtime configuration files. With this option, all local changes to the tc Runtime instance you have made using the HQ user interface that you have not yet pushed to the instance will be lost.

Reverting to a Previously Saved Configuration

Click the Revert To a Previously Saved Configuration link if you want to revert to the most recent backup copy of the tc Runtime configuration. Each time you push changes from the HQ user interface to the tc Runtime configuration files, the tc Server HQ plugin makes a timestamped backup copy of the previous configuration before overwriting the relevant configuration file, such as server.xml. With this option, you can revert back to the most recent backup copy in the event that there was a problem with the most recent changes that you pushed. As with reloading the current configuration, if you revert to a backup copy, any local changes to the tc Runtime instance made using the HQ user interface will be lost.

If you have never pushed configuration changes from the HQ UI to the tc Runtime instance, then no backup file will exist to which the tc Server HQ plugin can revert. In this case, if you try to revert, you will get an error.

Uploading a Configuration File

Click the Upload a Configuration File link to upload a local configuration file, such as server.xml, and copy it to the appropriate tc Runtime instance directory. Use the Configuration File drop-down list to specify the type of configuration file you are going to upload, and then use the Browse button to browse for the file on your local computer.

The tc Server HQ plugin makes a timestamped backup copy of the current configuration file before it overwrites it with the one you uploaded. This means that you can revert to the backup copy in the event that you do not want to use the uploaded configuration file for some reason.

Configuring and Creating JDBC Data Sources

JDBC datasources make it easy for a user to access data in a database server. A datasource defines a pool of JDBC connections which in turn connect to a specific database using a specified URL, username, and so on. Use this page to create and configure configure datasources.

You can create two types of JDBC data sources:

  • Database Connection Pool (DBCP) Datasource- The DBCP Datasource is the standard datasource 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 must lock the entire pool, even during query validation. Thus it is not suitable for highly concurrent environments. Additionally, it can be slow, which in turn can negatively affect the performance of Web applications.
  • Tomcat Datasource - The Tomcat Datasource includes all the functionality of the DBCP datasource, but adds additional features to support highly-concurrent environments and multiple core/cpu systems. The Tomcat datasource typically performs much better than the DBCP datasource. Additional features include:
    • Dynamic implementation of the interfaces, which means that the datasource supports the java.sql and javax.sql interfaces for your runtime environment (as long as your JDBC driver supports it), even when compiled with a lower version of the JDK.
    • Validation intervals so that tc Runtime doesn't have to validate every single time the application uses the connection, which improves performance.
    • Run-Once query, which is a configurable query that the tc Runtime instance runs only once when the connection to the database is established. This is very useful to setup session settings that you want to exist during the entire time the connection is established.
    • Ability to configure custom interceptors to enhance the functionality of the datasource. You can use interceptors to gather query stats, cache session states, reconnect the connection upon failures, retry queries, cache query results, and so on. The interceptors are dynamic and not tied to a JDK version of a java.sql/javax.sql interface.
    • Asynchronous connection retrieval - you can queue your request for a connection and receive a Future back.

To create a new JDBC datasource, or edit an existing one:

  1. Navigate to the tc Runtime configuration pages.
  2. Click the Resources tab.
  3. Click the JDBC Data Sources link in the list on the left.
  4. If you want to edit an existing data source, click its name in the table and make your changes. If you want to create a new one, click the Create a New Tomcat/DBCP Data Source link. For information about the fields on this page, see tc Runtime JDBC Reference.
  5. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.
  6. To write your changes to the tc Runtime configuration files, click Push in the "Changes have been made locally" box. See Saving or Undoing Changes.

For more information about configuring JDBC data sources, see JNDI Datasource HOW-TO, part of Apache Tomcat documentation.

Configuring and Creating tc Runtime Services

A tc Runtime service represents the combination of one or more connector components that share a single engine component for processing incoming requests. A tc Runtime instance can have one or more services configured. The default service is "catalina".

  1. Navigate to the tc Runtime configuration pages.
  2. Click the Services tab.
  3. If you want to edit an existing service, such as the default "catalina" service, click its name in the table and then configure, or add, the following components of the service:
  4. If you want to create a new service, click the New Service link. For information about the fields on the Create a New Service page, see tc Runtime Service Reference.
  5. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.

For more information about configuring tc Runtime services, see The Service Component, part of Apache Tomcat documentation.

Configuring and Creating Connectors

Connectors represent the interface between external clients sending requests to (and receiving responses from) a particular tc Runtime service. A tc Runtime instance can have one or more connectors, one for each supported message protocol. The default connector, configured for each tc Runtime, is the HTTP connector.

Use this page to configure, or create new, connectors for the current tc Runtime service.

  1. Navigate to the tc Runtime configuration pages.
  2. Click the Services tab.
  3. In the Services table, click the name of the service for which you want to configure or create a connector.
  4. Click the Connectors link in the list on the left.
  5. If you want to edit an existing connector, click its name in the table and make your changes. If you want to create a new one, click the New AJP Connector or New HTTP(S) Connector link, depending on the type of connector you want to create. For information about the fields on this page, see tc Runtime Services Reference.
  6. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.

For additional detailed information about configuring tc Runtime connectors, see Connectors How-To, part of the general Apache Tomcat documentation.

Configuring and Creating Virtual Hosts

A tc Runtime host represents a virtual host, which is an association of a network name for a server (such as "www.mycompany.com") with the particular computer which hosts the tc Runtime instance. In order to be effective, this name must be registered in the Domain Name Service (DNS) server that manages your Internet domain.

Use this page to configure, or create new, virtual hosts for the current tc Runtime service.

  1. Navigate to the tc Runtime configuration pages.
  2. Click the Services tab.
  3. In the Services table, click the name of the service for which you want to configure or create a virtual host.
  4. Click the Hosts link in the list on the left.
  5. If you want to edit an existing host, click its name in the table and make your changes. If you want to create a new one, click the New Host link. For reference information about the fields on this page, see tc Runtime Services Reference.
  6. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.

For more information about configuring tc Runtime hosts, see The Host Container, part of Apache Tomcat documentation.

Configuring tc Runtime Logging

Use this page to configure the logging system for the current engine. Note that you can also configure logging for a host by configuring the specific Host component; see Configuring and Creating Virtual Hosts.

  1. Navigate to the tc Runtime configuration pages.
  2. Click the Services tab.
  3. In the Services table, click the name of the service for which you want to configure logging.
  4. Click the Logging link in the list on the left.
  5. Make your changes in the table. For information about the fields on this page, see tc Runtime Services Reference.
  6. Click Save. The message "Configuration saved successfully" indicates your changes were successfully saved.

For more information about configuring tc Runtime logging, see Logging in Tomcat, part of the general Apache Tomcat documentation.

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.