Control Hub Admin Tool

Control Hub includes a separate Admin tool. Use the Control Hub Admin tool to monitor and troubleshoot Control Hub issues. For example, if Control Hub becomes inaccessible, the Admin tool remains running. You can still log into the Admin tool to troubleshoot the Control Hub issues.

To log in to the Admin tool, use the second URL listed in the command output when you launched Control Hub:
http://<host name>:18632/admin.html

Log in as the default system administrator named "admin" using the password that you entered for the Control Hub setup script. You can change or remove this user account, or you can configure additional users.

The Admin tool lists each Control Hub instance with the time that Control Hub was last updated:

Click the following links to access monitoring information about each Control Hub instance:
  • Metrics - Displays metrics for each Control Hub application.
  • Threads - Displays a thread dump for Control Hub.
  • Logs - Displays the most recent log information. Access the complete log file in the following location:

    $DPM_LOG/dpm.log

  • Log4j Config - Displays the contents of the log configuration file, dpm-log4j.properties. You can modify the log level to display messages at another severity level.
  • Server Config - Displays a read only view of the contents of all the Control Hub configuration files. To modify the properties, locate the files in the $DPM_CONF directory.

    If you modify a property, restart Control Hub for the changes to take effect.

  • Flush Caches - Flushes the Security application cache, so that changed roles take effect immediately. In most cases, you won't need to flush the cache.
  • Build - Information about the currently installed Control Hub version.

Configuring Users

The Control Hub Admin tool uses file-based authentication - it does not use the Control Hub authentication method. To configure additional user accounts that can log into the tool, configure the $DPM_CONF/basic-realm.properties file.

The Admin tool provides a default user account named "admin". You can change or remove this user account, or you can create new user accounts. For increased security, change the password for the default user account.

The Admin tool provides a single sys-admin role that you must assign to each user. The sys-admin role allows the user to complete all tasks in the Admin tool.

To hash login information, you can use an md5 program such as md5sum on Linux.

Hash the password alone. For example:
echo -n "<password>" | md5
  1. In the basic-realm.properties file, add a user definition for each new user using the following format:
    <user name>: MD5:<md5-text>, user, <role>
    Note: Assign the sys-admin role to each user. Be sure to include "user" in every user definition.
    For example, the following line defines a user named jsmith:
    jsmith: MD5:a66e44736e753d4533746ced572ca821,user,sys-admin
  2. To make the new users available, restart Control Hub.

Modifying the Log Level

If the Control Hub logs do not provide enough troubleshooting information, you can modify the log level to display messages at another severity level.

Note: If you installed multiple Control Hub instances for a highly available environment, each Control Hub instance has its own log file. You must modify the log level for each Control Hub instance.
By default, Control Hub logs messages at the INFO severity level. You can configure the following log levels:
  • TRACE
  • DEBUG
  • INFO (Default)
  • WARN
  • ERROR
  • FATAL
  1. In the Control Hub Admin tool, click Log4j Config for one of the Control Hub instances.
    The Admin tool displays the contents of the log configuration file, $DPM_CONF/dpm-log4j.properties.
  2. Change the default value of INFO for the following lines in the file:
    log4j.logger.com.streamsets=INFO
    ...
    log4j.logger.com.streamsets.lib.jpa=INFO

    The first line defines the log level for the Control Hub applications. The second line defines the log level for the Control Hub databases.

    For example, to set the log level for the applications and the databases to DEBUG, modify the lines as follows:

    log4j.logger.com.streamsets=DEBUG
    ...
    log4j.logger.com.streamsets.lib.jpa=DEBUG
  3. Click Save.
    The changes that you make to the log level take effect immediately - you do not need to restart Control Hub. You can also change the log file by directly editing the log configuration file, $DPM_CONF/dpm-log4j.properties.
  4. For a highly available environment, repeat these steps for each Control Hub instance.

When you’ve finished troubleshooting, set the log level back to INFO to avoid having verbose log files.