Installing and Upgrading Seeq


Introduction

This article covers the installation and upgrading the Seeq Server. Upgrading Seeq is identical to Installing Seeq except for the details noted in the section below Installing and Upgrading Seeq#Upgrade Considerations

Cloud Options

Before you install Seeq on-premise or in your private cloud, consider contacting Seeq about our cloud hosting options. When Seeq hosts your deployment of Seeq Server, Seeq personnel can more easily monitor load, troubleshoot problems, and commission more hardware resources as usage increases. 

A hosted Seeq Server can access both on-premise and cloud-based systems. Historians, datasources, identity management systems and messaging systems can be accessed via Remote Agents. There are a variety of authentication and security models to fit your needs. Contact Seeq Support for more information.

Seeq Version Requirements

New releases of Seeq are available approximately every quarter. Seeq recommends installing or upgrading to the latest release to benefit from

  • Security improvements

  • Performance improvements

  • Bug fixes

  • New features!

The minimum recommended version of Seeq is R53.4.0 If using an older version, please upgrade before contacting Seeq support.

Hardware Requirements

Seeq Server hardware is a critical factor affecting user experience. Since Seeq is a self-service analytics application, computational load on the server can vary dramatically based on user activity. CPU, memory and storage performance are of particular importance.

The following table details the minimum hardware requirements for Seeq Server given the number of active users (where "active" denotes users that are accessing the system within a few hours of each other).



1 to 10 Users

10 to 50 Users

50 to 150 Users

150 to 400 Users

400 to 800 Users

800+ Users

CPU Architecture

64-bit

CPU Cores

8

16

32

52

96

128

Memory

32 GB

64 GB

128 GB

384 GB

768 GB

1 TB

Storage Performance

Solid state drive with 2,500 IOPS or greater.

Solid state drive with 20,000 IOPS or greater.

Available Storage

500 GB free disk space. If datasource caching is enabled, more space is likely needed.*

2 TB+ free disk space. If datasource caching is enabled, more space is likely needed.*

OS

Microsoft Windows Server 2012 or later
Ubuntu LTS versions 18.04 or 20.04

*As of R53.0.0, the maximum storage space allotted to Seeq's persistent cache can be limited via the `Cache/Persistent/Series/MaxSize` configuration option. See Datasource Caching for more information.

If Seeq's REST API or SDKs are being used to automate calculations in the background, you will need to account for the additional load in your hardware specification.

As you scale your deployment of Seeq, please consult Seeq Support for additional guidance to take your particular situation into account.

Seeq may be installed on a physical machine or virtual machine (VM). VMs are most commonly used.

Seeq recommends that dedicated resources are allocated to Virtual Machines in environments such as VMWare ESXi and HyperV as shared resources can result in varying performance.

Seeq recommends the instance types of AWS m5a series & Azure DxS series with disk sizes between 800 - 1200GB to provide the required IOPS. It is not recommended to use burstable instances such as AWS T2 & T3 series or Azure B series as these can result in varying performance.

Network Requirements

Seeq Web Application Access

Seeq web applications use a combination of HTTP/S and WebSocket connectivity. This is done to increase performance between the Seeq server and the web application on the client machine. In order to facilitate this, any networking components (such as proxies) need to support and allow WebSocket traffic. 

Browser Requirements

Seeq Workbench

Seeq Workbench is 100% HTML5 based. No software, other than a compatible browser, needs to be installed on the Seeq users' computers. Here are the supported browsers:

  • Google Chrome (recommended)

  • Microsoft Edge

  • Mozilla Firefox

  • Apple Safari

Internet Explorer has disabled by default since R51, and, in keeping with Microsoft's overall movement toward its Edge browser, R53 is the last release with support for Internet Explorer.

Supported hardware platform for using Seeq Workbench is a computer with a keyboard and pointing device (e.g. mouse or touchpad). Tablets and smart phones may not render the Seeq Workbench UI properly due to space constraints and their touch-screens may not give the proper zoom and scroll experience. Organizer Topics can be used to target content to mobile devices.

Seeq Workbench does require relatively modern workstations / laptops so that the browser has enough resources to render the visualizations and respond to user interactions with adequate performance:

CPU

Intel Core i7
(or comparable AMD)

Cores

2

Memory

4 GB

Display Resolution

1600x1200

HD

no specific requirement

HD Size

no specific requirement

OS

no specific requirement



It's important to run the browser on a workstation separate from Seeq Server so that the browser does not compete for resources with server computation activity.

Seeq Organizer

When authoring Seeq Organizer Topic documents, the browser requirements are the same as above (for Seeq Workbench). However, when viewing Organizer Topics using a Presentation link, you can use any device that has a browser, including tablets and mobile phones.



The Organizer Topic Presentation mode was specifically designed to use simple HTML and minimal JavaScript so that it can be consumed on devices with modest resources.

Downloads

Please download Seeq Server from the links on the Product Download page. For earlier versions, pre-release versions, our connector SDK, please contact us at support@seeq.com.

Upgrade Considerations

Upgrading Seeq is identical to installing Seeq with two exceptions:

  • Presumably, the prerequisites such as hardware, communication ports, etc., have been addressed; you may want to review those as part of the upgrade.

  • The few items addressed in this section.

Upgrade specific tasks:

  • Check the Supported Version Upgrades page to ensure that your planned upgrade path is supported.

  • All asynchronous migrations must be complete before upgrading to a new major version of Seeq Server (R50+).

    • The seeq diag migration command can be run via the Seeq CLI to check the status of asynchronous migrations.

  • Perform a manual backup of the Seeq program and data files before performing an upgrade, as detailed in the Manual Backups section of Backup of the Seeq Database.

  • Your organization may have created programs or applications using the Seeq SDKs. These may need minor updates to run with the new version of Seeq. Contact Seeq Support, support@seeq.com, if you have questions.

  • Read the release notes (available at the end of installation or by double-clicking on C:\Program Files\Seeq Server\ReleaseNotes.html) for other upgrade considerations.



It's important to check your free disk space prior to a backup or upgrade to ensure you'll have enough room to hold the backup and/or handle the upgrade process.  For a backup you should estimate you'll need the same amount of space for the backup as your current C:\ProgramData\Seeq\data folder size.  For upgrading ensure you have at least as much free space as your current C:\ProgramData\Seeq\data takes up in case the upgrade process makes a copy in order to perform any upgrade conversions.

Network Communication Ports

By default, only port 34216 needs to be accessible by other computers. This may require firewall settings modification. All other ports are used for inter-process communication on the computer where the Seeq Server runs.

To change this default port (see this page for more details):

  • For prior Seeq Server versions:

The Seeq Server processes open several "internal" ports in the range 34210-34230; in the event that this block of ports conflicts with other applications on the server, you can configure this range by:

  • For prior Seeq Server versions:

Network firewalls are a common source of problems inhibiting proper use of Seeq applications. The Seeq Server machine typically has a firewall installed, and it should be modified to allow external connections to the Seeq Server port.

Hardware firewalls that are part of the infrastructure must be configured to allow connections to the Seeq Server machine and, in particular, must allow WebSocket connections.

Network Hostname

Starting in R22.0.49.00 and later, Seeq can only be accessible from one network hostname. Seeq will attempt to redirect clients to the configured hostname. By default, this hostname will be the machine name of the server. If this name doesn't resolve on user computers Network/Hostname will need to be configured as described in Seeq Configuration and User Data Files.



If after installing or upgrading to Seeq R22.0.49.00 or later, you find that you can't connect to Seeq because it redirects to a non-existent url you'll likely need to configure Network/Hostname. For example, if you have created a dns entry for the Seeq Server so that it can be accessible by users at http://seeq.example.com:34216, but navigating to that url redirects your browser to http://win-abc123xyz:34216 and fails to connect, then you'll need to configure Network/Hostname to be "seeq.example.com"   To do this, open the Seeq Command Prompt and issue the command "seeq config set Network/Hostname seeq.example.com"

Data Folder Location

By default, Seeq will create its internal database at C:\ProgramData\Seeq\data. You can control this location as detailed in Changing the Seeq Data Folder Location.

Antivirus Considerations

Many server instances will have a form of antivirus installed. For example, starting with Windows Server 2016, Windows Defender is installed and enabled by default.

Installation errors have occurred due to antivirus programs therefore it is recommended that antivirus is disabled during installations and upgrades.

Benchmarks have shown that antivirus can slow server performance by orders of magnitude.

In some cases, Seeq personnel have observed that Windows Defender can cause Seeq Server to become too slow for practical use. If you are observing poor performance, temporarily disable Windows Defender to test if performance returns to normal.

Excluding Seeq Processes from Antivirus Monitoring

The following executables must be added to your Antivirus exclusions. The filenames are relative to the folder that Seeq Server is installed to (e.g., C:\Program Files\Seeq Server on Windows).

Seeq R22.0.48.xx and older

Windows

1 2 3 4 5 6 jre\files\bin\javaw.exe jre\files\bin\java.exe webserver\image\nodejs\files\node.exe webserver\image\chromium\files\chrome-win\chrome.exe net-link\image\Seeq.Link.Agent.exe postgres\files\bin\postgres.exe

Linux

1 2 3 4 jre/files/bin/java webserver/image/nodejs/files/node webserver/image/chromium/files/chrome-linux/chrome postgres/files/bin/postgres



Seeq R22.0.49.xx and newer

Windows

1 2 3 4 5 6 7 8 9 10 11 jdk\files\bin\javaw.exe jdk\files\bin\java.exe jre8\files\bin\javaw.exe jre8\files\bin\java.exe python\files\python.exe renderer\image\nodejs\files\node.exe renderer\image\chromium\files\chrome-win\chrome.exe net-link\image\x64\Seeq.Link.Agent.exe net-link\image\x86\Seeq.Link.Agent.exe postgres\files\bin\postgres.exe nginx\files\nginx_basic.exe

Linux

1 2 3 4 5 6 7 jdk/files/bin/java jre8/files/bin/java python/files/python renderer/image/nodejs/files/node renderer/image/chromium/files/chrome-linux/chrome postgres/files/bin/postgres nginx/files/nginx



Excluding Seeq Data Folders from Antivirus Monitoring

The Seeq data folders must be added to your Antivirus exclusions. By default, the data folders are located in C:\ProgramData\Seeq; this article describes customizing the location of the Seeq data files: Data Locations.

Antivirus Monitoring Exclusion Articles

This table links to various articles on adding exclusions to popular antivirus software. (Updated 2017-10-24.)

Endpoint Privilege Management Software / Privileged Access Management Software

Some companies also employ Endpoint Privilege Management Software (a.k.a. Privileged Access Management Software) - which is typically centrally managed and acts as a tool to manage which software is allowed or disallowed to be installed.

If this software is present please temporarily disable it during Seeq software installs and upgrades else it may stop the install/upgrade of Seeq part way through the process.

Endpoint Security Software

Some Endpoint Security Software products like Carbon Black can cause difficulties when installing, updating and starting starting the Seeq application as they seek administrative permission to execute certain scripts & binaries.

It is recommended that the Seeq Server installation folder & Seeq data directory are both allow listed to execute scripts & binaries to avoid these types of issue.

Defragmentation and Solid State Drives (SSD)

It's highly recommended to use SSDs for the Seeq data directory. When SSDs are used in a hardware RAID configuration, Windows usually won't be able to detect that the drives are in fact SSDs, which means that Windows will schedule weekly defragmentation of the drives as if they were regular spindle hard disk drives, which isn't needed and isn't recommended for SSDs. Seeq stores cached data in files, which to Windows eventually will appear to be very fragmented, but the fragmentation is only an issue because Windows thinks it's a regular hard disk drive.

To check the Windows defragmentation settings, launch the "Defragment and Optimize Drives" application. It should show a list of the drives like the following screenshot:

If the media type column for the drive containing the Seeq data directory is listed as "Hard disk drive" and not "Solid state drive" (like the example in the screenshot), but the drive is actually an SSD, we recommend turning off the scheduled optimization by clicking the "Change settings" button, then uncheck the "Run on a schedule" checkbox and click the "OK" button:

Installing Seeq on Windows Server

The following instructions are for installing Seeq on Windows Server. To install Seeq on Ubuntu, see Installing Seeq on Ubuntu.

  1. Download the latest Windows Server 64-bit version of Seeq via https://www.seeq.com/customer-download. Move the installation kit to the Seeq machine, if it is not already there.

  2. Disable antivirus and endpoint management software while installing or upgrading.

  3. Run the installation executable by right clicking on it and selecting Run As Administrator to begin installation. You will be prompted for some information. 

The only user input, which is optional, is where the Seeq executables and other files are installed. The default should work in most cases. Note that the Seeq data files are created elsewhere. If the installation folder is changed, the new location must still be a local drive and satisfy the requirements described in Configuring Windows File Permissions. The Seeq data folder may be set via the Seeq CLI if the default location of C:\ProgramData\Seeq\data is not desired, see: Changing the Seeq Data Folder Location.



By default, Seeq Server is configured to use the insecure HTTP protocol. It is strongly recommended that the secure HTTPS protocol is instituted as soon as possible by following the guidance at Secure Configuration Options (SSL/TLS).

HTTP is unencrypted, which means that usernames and passwords will be exposed to any network analyzing tool, and therefore are essentially exposed to other users on your network. HTTPS (SSL/TLS) is the only secure way to protect usernames, passwords and other sensitive information.

Starting Seeq Server

Seeq will automatically start Seeq, from the above dialog, or Seeq can be started by running the shortcut Launch Seeq. The first time Seeq is run, it is run interactively and a dialog is displayed. Seeq will automatically connect to the default OSIsoft PI historian (if available) and begin indexing. Also from the Seeq dialog you can:

As of R20.0.38.00, the system will display a warning banner to admin users if Seeq Server is running on a computer below the minimum requirements. If upgrading the components is not an option, the warnings can be disabled by:

  • For prior Seeq Server versions:

    • Add the following line to the global.properties file:

      1 seeq_hardware_warnings_disabled=true



Note: You don't have to stop Seeq to enact this change; just make the changes described above.  When you refresh the page the warnings will be gone and the warning banner on login will no longer appear.

When you start Seeq for the first time, the following dialog appears:

As the dialog says, this user name and email is associated with log file uploads and bug reports submitted to Seeq. This user name and email may be changed in the future. 

Running Seeq Workbench

Open a supported browser and enter the Seeq server name or address followed by :34216 (for example, http://myseeqserver:34216). The port numbers used by Seeq can be configured, see Seeq Server HTTP Port. This will bring you to the the Seeq login screen:



The first user to register in Seeq will be given administrative privileges; administrators can be added or removed later. Click on "Register New" and add a user and password; consider using the same user in the above dialog. 

License Activation

Seeq uses a node-locked license. To request a license, log into Seeq, and select the hamburger stack, upper right, and select license management:

This brings you to the following page where you can request a license and also upload the license once requested. Seeq generally responds to license requests with 2 hours during normal business hours.

Diagnostic Information

Seeq Server includes a tool that inspects the hardware and software configuration to report on overall health of the server.

In order to fully test the Seeq system, be sure to run this after Seeq has finished starting up and is in the "Server is running" state as noted in the status area of the Seeq Supervisor tool (if on Windows that is.)

If the diagnostics are run when Seeq is shut down, then the last set of tests will not pass since those are checking that Seeq systems, like the web server, are running.  In this case that would be expected and not a cause of concern, but the best full test should be done while Seeq is running.

To run the tool, launch the Seeq Server Command Line Interface (CLI) and run the following command:

1 seeq diag info

If there are any warnings or errors at the end of the command output, scroll up to see what is causing them.

Usage Information

Seeq Workbench sends usage information to Seeq. No customer data is sent, only metrics like 'features used'. Seeq uses this information to help inform product development decisions. This feature can be disabled.