TSTool / Install Zabbix Plugin
This appendix describes how to install and configure the TSTool Zabbix Plugin.
Install TSTool
TSTool must be installed before installing the Zabbix plugin. Typically the latest stable release should be used, although a development version can be installed to use new features. Multiple versions of TSTool can be installed at the same time.
- Download TSTool:
- Download the Windows version from the State of Colorado's TSTool Software Downloads page.
- Download the Linux version from the Open Water Foundation TSTool download page.
- Run the installer and accept defaults.
- Run TSTool once by using the Start / CDSS / TSTool-Version menu on Windows
(or run the
tstool
program on Linux). This will automatically create folders needed to install the plugin.
Install and Configure the TSTool Zabbix Web Services Plugin
This documentation describes how to install and configure the TSTool Zabbix plugin.
The folder structure on the computer should be similar to the following.
The plugins-old
folder is an archive of old plugin versions in case versions need to be switched.
Windows:
C:\Users\user\.tstool\14\
plugins\
owf-tstool-zabbix-plugin\
owf-tstool-zabbix-plugin-1.1.2.jar
plugins-old\
owf-tstool-zabbix-plugin\
owf-tstool-zabbix-plugin-1.1.1.jar
Linux:
/home/user/.tstool/14/
plugins/
owf-tstool-zabbix-plugin-1.1.2.jar
plugins-old/
owf-tstool-zabbix-plugin-1.1.1.jar
On Windows, the installation folder in Windows Explorer will be similar to the following:
Zabbix Plugins Folders on Windows (see full-size image)
To install or update the plugin:
- Download the
tstool-zabbix-plugin
software installer file from the TSTool Zabbix Download page. For example with a name similar totstool-zabbix-plugin-1.0.0-win-202305232446.zip
. - If installing the plugin in user files and if TSTool was not run before, run TSTool once to automatically create user folders and files needed by the plugin.
- If an old version of the plugin was previous installed,
delete the old
jar
file or move to theplugins-old/
folder to archive. Only one copy of the pluginjar
file can be found in theplugins
folder to avoid software conflicts. If the Zabbix plugin features are not functioning properly, it may be due to conflicting jar files. Theplugins-old
folder is not necessary and is just a local copy of old versions to facilitate troubleshooting. - Expand the zip file or navigate to the zip file in Windows Explorer.
Copy the top-level folder in the zip file to the TSTool
plugins
folder as shown in the above folder structure. - Configure one or more datastore configuration files according to the Zabbix Data Web Services Datastore documentation.
- Test web services access using TSTool by selecting the datastore name that was configured and selecting time series.
- If there are issues, use the View / Datastores menu item to list enabled datastores.
- If necessary, see the Troubleshooting documentation.
TSTool will be enhanced in the future to provide a "plugin manager" to help with these tasks.