Remote Collector Management

Overview

Remote Collector Management enables clusters of monitoring collectors in a multi-site deployment to be managed remotely and independent of the Master Monitoring Server. You can also delegate the responsibility of managing the cluster to an administrator local to the cluster.

Known issue

Remote Collectors cannot correctly monitor Hosts that rely on uploaded plugins or Opspacks.

Supported operating systems

Please refer to the list of supported operating systems.

Required ports

Please see the following list for the required ports.

• Collectors to the Orchestrator Ports
• Collector Cluster Ports
• Any ports listed in the All Required Ports section with a location of All servers or Collector servers.

Remote Collector installation and registration

Permissions

Two Roles are involved in the setup of Remotely Managed Collectors.

• The first Role creates the cluster and requires the CONFIGUREREMOTECLUSTER permission.
• The second Role installs, registers, and updates Remotely Managed Collectors within the cluster. This role requires a number of permissions, including the REMOTELYMANAGEDCLUSTERS permission. A template role has been created with this set of permissions. This role can be cloned and modified to meet specific needs. For example, the role can be given permission to manage collectors within a specific cluster.

Note

The second Role does not include the CONFIGUREREMOTECLUSTER permission intentionally.

Create the cluster

This requires the CONFIGUREREMOTECLUSTER permission.

Note

You can skip this step if the remote administrator has the CONFIGUREREMOTECLUSTER permission.

1. Navigate to Configuration > Collector Management.

2. Click the + button to add a new Remotely Managed Cluster.

   

Enable access to the new cluster

The remote administrator Role can be given permission to access the new cluster.

1. Navigate to Configuration > Users and Roles > Roles.

2. Clone the existing Remote Collector Manager role and edit the new role.

   

3. On the Configuration tab, ensure the new cluster is selected under Monitoring Clusters.

   

4. On the Administration tab, ensure the new cluster is selected under Remotely Managed Clusters.

   

5. Submit changes and apply your changes by clicking Configuration > Apply Changes.

Install and register the first collector

Known issue

When adding Remote Collectors, if they are not added in alphabetical order according to FQDN, registration may fail when running the step “Join the opsview-messagequeue cluster”.

Installation and registration of the new collector are performed on the command line of the collector itself.

1. To commence the installation, run:

   curl -sSLo - https://ORCHESTRATOR/downloads/deploy-collector | sudo bash -s -- --username USERNAME --orchestrator ORCHESTRATOR --cluster "CLUSTER"
   

   • ORCHESTRATOR — replace this with the address of the Master Monitoring Server.
   • --username — name of the remote administrator.
   • --orchestrator — address of the Master Monitoring Server.
   • --cluster — the cluster name. It should match the name of the cluster added in the previous section. This must be enclosed in quotes. If the cluster does not already exist and the remote administrator has the CONFIGUREREMOTECLUSTER permission, then the cluster will be created as part of the installation and registration process.
   • --insecure — do not perform server certificate checks when connecting to the ORCHESTRATOR, see below for reference.
   • --ssh-tunnel — configure an SSH tunnel from the collector to the Master Monitoring Server, see below for reference.

   To learn about all the options available, you can use the help option:

   curl -sSLo - https://ORCHESTRATOR/downloads/deploy-collector | sudo bash -s -- --help
   

2. Enter the password for the remote administrator when prompted.

3. If certificate checking is to be disabled, add -k and --insecure to the command line:

   curl -k -sSLo - https://ORCHESTRATOR/downloads/deploy-collector | sudo bash -s -- --username USERNAME --orchestrator ORCHESTRATOR --cluster "CLUSTER" --insecure
   

   The installation and registration should take a few minutes.

   If succesful the following message will be displayed on the collector:

   Installation complete. Contact your administrator on ORCHESTRATOR and ask them to Apply Changes
   

4. After the installation has run successfully, the registration can be completed by applying the changes in Configuration > Apply Changes.

Add more collectors to the remotely managed cluster

Known issue

When adding Remote Collectors, if they are not added in alphabetical order according to FQDN, registration may fail when running the step “Join the opsview-messagequeue cluster”.

To add additional collectors to the cluster, wait until the first collector has fully registered. Then, log on to the collector to be added and enter the same command that was used to register the first collector. Do not register any further collectors in the same cluster until the first new collector has fully registered.

Problems with installation

If you encounter any problems during the installation, you can safely run the command again.

SSH Tunnels

Remotely managed collectors can be configured to route all connections to the Master Monitoring Server via SSH tunnels. This is especially useful when the Master or Collectors are behind restrictive firewalls.

If an SSH tunnel is required from the collector to the orchestrator, then the --ssh-tunnel option should be used when running the registration command:

curl -sSLo - https://ORCHESTRATOR/downloads/deploy-collector | sudo bash -s -- --username USERNAME --orchestrator ORCHESTRATOR --cluster "CLUSTER" --ssh-tunnel

Note

All collectors in the same cluster must be configured with the same option (either all use SSH tunnels or none of them).

Upgrading Remotely Managed Collectors

The user performing the upgrade must have the REMOTELYMANAGEDCLUSTERS permission for the cluster.

Upgrading via the collector command line

1. Run the command line below. This can be performed on any of the collectors in the remotely managed cluster.

   sudo /opt/opsview/scheduler/bin/collectorupgrader --username USERNAME
   

2. Enter the password when prompted.

3. If server certificate checking is to be disabled, add --insecure flag to the command line:

   sudo /opt/opsview/scheduler/bin/collectorupgrader --username USERNAME --insecure
   

Upgrading via web

1. Navigate to Configuration > Collector Management.

2. Select the clusters to upgrade and then click Upgrade clusters.

   

Troubleshooting

When running commands on the collector command line, a basic error report should be displayed on the screen. For security reasons, only minimal information should be shown to the remote user.

The Configuration > Collector Management web page will also show the status of registrations and upgrades.

Click the status pill in the Last Upgrade column to view additional registration or upgrade information.

Audit Log

The Configuration > Audit Log web page also records remote collector management configuration activities.

Log files

If you encounter any issues with Remote Collector Management, please view the system logs in the /var/log/opsview/opsview.log file on the Master Monitoring Server.