Deploy

Setup using Docker

For instructions on how to setup using Docker please refer section Getting Started.

Setup in Windows

1. Install required prerequisites

a). Install Visual C++ 2017 redistributables (64 bit version)

Can be installed using installation file (vc-redist.x64.exe) included into the distribution package.

Latest downloads are available at https://support.microsoft.com/en-ca/help/2977003/the-latest-supported-visual-c-downloads

Direct link: https://aka.ms/vs/15/release/vc_redist.x64.exe

b). Install / Configure database to store time-series data.

Note

This step can be skipped if you plan to read real time and historical data from OPC UA servers directly, without storing values in database. In this case configuration file ./data/config.json needs modification though: setting collector-agent/enabled should be set to false.

For information on supported databases and how to install/configure them, refer to the section Time-Series Databases.

2. Install ogamma Visual Logger

Note

By default ogamma Visual Logger is configured to use configuration file at location data/config.json (relative to the current working folder), althouth folder data does not exist after installation. The point is that it is recommended to use separate folder for all installation instance specific data, which is by default to be in folder data. When the application is started, it checks if configuration file exists in expected location, and if it does not exist, it copies original config.json file from original installation location. Therefore, if you want to use modify settings, create folder data, copy config.json file to it, and then modify file data/config.json.

For more details on configuration file, refer to section

3. Start ogamma Visual Logger.

Open Windows command line console, navigate to the folder where ogamma Visual Logger files are unzipped, and start application ogamma-logger.exe. At the very first start, it will create tables in the PostgreSQL database. Before connecting to the frist OPC UA server (after adding it from GUI and attempt to browse), it will also generate OPC UA Application Instance Certificate, which might take some time.

The application has built-in web server to support web based GUI to configure it, and it will listen to http port of that configuration endpoint. Windows operating system will pop-up dialog window asking for permission to listen on the port, you will need to allow it.

4. Install Grafana

Note

This step can be skipped if you do not want visualize data.

To install Grafana, follow instructions at Grafana

Setup in Ubuntu 18.04

Distribution package for Ubuntu 18.04 is available at https://onewayautomation.com/opcua-binaries/ogamma-logger-ubuntu1804-0.5.2.zip

To download and install it from terminal:

  • Open terminal (keyboard shortcupt Ctrl+Alt+t can be used).

  • Update package lists:

    sudo apt update
    
  • Install tools wget and unzip:

    sudo apt install wget unzip
    
  • Download distribution package:

    wget https://onewayautomation.com/opcua-binaries/ogamma-logger-ubuntu1804-0.5.2.zip
    
  • Unzip it:

    unzip ogamma-logger-ubuntu1804-0.5.2.zip -d ogamma-logger
    
  • Navigate to the folder where it is extracted to:

    cd ogamma-logger
    
  • install dependency library odb:

    sudo apt install odb
    
  • Make binary file executable:

    chmod 764 ogamma-logger
    
  • Run ogamma Visual Logger:

    ./ogamma-logger
    

    If application does not start, then check error messages in console. If required, adjust settings in the configuration file data/config.json and start application again.

Note

In default basic configuration file data/config.json in distribution package for Ubuntu the field configDb is set to use PostgreSQL type database, therefore if PostgreSQL is not running, then ogamma Visual Logger would not start. If you want to avoid using of PostgreSQL and not use feature Store, then field configDb/type should be set to SQLite and configDb/path should be set to location of the SQLite database file, for example ./data/config.db, and field collector-agent/enabled should be set to false.

Setup in Debian Stretch

Distribution package for Debian is available at https://onewayautomation.com/opcua-binaries/ogamma-logger-debian-0.5.2.zip

To download and install it from terminal:

  • Open terminal.

  • Update package lists:

    sudo apt update
    
  • Install tools wget and unzip:

    sudo apt install wget unzip
    
  • Download distribution package:

    wget https://onewayautomation.com/opcua-binaries/ogamma-logger-debian-0.5.2.zip
    
  • Unzip it:

    unzip ogamma-logger-debian-0.5.2.zip -d ogamma-logger
    
  • Navigate to the folder where it is extracted to:

    cd ogamma-logger
    
  • install dependency library odb:

    sudo apt install odb
    
  • Make binary file executable:

    chmod 764 ogamma-logger
    
  • Run ogamma Visual Logger:

    ./ogamma-logger
    

    If application does not start, then check error messages in console. If required, adjust settings in the configuration file data/config.json and start application again.

Note

In default basic configuration file data/config.json in distribution package for Debian the field configDb is set to use PostgreSQL type database, therefore if PostgreSQL is not running, then ogamma Visual Logger would not start. If you want to avoid using of PostgreSQL and not use feature Store, then field configDb/type should be set to SQLite and configDb/path should be set to location of the SQLite database file, for example ./data/config.db, and field collector-agent/enabled should be set to false.