Install and Configure the Symphony Service Monitor

This applies to: Visual Data Discovery

The Symphony Service Monitor microservice is not installed as part of a default Symphony installation. The microservice name is zoomdata-admin-server.

To install, configure, and start the Service Monitor:

  1. Open your SSH client.

  2. Use the following command to install the Symphony Service Monitor in a CentOS environment: 

    sudo yum install zoomdata-admin-server -y

    Use the following command to install the Symphony Service Monitor in an Ubuntu environment: 

    sudo apt-get install zoomdata-admin-server

  3. After the Service Monitor is installed, you must specify a user name and password in its properties file. The properties file is called admin-server.properties and can be found in the /etc/zoomdata/ directory (Linux) or the <install-path>/conf-modify/ directory (Windows). If the properties file is not there, create it. The properties that must be defined are:

    • monitor.user.name=<username>
    • monitor.user.password=<password>

    Edit the properties file with a text editor and substitute a Service Monitor user name for <username> and its associated password for <password>. The user name and password can be any user name and password you want.

    When you have finished, save the file.

  4. Add the following properties to the zoomdata.properties file, located in the /etc/zoomdata directory (Linux) or the <install-path>/conf-modify/ (Windows). These properties ensure that the Service Monitor has access to the Symphony server actuator endpoints.

    • actuator.user.name=<Composer-admin-username>
    • actuator.user.password=<Composer-pswd>
    • actuator.logging.external-file=<log-file-path>

    Edit the properties file and substitute the valid user name and password of a Symphony administrator for <Composer-admin-username> and <Composer-pswd>. If the default Symphony log file path is not used for your installation, substitute your custom log file path for <log-file-path>. The default log file path is /opt/zoomdata/logs/zoomdata.log for Linux and <install-path>/logs/zoomdata.log for Windows.

    Setting these properties exposes valid Symphony credentials as plain text in both the properties file and as tags in the Symphony Consul. Anyone in your network with the ability to communicate directly with the Consul API or view the Consul UI will be able to see these values.

    When finished, save the file.

  5. Start the microservice. For example, use the following command to start the Symphony Service Monitor using systemd in a CentOS or Ubuntu environment:

    sudo systemctl start zoomdata-admin-server

    See also Start Symphony Microservices.