Skip to main content
Version: Any 26

System page

The /system page is the instance supervision console. It is disabled by default: as long as no system account is defined, nobody can sign in to it.

Activation​

The page is protected by a dedicated account, independent of Any users. In the shiro.ini file (or shiro-cas.ini, shiro-saml.ini, shiro-oidc.ini depending on the authentication mode), uncomment the two systemAuthenticator lines and give them a value:

systemAuthenticator = eu.c6.gibraltar.auth.authenticator.C6SystemAuthenticator
systemAuthenticator.username = admin-system
systemAuthenticator.password = <password>

The password can be provided in clear text or encrypted. Then restart Tomcat and open https://<server>/any/system: the browser asks for the system account's username and password (HTTP Basic authentication).

See Configuration files to externalize shiro.ini.

Page content​

The /system page shows the state of each instance of the cluster: Any, MessagingServer, conversionServer and thumbnailServer.

The Instances menu lists the servers that respond; five tabs detail the selected server:

  • Providers: monitoring information for each loaded provider, including Hazelcast members and locks
  • Java properties: the JVM system properties
  • System environment: the server's environment variables
  • Classpath: the JARs actually loaded by the classloader
  • Disk space: total, free and usable space of java.io.tmpdir, with a green / yellow / red status and the file details

Actions​

The Actions menu acts on the selected instance or, for most actions, on the whole cluster through the Hazelcast topic:

  • clear the caches, either all of them or only those whose name starts with a given prefix;
  • restart the cache and clear the sessions: connected users are signed out;
  • reload the providers to pick up a modified settings.json without restarting Tomcat;
  • enable or disable maintenance mode, which switches methods to a dedicated queue;
  • send a global message displayed on all connected client workstations;
  • restart an instance, in the AWS SaaS offer, through the system provider.

All these actions require the super administrator role.

Logs​

The Logs menu gives access to the logs of each instance:

  • list and download log files without access to the server;
  • change the root log level on the fly, from ERROR to TRACE;
  • reload logback.xml without restarting Tomcat.

The log level and the reload apply to all instances.

If logback.xml is configured to reload automatically every x seconds (scan="true" scanPeriod="…"), the log level changed from the page is overwritten at the next reload: the change does not last. See Logging (logback).