Using Fleet Manager

Starting and Stopping Fleet Manager

In a production environment you will run Fleet Manager as a service or daemon. You can also run Fleet Manager as an executable if required — which can be useful for testing purposes.

Tip: This is very similar to running Iguana (which normally runs as a service/daemon), but can be used as an executable for development and testing.

If you are familiar with running Iguana then Fleet Manager is similar — particularly for Windows.

Windows

Usually you will use the Services app to stop and start services, though you can also use the net stop and net start commands.

  1. Using the Services app:
    1. Run the Services app — search for “services” is a quick way to find it:
      services app windows
    2. Find the iNTERFACEWARE Fleet Manager service and stop it:
      windows services app
    3. Starting the service is very similar:
      windows services app
  2. Using the the net stop command:
    1. Open a Command Prompt (CMD) window as administrator — search for “CMD” is a quick way to find it:
      windows net stop
    2. To stop the Fleet Manager service run net stop in the command window:
      net stop FleetManager

      net stop

    3. To start the service run net start in the command window:
      net start FleetManager

Note: If you cannot shut down Fleet Manager you can kill the monitor.exe process — but this should only be used as a last resort.

The database will not be damaged, but it will probably take a while to recover data (by running a checkpoint) the next time you start Fleet Manager.

Linux

To stop and start Fleet Manager you will use the sudo systemctl stop FleetManager and sudo systemctl start FleetManager commands.

  1. Open a Terminal window.
  2. To stop the Fleet Manager daemon run sudo systemctl stop FleetManager in the terminal window:
    sudo systemctl stop FleetManager

    linux terminal

  3. To start the Fleet Manager daemon run sudo systemctl start FleetManager in the terminal window:
    sudo systemctl stop FleetManager

Note: If you cannot shut down Fleet Manager you can kill the monitor.exe process — but this should only be used as a last resort.

The database will not be damaged, but it will probably take a while to recover data (by running a checkpoint) the next time you start Fleet Manager.

Mac

To stop and start Fleet Manager you will use the sudo launchctl stop FleetManager and sudo launchctl start FleetManager commands.

  1. Open a terminal window.
  2. To stop the Fleet Manager daemon run sudo launchctl stop FleetManager in the terminal window:
    sudo launchctl stop FleetManager

    mac terminal

  3. To start the Fleet Manager daemon run sudo launchctl start FleetManager in the terminal window:
    sudo launchctl start FleetManager

Note: If you cannot shut down Fleet Manager you can kill the monitor.exe process — but this should only be used as a last resort.

The database will not be damaged, but it will probably take a while to recover data (by running a checkpoint) the next time you start Fleet Manager.

Running Fleet Manager as an executable

<background — need to stop the service or daemon><useful to run several (testing separate dashboards for different sets of servers???) use different ports — just like multiple Iguanas><could run several VMs for multiple production dashboards — talk to support>

  1. Windows:
    1. Run a CMD prompt.
    2. Change directory to install directory, for example:
      command-text
    3. Run the the executable:
      command-text
    4. Stop the executable
      1. Ctrl+C
      2. From Resource Monitor
  2. Linux or Mac:

Using Fleet Manager [top]

Fleet Manager enables you to monitor all your Iguana Instances in a centralized web interface. Simply register your Iguana Servers and then you can view statistics, and server message logs — statistics are also available as graphs so you see performance over time. You can display the Dashboard on any modern web browser — which means you can monitor on most devices.

fleet manager dashboard

One possible use case is to display the Dashboard on a large screen in the office — so you can see at a glance if your Iguana servers are up and running. Because we designed Fleet Manager as a monitoring tool the Dashboard view is always available whether you are logged in or not — though you will need to login to view logs, graphs and perform administration.

Fleet Manager Dashboard

This is the central management screen for Fleet Manager. From here you can see all your registered Iguana instances, add new servers, see the server status, uptime, number of channels etc. You can also drill down to see more detailed servers statistics, and you can view those statistics as graphs.

And using the Actions menu you perform administration tasks for the registered servers.

fleet manager Actions menu

Tip: You can open an Iguana Server by clicking Go to Server in the options menu:
fleet manager go to server

Global Log Viewer

The log viewer allows you to view the logs for all your registered Iguana servers — logs are imported into Fleet Manager in real time. The log screen works in a similar way to the Iguana logs screen. From here you can view the logs for a server, filter the logs you want to view, click on a log to view more details, and also export logs as CSV or plan text, etc.

fleet manager logs

Settings

From this screen you can manage your Fleet Manager settings. You can change settings for things like administrator password, SSL security, and log retention time.

Fleet Manager settings

Adding Iguana Instances [top]

The Fleet Manager Dashboard makes it easy to start monitoring your existing Iguana instances right away:

  1. Make sure you are on the Dashboard, if not then click Iguana Servers in the menu bar:
    Iguana servers fleet manager menu bar

    Note: You can view the Fleet Manager Dashboard without logging in — this enables high level monitoring for all users.

    You will need to login when you add servers, view usage details, and view the logs page or the settings page.

  2. Click the green Add Existing Instance button in the bottom right corner:
    fleet manager add server
  3. Enter the Iguana Server credentials:
    1. The URL for the Iguana instance.
    2. The Iguana Server Admin user password.
    3. And press Fetch Server Details:
      fleet manager register server
    4. The Server Name to display in the Dashboard.
      Note: This is for display only and can be changed.
    5. Choose the Server Type.
    6. And press Add Instance:
      fleet manager add server
  4. Your new Iguana instance should now appear in the Fleet Manager dashboard, like this:
    fleet manager add server

Editing and Removing Iguana Instances [top]

You can use the Actions menu in the Dashboard to update details or remove a registered Iguana instance.

  1. Select (mouse over) the Iguana instance you want to edit to display the Options menu:
    fleet manager actions menu
  2. Update display details: Use the Edit Server Details option:

    This allows you to update the Dashboard display name and server type for a registered Iguana server. This can be helpful if you want to change a server name to be more descriptive, or perhaps you listed a Development server as Production by mistake. Changing the display information has no effect the registered Iguana instance — it only changes what you see in the Dashboard.

  3. Update Iguana connection information: Use the Update Connection Info option:

    This allows you to change the URL+port and the password for a registered Iguana server. This is helpful as these are occasionally subject to change — in particular the password which can change on a regular basis.

  4. Unregister the Iguana server: Use the Remove option:

    This will unregister the specified server from the Fleet Manager and it will no longer be visible in the the Dashboard. No further log messages will be imported — but all messages imported previously will remain in the database. Deleted servers are not shown, by default, in the Global Logs — but they can be viewed by checking “Show Removed Servers”. If you re-register the same server (same Iguana ID) any existing logs in the database will be recognized as belonging to the re-registered server.

Viewing Resource Data [top]

  1. Make sure you are on the Dashboard, if not then click Iguana Servers in the menu bar:
    Iguana servers fleet manager menu bar

    Note: You can view the Fleet Manager Dashboard without logging in — this enables high level monitoring for all users.

    You will need to login when you add servers, view usage details, and view the logs page or the settings page.

  2. Click the plus sign [+] next to the Server Name that you are interested in:
    fleet manager view details
  3. A pane will drop down displaying real time data for :
    • Server Details: Information about the identity of the Iguana Server.
      • Name: Name of the managed Iguana server
      • Host: Host name of the machine where the remote Iguana is installed
      • Port:Port number of the Iguana server
      • Iguana ID: Iguana licensing ID for the Server
      • PID: Process ID for the server
    • Machine Info:
      • CPU Usage: Current percentage CPU use on the remote Iguana server
      • Memory Usage: Current memory use on the managed Iguana server
      • Disk Usage: Current disk use on the remote Iguana server
      • Socket Connections: Number of socket connections to the remote Iguana server
      • Thread Count: Number of threads currently in use by the remote Iguana server
      • Core Count: Number of CPU cores used by the remote Iguana server
      • Open Files: Number of files currently opened by the remote Iguana server
    • Log System:
      • Total size: Total size of the logs for the managed Iguana server
      • Last Week: Volume of logs created last week on the remote Iguana server
      • Daily Average: Daily average volume of logs created this week on the remote Iguana server
      • Daily Average Last Week: Daily average volume of logs created last week on the remote Iguana server
      • Latest Log Timestamp: Timestamp of the latest log loaded from the remote Iguana server

      fleet manager server statistics

  4. To see the Iguana server data graphed over time:
    • Select the Usage Details link in the data pane:
      fleet manager usage details
    • Here we can see graphs of the remote Iguana resources.
    • To change the time period viewed in the graph, use the calendar drop-downs to select the start and end dates.
    • Once you have selected date range, click View.
      fleet manager view reports

Universal Log Viewer [top]

When an instance of Iguana is added to the Dashboard the Fleet Manager backend server will copy all the Iguana server logs into the Universal Log Archive (stored in a postgreSQL database). Once log files that are stored in the archive they can then be viewed in the Universal Log Viewer.

The ULV (Universal Log Viewer) will display all logs that are stored in the archive, on a server by server basis (you cannot view the logs for multiple server at the same time). This includes logs from instances that are no longer being managed in the Fleet Manager, and Iguana instances that have been removed.

Note: If you add an Iguana instance with a large amount of historical logs then Fleet manager can take some time to load all the history. On our test machines we were able to load up to 50GB of data per hour.

  1. To access the Universal Log Viewer, click Global Logs in the menu bar:
    Fleet manager global logs
  2. There are two ways to navigate the logs:
    1. Using the four button Navigation Control:
      • First Record: The left arrow takes you to the latest record
      • Last Record: The right arrow takes you to the oldest record
      • Next Record: The Newer button takes you to the next record
      • Previous Record: The Older button takes you to the previous record
        fleet manager universal log viewer
    2. Using the scroll wheel on your mouse (or a two finger vertical trackpad gesture
  3. In the Filter Logs panel on the right you can choose various ways to filter the logs:
    Note: The log filtering works in the same way as the Iguana log filtering.

    • Search: This field supports plain text and REGEX filtering
    • Server: Choose the server to view logs from
    • Filter by Channel: Choose the channel to view logs from
    • Time Range: Choose a time range to view logs for
    • Show Log Types: Choose which log what types to view
  4. In the Export Logs panel (below the Filter Logs panel) you can choose how to export data:
    • Format: Export as plain text, formatted plain text or CSV
    • Include Related Messages: This will include related messages in the export
  5. Clicking on an individual log message will open the Log Detail pane, where you can:
    • View the whole message — useful for large messages only show the first few lines in the log view
    • Navigate to the next or previous message by clicking the Newer and Older buttons on the top right:
      fleet manager
    • Export the message by clicking the Download Log button at the bottom left:
      fleet manager

 

Leave A Comment?