Getting Started with the Terracotta Management Console
About the Terracotta Management Console
This document describes the Terracotta Management Console (TMC), which is a browser-based application served by the Terracotta Management Server (TMS). The TMC provides a complete view of your Terracotta Server Array (TSA) and connected clients.
With the TMC you can:
observe the cluster topology and categories of connected clients
view statistics
clear cache contents
and more
Installing the TMS
The TMS is a standard Java web application and bundled web container. It gathers information from throughout the cluster and serves it to the TMC for display in your browser. The TMS is located in the installed Terracotta kit under the tools/management directory.
Configuring the TMS
Certain aspects of the TMS can be customized via the properties file located in the installed Terracotta kit 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:
server.port=9480
tms.storageFolder=target/tmc/data
tms.allowedOrigins=[*]
tms.offheapSizeMB=1024
tms.offheapMonitoringDetail=false
tms.statisticsMaxAgeMinutes=10
tms.eventLogMaxRecords=5000
tms.diagnosticConnectTimeoutSec=5
tms.diagnosticRequestTimeoutSec=5
tms.stripeMonitoringFrequencySec=5
tms.topologyUpdateFrequencySec=10
Starting and Stopping the TMS
To start the TMS, execute the script start.bat (on Windows) or start.sh (on UNIX-based systems), located in tools/management/bin under the installed Terracotta kit.
To terminate the TMS, use the associated stop.bat or stop.sh script, or platform-provided process management tools.
Adding Manageability to your Ehcache CacheManager
In order to get the fullest manageability and monitorability you must configure your CacheManager to make use of a ManagementRegistryService:
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.
For related information, see the section
Ehcache API Developer Guide > Management and Monitoring with Ehcache.
Adding Manageability to your TCStore Dataset
Unlike for an Ehcache CacheManager, there is no need to explicitly add manageability to your TCStore Dataset.
Connecting to the TMC
After starting the TMS, open a browser and visit http://localhost:9480. The TMC will load and present you with the Home Page, where persistent connections to your clusters can be created, viewed and managed.
