Installing ThingsBoard Trendz Analytics using Docker (Windows)

Prerequisites
Step 1. Obtain the license key
Step 2. Running Trendz service
Detaching, stop and start commands
Troubleshooting
- DNS issues
Next steps

This guide will help you to install and start Trendz Analytics using Docker on Windows.

Prerequisites

Install Docker Toolbox for Windows

Step 1. Obtain the license key

We assume you have already chosen subscription plan for Trendz and have license key. If not, please get your Free Trial license before you proceed. See How-to get pay-as-you-go subscription for more details.

Note: We will reference the license key you have obtained during this step as PUT_YOUR_LICENSE_SECRET_HERE guide.

Step 2. Running Trendz service

Docker Compose setup

Make sure your have logged in to docker hub using command line.

Create docker compose file for Trendz Analytics service:

docker-compose.yml

Add the following line to the yml file. Don’t forget to replace “PUT_YOUR_LICENSE_SECRET_HERE” with your license secret obtained on the first step

version: '3.0'
services:
  mytrendz:
    restart: always
    image: "thingsboard/trendz:1.11.0"
    ports:
      - "8888:8888"
    environment:
      TB_API_URL: http://10.0.0.101:8080
      TRENDZ_LICENSE_SECRET: PUT_YOUR_LICENSE_SECRET_HERE
      TRENDZ_LICENSE_INSTANCE_DATA_FILE: /data/license.data
      SPRING_DATASOURCE_URL: jdbc:postgresql://postgres:5432/trendz
      SPRING_DATASOURCE_USERNAME: postgres
      SPRING_DATASOURCE_PASSWORD: postgres
      SCRIPT_ENGINE_PROVIDER: DOCKER_CONTAINER
      SCRIPT_ENGINE_DOCKER_PROVIDER_URL: mypyexecutor:8080
      SCRIPT_ENGINE_TIMEOUT: 30000
    volumes:
      - mytrendz-data:/data
      - mytrendz-logs:/var/log/trendz
  mypyexecutor:
    restart: always
    image: "thingsboard/trendz-python-executor:1.11.0"
    ports:
      - "8181:8181"
    environment:
      SCRIPT_ENGINE_RUNTIME_TIMEOUT: 30000
      EXECUTOR_MANAGER: 1
      EXECUTOR_SCRIPT_ENGINE: 6
      THROTTLING_QUEUE_CAPACITY: 10
      THROTTLING_THREAD_POOL_SIZE: 6
      NETWORK_BUFFER_SIZE: 10485760
  postgres:
    restart: always
    image: "postgres:15"
    ports:
      - "5432"
    environment:
      POSTGRES_DB: trendz
      POSTGRES_PASSWORD: postgres
    volumes:
      - mytrendz-data/db:/var/lib/postgresql/data
volumes:
  mytrendz-data:
    external: true
  mytrendz-logs:
    external: true
  mytrendz-data-db:
    external: true

Where:

TB_API_URL - url for connecting to ThingsBoard Rest API (for example http://10.5.0.11:8080). Note that ThingsBoard IP address should be resolvable from Trendz docker container
PUT_YOUR_LICENSE_SECRET_HERE - placeholder for your license secret obtained on the first step
8888:8888 - connect local port 8888 to exposed internal HTTP port 8888
mytrendz-data:/data - mounts the volume mytrendz-data to Trendz data directory
mytrendz-data/db:/var/lib/postgresql/datad - mounts the volume mytrendz-data/db to Postgres data directory
mytrendz-logs:/var/log/trendz - mounts the volume mytrendz-logs to Trendz logs directory
mytrendz - friendly local name of this machine
--restart always - automatically start Trendz in case of system reboot and restart in case of failure.
thingsboard/trendz:1.11.0 - Trendz docker image
thingsboard/trendz-python-executor:1.11.0 - Trendz python script executor docker image
SCRIPT_ENGINE_RUNTIME_TIMEOUT - Python script execution timeout

Setup Docker volumes

Windows users should use docker managed volume for Trendz DataBase. Create docker volume (for ex. mytrendz-data) before executing docker run command: Open “Docker Quickstart Terminal”. Execute the following command to create docker volume:

docker volume create mytrendz-data
docker volume create mytrendz-data-db
docker volume create mytrendz-logs

NOTE: replace directory ~/.mytrendz-data and ~/.mytrendz-logs with directories you’re planning to used in docker-compose.yml.

Running service

Set the terminal in the directory which contains the docker-compose.yml file and execute the following commands to up this docker compose directly:

docker compose up -d
docker compose logs -f mytrendz

After executing this command you can open http://{your-host-ip}:8888 in you browser (for ex. http://localhost:8888). You should see Trendz login page.

Authentication

For first authentication you need to use Tenant Administrator credentials from your ThingsBoard

Trendz uses ThingsBoard as an authentication service. During first sign in ThingsBoard service should be also available to validate credentials.

Detaching, stop and start commands

You can detach from session terminal using Ctrl-p Ctrl-q key sequence - the container will keep running in the background.

In case of any issues you can examine service logs for errors. For example to see Trendz container logs execute the following command:

docker compose logs -f mytrendz

To stop the container:

docker compose stop mytrendz

To start the container:

docker compose start mytrendz

Troubleshooting

DNS issues

NOTE If you observe errors related to DNS issues, for example

127.0.1.1:53: cannot unmarshal DNS message

You may configure your system to use Google public DNS servers

Next steps

Getting started guide - These guide provide quick overview of main Trendz features.
Calculated Fields - Learn about Calculated fields and how to use them.
States - Learn how to define and analyse states for assets based on raw telemetry.
Prediction - Learn how to make forecasts and predict telemetry behavior.
Filters - Learn how filter dataset during analysis.
Available Visualizations - Learn about visualization widgets available in Trendz and how to configure them.
Share and embed Visualizations - Learn how to add Trendz visualizations on ThingsBoard dashboard or 3rd party web pages.