Getting Started with the Terracotta Management Console

This document describes the Terracotta Management Console (TMC), which is a single-page web application served by the Terracotta Management Server (TMS).

The TMC is a web-based tool that provides a complete view of your Terracotta Server Array (TSA) and connected clients. With the TMC you can:

The TMS is a standard Java web application, and bundled web container, located in the Terracotta kit under the tools/management directory.

Certain aspects of the TMS can be customized via the properties file located at tools/management/conf/tmc.properties. While that file contains many more properties, those that follow are the most likely to be useful to the TMS administrator:

logging.file=${tmc.home:target/tmc}/logs/tmc.log
server.port=9889
tms.storageFolder=${tmc.home:target/tmc}/data
tms.clusterReadFrequencySec=5
tms.offheapSizeMB=256
tms.statisticsMaxAgeMinutes=30

To start the TMS, execute one of the start scripts (.sh and .bat) located in tools/management/bin. You can probably guess the purpose of the stop scripts.

In order to get the fullest management and monitorability you must configure your CacheManager to make use of a ManagementRegistryService:

import org.ehcache.config.builders.CacheManagerBuilder;
import org.ehcache.management.registry.DefaultManagementRegistryConfiguration;
import org.ehcache.management.registry.DefaultManagementRegistryService;

DefaultManagementRegistryConfiguration registryConfig =
new DefaultManagementRegistryConfiguration().setCacheManagerAlias("MyCacheManager");
DefaultManagementRegistryService managementRegistry = new DefaultManagementRegistryService(registryConfig);
CacheManagerBuilder<PersistentCacheManager> clusteredCacheManagerBuilder = CacheManagerBuilder
.newCacheManagerBuilder().using(managementRegistry);

Associating your CacheManager with a management registry bestows upon it various capabilities allowing it to be exposed via the TMS REST interface with the alias you provide. It is encouraged to assign the same alias to equivalent instances of your CacheManager, across different clients so as to support statistics aggregation.

If you do not make use of a management registry, your CacheManager will still appear in the TMC but will not be uniquely named (UNKNOWN) and most management and monitoring features will not operate.

After starting the TMS, open a supported browser and visit http://localhost:9889. The TMC will load up and present you with the Home Page, where persistent connections to your clusters can be created.