Deploy

Setup using Docker

The easiest and guaranteed to work in minutes way to start using ogamma Visual Logger is running it as Docker container. If you never tried to use Docker before, we encourage you to try to install and use this powerful technology.

In the Docker host machine (where Docker and Docker-compose are installed), open console ( in Windows, open PowerShell console, in Linux, open bash terminal), and run following below commands:

git clone https://github.com/onewayautomation/ogamma-logger.git

Note

If you do not have Git installed, alternatively you can download docker/docker-compose.yml file from project’s GitHub page.

cd ./ogamma-logger/docker
docker-compose up

As a result, Docker images will be downloaded from Docker Hub, containers from those images will start, and components of ogamma Visual Logger and suported databases with web based management tools will be available at the following below URLs:

  • http://localhost:4880 : ogamma Visual Logger configuration GUI, where you can setup connections to OPC UA servers and define what variables to collect data for;

    Note

    Web GUI of the ogamma Visual Logger is optimized and tested for screen resolution 1920x1080 in full size mode, in Google Chrome and Microsoft Edge. GUI layout might be disrupted in other combinations of browse and screen resolution. If this becomes blocking issue for you, please report it at https://github.com/onewayautomation/ogamma-logger/issues.

  • http://localhost:3000: Grafana web GUI, using which you can visualize data from OPC UA Servers;

    Default credentials are admin/admin.


  • http://localhost:4888: PgAdmin web GUI, using which you can analyze historical data utilizing standard SQL queries.

    Default credentials are admin@ogamma.io/admin.


  • localhost:5432 - PtostgreSQL database with TimescaleDB extension;

    Default credentials are: ogamma/ogamma.


  • localhost:8086- InfluxDB version 1.7;

  • http://localhost:8085: InfluxDB 1.7 management web GUI. (For details on how to use it refer to project home page at https://timeseriesadmin.github.io/).

    No credentials are required to access the page.


  • http://localhost:9999: InfluxDB 2.0 management web GUI and API base endpoint;

    Default credentials and other settings are configured in initialization script file /opt/start_and_init.sh: username/password: ogamma/ogamma123, organization: ogamma, bucket: ogamma, security token: secrettoken.

    You can configure these and other settings for InfluxDB 2.0 via its web GUI.

    Note

    InfluxDB 2.0 web GUI also provides tools to run queries, build dashboards with graphs, confure monitoring of data sor conditions and generating alerts, etc. Refer to its documentation for more details at https://v2.docs.influxdata.com/v2.0/.

  • opc.tcp//opcplc:50000: OPC UA simulation server (https://github.com/Azure-Samples/iot-edge-opc-plc). Note that from the host machine it will not be available using opcplc as host name though, which might cause problems if you want to connect to it using OPC UA client running in your host PC. Refer to Docker documentation on how to make it accessible from the host machine using host name.

Tip

To stop containers which were started by command docker-compose up, you can either type Ctrl+C in the same terminal window where they were started from, or open another terminal, navigate to the folder where file docker-compose.yml is located, and run command docker-compose down.


Setup in Windows

1. Install required prerequisites

a). Install Visual C++ 2019 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

Note

Visual Logger versions prior 0.6.0 require Visual C++ 2017 redistributables.

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.

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.

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 might run some initialization steps in the database (for example, if PostgreSQL is used, it will create required 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 (port 4880). 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-1.0.1.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-1.0.1.zip
    
  • Unzip it:

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

    cd ogamma-logger
    
  • install dependency library odb:

    Note

    Installation of odb is not required on versions 0.8.4 and newer.

    sudo apt install odb
    
  • Make binary file executable:

    chmod 764 ogamma-logger && chmod 764 libdna.so
    
  • Verify and correct if required other file permissions (in version 0.7.1 due to file permission settings application might fail to start). Refer to Linux manual on how to set permissions.

  • 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.

Upgrading from older versions.

Tip

Before upgrading to the new version, stop existing application and create backup of your application data folder (usually sub-folder ./data) and backup of configuration database to avoid any data loss.

Docker containers.

If you are upgrading from older version of Docker container, then you can just stop the continer, run the command docker pull ogamma/logger to get the latest version from Docker Hub, and start container.

Windows and Ubuntu installations.

  • Install ogamma Visual Logger for OPC into new location, but do not start it.
  • Stop existing instance;
  • Copy folder ./data from older installation to the new installation location;
  • Start new instance. If required, it will upgrade config files and configuration database.