Deployment

Deploy APM System Monitoring for the First Time

About This Task

The following table outlines the steps that you must complete to deploy and configure this module for the first time. These instructions assume that you have completed the steps for deploying the basic system architecture.

These tasks may be completed by multiple people in your organization. GE Digital recommends, however, that the tasks be completed in the order in which they are listed.

StepTaskNotes
1On the machine that will serve as the APM System Monitoring Server, download and install the latest version of MongoDB Community Edition.This step is required. The latest version of MongoDB Community Edition, as well as instructions about how to install it, can be found on the official MongoDB, Inc. website.

Note that instructions for configuring a Windows Service for MongoDB Community Edition are provided in the next step.

2 Configure a Windows Service for MongoDB Community Edition.This step is required.
3On the machine that will serve as the APM System Monitoring controller, install APM System Monitoring.This step is required.
4On each machine that will serve as an APM System Monitoring agent, install APM System Monitoring.This step is required.
5On the machine that will serve as the APM System Monitoring admin, install APM System Monitoring.This step is required.
6 Complete additional configuration steps related to APM System Monitoring.This step is required.
7As needed, modify APM System Monitoring settings via the Performance Monitoring feature.This step is optional.

Upgrade or Update APM System Monitoring to V4.3.1.0.0

About This Task

The following tables outline the steps that you must complete to upgrade this module to V4.3.1.0.0. These instructions assume that you have completed the steps for upgrading the basic GE Digital APM system architecture.

These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.

Procedure

  • Upgrade from any version V4.3.0.0.0 through V4.3.0.7.7

    This module will be updated to V4.3.1.0.0 automatically when you update the components in the basic GE Digital APM system architecture. No additional steps are required.

  • Upgrade from any version V4.2.0.0 through V4.2.0.9.3

    To upgrade APM System Monitoring, you should uninstall all of your existing APM System Monitoring components, and then follow the first-time deployment workflow.

Configure a Windows Service for MongoDB

Before You Begin

  • On the machine that will serve as the APM System Monitoring Server, download and install the latest version of MongoDB Community Edition.

Procedure

  1. On the machine on which you installed MongoDB Community Edition, select the Windows Start button, then navigate to and right-click Command Prompt, and then select Run as administrator.
    A command prompt window appears.
  2. On the command prompt window, enter the following:
    • mkdir c:\data\db
    • mkdir c:\data\log
    Two directories that will be used by APM System Monitoring are created.
  3. Create a configuration (.cfg) file. The file must set systemLog.path. Include additional configuration options as needed. For example, to create a file at C:\data\mongod.cfg that specifies both systemLog.path and storage.dbPath, the file would contain the following text:
    
                        systemLog:
                        destination: file
                        path: c:\data\log\mongod.log
                        storage:
                        dbPath: c:\data\db
                    
    Note: In the configuration file, each tab indentation seen in the preceding text should be replaced with two spaces.
  4. On the command prompt window, enter the following:
    "C:\Program Files\MongoDB\Server\3.2\bin\mongod.exe" --config "C:\data\mongod.cfg" --install
    Note: To use an alternate dbpath, specify the path in the configuration file (e.g., C:\data\mongod.cfg) or on the command line with the --dbpath option.
    The MongoDB service is installed.
  5. On the command prompt window, enter the following:
    net start MongoDB
    The MongoDB service is started, and the Windows service is configured.

What To Do Next

Install APM System Monitoring

Before You Begin

Procedure

  1. On the machine on which you want to install APM System Monitoring, access the GE Digital APM distribution package, and then navigate to the folder Setup\APMSystemMonitor.
  2. Open the file Setup.exe.
    The Meridium APM System Monitor installer appears.

  3. Select Next.
    The License Agreement screen appears.

  4. Read the License Agreement and, if you agree, select the I accept the terms of the license agreement check box. Then, select Next.
    The Select Installation Location screen appears.

  5. Select Next to accept the default location.
    The Select the features you want to install screen appears.

  6. If this is a machine that will serve as an APM System Monitoring agent, then select the APM System Monitor Agent check box.
    Note: A single server machine could be the APM System Monitoring administrator, the APM System Monitoring controller, and an APM System Monitoring agent. Alternatively, you can distribute this deployment as needed. For a given server machine, select the check boxes for each APM System Monitoring feature that you want to deploy.
  7. If this is the machine that will serve as the APM System Monitoring administrator, then select the APM System Monitor Administrator check box.
    Note: Only one machine will serve as the APM System Monitoring administrator.
  8. If this is the machine that will serve as the APM System Monitoring controller, then select the APM System Monitor Server check box.
    Note: Only one machine will serve as the APM System Monitoring controller.
  9. Select Next.
    The Complete the Installation screen appears.

  10. Select Install.
    The Setup Status screen appears, displaying a progress bar. When the installation is complete, the Installation is Complete screen appears.
  11. Select Finish.
    The Meridium APM System Monitor installer closes.
  12. If the machine will serve as the APM System Monitoring controller or an APM System Monitoring agent, navigate to C:\Program Files\Meridium\APMSystemMonitor, and then open the file Meridium.System.Monitor.ServiceManager.exe. If the machine will serve only as the APM System Monitoring administrator, skip this step and proceed directly to step 18.
    The Meridium APM System Monitor Service Manager window appears.

  13. If the machine will serve as the APM System Monitoring controller, then, in the Controller section, select Configure. Otherwise, skip this step.
    The Controller Configuration window appears.

  14. In the Mongo URL box, enter the URL for the MongoDB database, and then select Save and Restart.
    The machine is configured as the APM System Monitoring controller.
  15. If the machine will serve as an APM System Monitoring agent, then, in the Agent section, select Configure. Otherwise, skip this step.
    The Agent Configuration window appears.

  16. Ensure that the values in the Controller Server and Discovery Port boxes match the values specified for the APM System Monitoring controller, and then select Save and Restart.
    The machine is configured as an APM System Monitoring agent.
  17. Close the Meridium APM System Monitor Service Manager window.
    APM System Monitoring is installed on the machine.
  18. If the machine will serve as the APM System Monitoring administrator, navigate to C:\Program Files\Meridium\APMSystemMonitor\Admin, and then open the file Meridium.SystemMonitor.Admin.exe. Otherwise, skip the remaining steps and return to the first-time deployment workflow.
    The Meridium System Monitor Admin window appears.

  19. Perform the folllowing steps in the Meridium System Monitor Admin window:
    1. In the Location box, enter the location of the APM System Monitor controller, and then select Update Location.
      The connection status displayed in the lower-left corner of the window changes to Connected.
    2. Select Config, and then select Settings.
      The System Monitor Settings window appears.

    3. In the Controller Location box, enter the location of the APM System Monitor controller.
    4. Enter values in the API Key, Customer Key, and User Name boxes. You should have received these values from GE Global Support.
    5. If you did not install MongoDB in the default location, modify the value in the Database URL box as needed.
    6. If you want to disallow discovery, clear the Allow Discovery check box.
      Note: Disallowing discovery is not recommended, but may be necessary, depending on your firewall settings. A firewall may prevent automatic discovery by APM System Monitoring.
    7. If needed, modify the values in the Announcement Port and Proxy Port boxes.
    8. Select Update.
      The System Monitor Settings window closes.
    9. On the Meridium System Monitor Admin window, select Config, and then select General.
      The General Config window appears.

    10. In the Log Level To Store and Log Level to Output sections, select the check box for each log level that you want to monitor.
      Tip: GE Digital recommends that you select only the Error check boxes. If additional check boxes are selected, the log files produced may be very large.
    11. In the Days In Storage box, select the number of days logs should be stored in the system before deletion.
    12. In the Days In Outputs box, select the number of days worth of information that should be used to populate GE Digital APM dashboards.
    13. Enter values in the Email Server, From Address, and To boxes, and then select Update.
      Tip: If you want to configure emails to be sent to multiple recipients, you can enter a list of comma separated values in the To box.
      The General Config window closes.
    14. On the Meridium System Monitor Admin window, select Config, and then select Agents.
      The Agents window appears.

What To Do Next

Configure APM System Monitoring

Procedure

  1. On the machine serving as the APM System Monitoring administrator, navigate to C:\Program Files\Meridium\APMSystemMonitor\Admin, and then open the file Meridium.SystemMonitor.Admin.exe.
    The Meridium System Monitor Admin window appears.

  2. On the Meridium System Monitor Admin window, select Config, and then select Agents.
    The Agents window appears.

  3. As needed, modify the configuration of the agents, and then close the Agents window.
    Note: If you have allowed discovery (i.e., the Allow Discovery? check box on the System Monitor Settings window is selected), the Delete and New Agent buttons on the Agents window are disabled.
  4. On the Meridium System Monitor Admin window, select Config, and then select Alerts.
    The Alerts window appears.

  5. As needed, modify the configuration of the alerts, and then close the Alerts window.
  6. On the Meridium System Monitor Admin window, select Config, and then select APM.
    The Configure APM Output window appears.

  7. If you want to access APM System Monitoring information within GE Digital APM, enter values in the available fields, and then close the window.
    Note: If you do not configure the settings on this window, you can still access APM System Monitoring information via the Charts menu on the Meridium System Monitor Admin window. If you configure these settings, you will also be able to access APM System Monitoring information via the APM System Monitoring page in GE Digital APM.
  8. To create a new task, on the Meridium System Monitor Admin window, select Tasks, and then select the type of task that you want to create or modify.
    The Tasks window appears, displaying the information related to the selected task. The following image displays an example of the window for tasks of the type ServerCpuUsage.

  9. As needed, create new tasks and modify existing tasks, and then close the Tasks window.
    The configuration of APM System Monitoring has been updated.

What To Do Next