factoryinsight
Technical documentation of the microservice factoryinsight, which fetches manufacturing data and calculates various Key Performance Indicators.
2 minute read
Introduction
Factoryinsight is a microservice responsible for receiving API requests, fetching requested data from the TimescaleDB database and calculating Key Performance Indicators based on the data. This documentation provides instructions on how to set up and configure factoryinsight for development purposes.
Environment variables
Factoryinsight can be configured using the following environment variables:
| Variable name | Description | Type | Possible values | Example Values |
|---|---|---|---|---|
CUSTOMER_NAME_{NUMBER} | Specifies a user for the REST API | string | all | jeremy |
CUSTOMER_PASSWORD_{NUMBER} | Specifies the password for the user for the REST API | string | all | changeme |
DRY_RUN | If enabled, data wont be stored in database(default: false) | bool | true, false | true |
FACTORYINSIGHT_PASSWORD | Specifies the password for the admin user for the REST API | string | all | changeme |
FACTORYINSIGHT_USER | Specifies the admin user for the REST API | string | all | jeremy |
INSECURE_NO_AUTH | If enabled, no authentication is required for the REST API (default: false) | bool | true, false | true |
LOGGING_LEVEL | Defines which logging level is used, mostly relevant for developers. If logging level is not DEVELOPMENT, default logging will be used | string | any | DEVELOPMENT |
POSTGRES_DATABASE | Specifies the database name that should be used | string | all | factoryinsight |
POSTGRES_HOST | Specifies the database DNS name / IP-address for postgreSQL / TimescaleDB | string | all DNS names or IP addresses | united-manufacturing-hub |
POSTGRES_PASSWORD | Specifies the database password that should be used | string | all | changeme |
POSTGRES_PORT | Specifies the database port for postgreSQL | int | valid port number | 5432 |
POSTGRES_USER | Specifies the database user that should be used | string | an existing user with access to the specified database in postgreSQL | factoryinsight |
REDIS_PASSWORD | Password for accessing redis sentinel | string | all | changeme |
REDIS_URI | URI for accessing redis sentinel | string | all valid URIs | united-manufacturing-hub-redis-node-0.united-manufacturing-hub-redis-headless:26379 |
REDIS_URI2 | Backup URI for accessing redis sentinel | string | all valid URIs | united-manufacturing-hub-redis-node-0.united-manufacturing-hub-redis-headless:26379 |
REDIS_URI3 | Backup URI for accessing redis sentinel | string | all valid URIs | united-manufacturing-hub-redis-node-0.united-manufacturing-hub-redis-headless:26379 |
VERSION | The version of the API used | int | all | 1 |
SERIAL_NUMBER | Serial number of the cluster (used for tracing) | string | all | development |
MICROSERVICE_NAME | Name of the microservice (used for tracing) | string | all | barcodereader |
DEBUG_ENABLE_FGTRACE | Enables the use of the fgtrace library, do not enable in production | string | true, 1, any | 1 |
REST API endpoints
Last modified February 17, 2023: update (#208) (ea731fc)