Spotfire® Server and Environment - Installation and Administration

Setting up JMX monitoring for JConsole

This task walks you through setting up JMX monitoring for using JConsole. It does not use Transport Layer Security (TLS).

Before you begin

  • You must have administrative credentials for Spotfire Server. If Spotfire Server is set up to authenticate with the Spotfire database using Windows Integrated Authentication, you must run commands as the same user that Spotfire Server authenticates as. Otherwise, the commands cannot authenticate with the database.
  • You must have access to JConsole.

About this task

Perform this task at a command-line prompt on the server, from the directory where the file config.bat (on Windows) or config.sh (on Linux) is installed. By default, this location is <server installation dir>/tomcat/spotfire-bin.

Procedure

  1. Open a command line as an administrator (or, if you are using Windows Integrated Authentication, as the Spotfire Server database user).
  2. At the command line, run the command config export-config.
    Provide the tools password when prompted.
    The configuration is successfully exported and is ready to change.
  3. At the command line, run the command config config-jmx --enabled=true.
    Provide the tools password when prompted.
  4. Import the configuration by running the command config import-config --comment=”Enabling JMX” configuration.xml.
    Provide the tools password when prompted.
  5. Create a JMX user by running the command config create-jmx-user --username=MyJMXUser.
  6. Provide a password for the user MyJMXUser.
    Provide the tools password when prompted.
  7. Restart Spotfire Server.
  8. Browse to the jdk directory containing the JConsole executable.
    The JConsole executable is in the bin directory of the Java Development Kit installation, such as <JAVA_HOME>/bin.
  9. Launch the JConsole application.
  10. In the JConsole New Connection dialog, select Remote Process, enter <hostname>:1099, and then provide the JMX username and password.
    • For accessing Information Services metrics, enter <hostname>:1100.

    Tip: To view the Spotfire information, click the MBeans tab, and then select the com.spotfire.server domain.