IndustryKit

IndustryKit is a standalone, read-only industrial data collector deployed on a Linux or Windows host that can reach the device network. It collects data from PLCs, meters, OPC UA Servers, MQTT Brokers, and SNMP devices, then reports the data to Dataway as metrics (metric) or logs (logging).

IndustryKit cannot write registers or coils, control PLCs, perform SNMP SET operations, or accept remote configuration.

Features¶

One IndustryKit process can contain multiple sources. Modbus, OPC UA, S7, and SNMP use points to define collection addresses and output fields. MQTT uses topics and fields to define message mappings. Each source can use a different measurement.

Requirements¶

• Release packages are available for Linux amd64/arm64 and Windows amd64/arm64. The online installer detects the architecture automatically.
• The Linux installer requires a running systemd. Linux commands in this document assume the root user.
• Windows 10, Windows Server 2016, or later is required. Run the installer from an elevated Windows PowerShell 5.1 or later.
• The deployment host must be able to reach the protocol port of each target device or Broker and access Dataway over HTTP/HTTPS.
• Device addresses are resolved from the IndustryKit host. 127.0.0.1 always refers to that host. For a simulator or device on another host, the peer must listen on a reachable address and its firewall must allow the connection.
• Prepare any device accounts, SNMP v3 credentials, or TLS certificates required by protected devices before configuration.
• Modbus TCP, classic S7, OPC UA None, and MQTT tcp:// do not provide transport encryption. Use them only on a trusted industrial network, through a VPN, or within a firewall-restricted subnet.
• No official container image is currently provided.

Installation¶

The first installation requires a complete Dataway URL containing its token query parameter. Optionally set INDUSTRYKIT_COLLECTOR_ID to specify the collector instance ID; the hostname is used when this variable is not set. IDs support Unicode characters, including Chinese, but must not be blank or contain control characters. The Dataway URL must be an absolute http:// or https:// URL with exactly one non-empty token query parameter and no userinfo or fragment. IndustryKit appends the write path.

INDUSTRYKIT_DATAWAY_URL="https://openway.truewatch.com?token=<DATAWAY_TOKEN>" \
  sh -c "$(curl -fsSL https://static.truewatch.com/industrykit/install.sh)"

Remove-Item -ErrorAction SilentlyContinue Env:INDUSTRYKIT_*;
$env:INDUSTRYKIT_DATAWAY_URL = "https://openway.truewatch.com?token=<DATAWAY_TOKEN>";
Set-ExecutionPolicy Bypass -Scope Process -Force;
Import-Module BitsTransfer;
Start-BitsTransfer -Source https://static.truewatch.com/industrykit/install.ps1 -Destination .install.ps1;
powershell ./.install.ps1;

Installation paths¶

Linux installation requires administrator privileges, but the service runs as the unprivileged industrykit user by default. Modbus RTU also requires serial-port permissions for this user. See Modbus serial-port permissions on Linux.

On Linux, the configuration, data root, and log directories use 0755; the configuration and sample use 0644. Standard users can browse these directories and read the configuration, but editing it still requires administrator privileges. New log files retain the logging library's 0600 mode. New WAL category directories and data files use the diskcache defaults of 0750 and 0640, respectively; reading their contents may still require administrator privileges.

On Windows, the installation directory, configuration, logs, WAL, and PKI inherit permissions from their parent directories without additional administrator-only restrictions. Actual access depends on system settings. Installation, upgrades, and service management still require administrator privileges. If saving the configuration is denied, run your editor as administrator.

Configure and start¶

The generated industrykit.toml contains the Dataway, logging, WAL, and collector ID settings, as well as commented examples for all five protocols. No effective [[sources]] entries are enabled by default, so starting the process in this state does not collect device data.

The configuration format version is declared with version = 1. Common configuration fields are described below. See the protocol-specific documents for device protocol fields.

[collector]¶

[logging]¶

Logs are retained for up to 30 days. This retention period is not currently configurable.

The [logging] section controls IndustryKit's own runtime logs. It is unrelated to device data configured with category = "logging".

[dataway] and optional [dataway.tls]¶

Relative TLS certificate paths are resolved from the directory containing the main configuration file.

[dataway.batch]¶

The current batch enters the WAL for delivery when the point count, encoded size, or wait-time limit is reached, whichever comes first.

[dataway.wal]¶

WAL records are removed only after Dataway returns a successful response. New batches are rejected when the queue is full, and records past the retention limit are discarded during consumption.

Common [[sources]] fields¶

Common point fields¶

The [[sources.<type>.points]] entries for Modbus, OPC UA, S7, and SNMP share the following fields. MQTT uses topic mappings; see MQTT configuration.

collector_id, protocol, and source_id are fixed tags added by the system and cannot be set in tags.

Choose the required protocol document, uncomment or copy a complete source example into the configuration file, and replace the device address, points, <...> credential placeholders, and certificate paths:

Each source must also contain the protocol subsection whose name matches its type. Output is mapped as follows:

Validate the configuration, then start the service after validation succeeds:

industrykit validate --config /etc/industrykit/industrykit.toml
systemctl start industrykit
systemctl status industrykit --no-pager

$IndustryKit = "$env:ProgramFiles\IndustryKit\industrykit.exe"
$Config = "$env:ProgramFiles\IndustryKit\industrykit.toml"
& $IndustryKit validate --config $Config
& $IndustryKit service start
Get-Service industrykit

Starting at boot is optional: run systemctl enable industrykit on Linux, or Set-Service -Name industrykit -StartupType Automatic in an administrator PowerShell session on Windows.

The configuration is read only at startup. Restart the service after making changes.

Configuration supports ${ENV_NAME} variable references, but systemd and Windows services do not automatically inherit temporary environment variables from the current shell. When using this syntax, persist the variables through the corresponding service manager. Otherwise, put the actual values directly in the TOML file. The configuration contains credentials; review and set its read permissions according to your host's security requirements.

Verify collection and delivery¶

After the service starts, check the local health endpoints first:

curl -fsS http://127.0.0.1:19090/healthz
curl -fsS http://127.0.0.1:19090/readyz
curl -fsS http://127.0.0.1:19090/metrics

(Invoke-WebRequest -UseBasicParsing http://127.0.0.1:19090/healthz).Content
(Invoke-WebRequest -UseBasicParsing http://127.0.0.1:19090/readyz).Content
(Invoke-WebRequest -UseBasicParsing http://127.0.0.1:19090/metrics).Content

Pay particular attention to these self-monitoring metrics:

/readyz only indicates that the process and WAL can continue accepting data; it does not prove that any device is online. To verify the complete path, inspect the source status, sample count, Dataway delivery count, and runtime log together. For Modbus, S7, SNMP, or OPC UA poll mode, wait for at least one interval. For OPC UA subscription mode, wait for a node update. For MQTT, the publisher must produce a matching message. Then query the measurement configured for the source in Guance. Query data with category = "logging" under Logs.

View runtime logs:

tail -f /var/log/industrykit/industrykit.log

Get-Content "$env:ProgramData\IndustryKit\logs\industrykit.log" -Wait

Upgrade¶

An upgrade requires INDUSTRYKIT_UPGRADE=1. By default, an upgrade preserves the existing Dataway setting. Supplying a new complete URL updates only [dataway].url.

INDUSTRYKIT_UPGRADE=1 \
  sh -c "$(curl -fsSL https://static.truewatch.com/industrykit/install.sh)"

Remove-Item -ErrorAction SilentlyContinue Env:INDUSTRYKIT_*;
$env:INDUSTRYKIT_UPGRADE = "1";
Set-ExecutionPolicy Bypass -Scope Process -Force;
Import-Module BitsTransfer;
Start-BitsTransfer -Source https://static.truewatch.com/industrykit/install.ps1 -Destination .install.ps1;
powershell ./.install.ps1;

$env:INDUSTRYKIT_DATAWAY_URL = "https://openway.truewatch.com?token=<DATAWAY_TOKEN>";

To upgrade to a specific version, use install-<VERSION>.sh or install-<VERSION>.ps1. An upgrade replaces the executable; on Linux it also refreshes the systemd unit, while on Windows it validates and reuses the existing SCM service definition. The current configuration, WAL, logs, Linux enable state, and Windows startup type are preserved. A service that was running before the upgrade is restarted; a service that was stopped remains stopped.

Service and commands¶

service uninstall only unregisters the service; it does not delete the executable, configuration, WAL, or logs. On Linux, rerun the installation command without INDUSTRYKIT_UPGRADE to preserve the existing configuration and register the service again. Start it manually afterward. The Dataway URL is optional when a configuration exists; supplying it updates only [dataway].url. Windows does not yet support reinstalling directly with retained files.

Notes¶

• validate checks only the configuration structure and values. It does not connect to devices, Brokers, or Dataway.
• IndustryKit does not discover point addresses, Node IDs, DB offsets, or OIDs. Obtain them from device manuals, engineering configuration, or on-site scans.