Difference between revisions of "Zimbra Usage Reporting Tool"

m (Installation on non-Zimbra Server)
(Download and Install)
 
(12 intermediate revisions by 2 users not shown)
Line 14: Line 14:
 
*Root user access
 
*Root user access
  
==Installation==
+
==Download and Install==
 +
Download the [https://files.zimbra.com/downloads/usage/zurt/beta/zimbra-URT-1.0.1-BETA-20200707041720.tgz Zimbra Usage Reporting Tool]
 +
 
 
===Installation on Zimbra Server===
 
===Installation on Zimbra Server===
#Download the [https://files.zimbra.com/downloads/usage/zurt/beta/zimbra-URT-1.0.0-BETA-20200527182309.tgz Zimbra Usage Reporting Tool]
+
#Download the [https://files.zimbra.com/downloads/usage/zurt/beta/zimbra-URT-1.0.1-BETA-20200707041720.tgz Zimbra Usage Reporting Tool]
 
#Extract it on the target server <pre>tar -xvzf zimbra-URT-1.0.0-BETA-xx.tgz</pre>
 
#Extract it on the target server <pre>tar -xvzf zimbra-URT-1.0.0-BETA-xx.tgz</pre>
 
#Navigate to the extracted directory <pre>cd zimbra-URT-1.0.0-BETA-xx</pre>
 
#Navigate to the extracted directory <pre>cd zimbra-URT-1.0.0-BETA-xx</pre>
Line 24: Line 26:
 
===Installation on non-Zimbra Server===
 
===Installation on non-Zimbra Server===
  
# Download the [https://files.zimbra.com/downloads/usage/zurt/beta/zimbra-URT-1.0.0-BETA-20200527182309.tgz Zimbra Usage Reporting Tool]
+
# Download the [https://files.zimbra.com/downloads/usage/zurt/beta/zimbra-URT-1.0.0-BETA-20200623044507.tgz Zimbra Usage Reporting Tool]
 
# Extract it on the target server <br /> <pre>tar -xvzf zimbra-URT-1.0.0-BETA-xx.tgz</pre>
 
# Extract it on the target server <br /> <pre>tar -xvzf zimbra-URT-1.0.0-BETA-xx.tgz</pre>
 
# Edit <code>conf/zurt_ldap_config.xml</code> located in the extracted ZURT tar and update the value for each key as defined below. <br />You can get the below details by running <pre>zmlocalconfig -s | grep -i ldap</pre> as <code>zimbra</code> user
 
# Edit <code>conf/zurt_ldap_config.xml</code> located in the extracted ZURT tar and update the value for each key as defined below. <br />You can get the below details by running <pre>zmlocalconfig -s | grep -i ldap</pre> as <code>zimbra</code> user
*<code>ldap_host</code> - set the value of <code>ldap_host</code>
+
##<code>ldap_host</code> - set the value of <code>ldap_host</code>
*<code>zimbra_ldap_password</code> - set the value of <code>zimbra_ldap_password</code>
+
##<code>zimbra_ldap_password</code> - set the value of <code>zimbra_ldap_password</code>
*<code>ldap_port</code> - by default its 389, if different set value of <code>ldap_port</code>
+
##<code>ldap_port</code> - by default its 389, if different set value of <code>ldap_port</code>
*<code>zimbra_ldap_userdn</code> - set value of <code>zimbra_ldap_userdn</code>
+
##<code>zimbra_ldap_userdn</code> - set value of <code>zimbra_ldap_userdn</code>
  
 
Once these details are specified, run the installation script (<code>install.sh</code>).
 
Once these details are specified, run the installation script (<code>install.sh</code>).
Line 39: Line 41:
  
 
==Getting detailed usage data==
 
==Getting detailed usage data==
;Account Level Data CSVs:
 
 
*To get account level data CSV dumps locally i.e. list of accounts CSV with features enabled for individual accounts, edit <code>conf/zurt.properties</code> file created on installation path (default<code>/opt/zimbra-urt</code>).  
 
*To get account level data CSV dumps locally i.e. list of accounts CSV with features enabled for individual accounts, edit <code>conf/zurt.properties</code> file created on installation path (default<code>/opt/zimbra-urt</code>).  
 
*Change the value of <code>account.level.data</code> to <code>true</code> and restart ZURT service.
 
*Change the value of <code>account.level.data</code> to <code>true</code> and restart ZURT service.
 +
<br />
 
<blockquote>
 
<blockquote>
 
Consider ZURT installation location is <code>/opt/zimbra-urt</code>
 
Consider ZURT installation location is <code>/opt/zimbra-urt</code>
Line 59: Line 61:
 
*ZURT Status  - <code>service zurt status</code>
 
*ZURT Status  - <code>service zurt status</code>
  
===ZURT Installation Folder Contents===
+
 
 +
;ZURT Installation Folder Contents:
 
Files & folder at installation path (default<code>/opt/zimbra-urt</code>) contains
 
Files & folder at installation path (default<code>/opt/zimbra-urt</code>) contains
 
*<code>bin</code>  - folder contains zurt.sh script to run the usage data collection process
 
*<code>bin</code>  - folder contains zurt.sh script to run the usage data collection process
Line 70: Line 73:
 
*<code>log</code> - logs related the service can be accessed from this folder
 
*<code>log</code> - logs related the service can be accessed from this folder
  
==Uninstall ZURT==
+
 
 +
 
 +
;Uninstall ZURT:
 
To uninstall the ZURT service
 
To uninstall the ZURT service
 
*stop the service
 
*stop the service

Latest revision as of 10:52, 7 July 2020

Zimbra Usage Reporting Tool

Zimbra Usage Reporting Tool (ZURT) is a service that collects usage against the provisioned license. You can install it on a Zimbra server or a server with access to Zimbra LDAP. Zimbra LDAP connection details help this service to capture the number of accounts based on the features individual accounts have been given. The tool gets installed as a service (ZURT) on the server which can be accessed with systemctl service commands.

Pre-requisites

  • Zimbra Collaboration 8.7.1 or above
  • Latest version of zimbra-openjdk

- or -

  • Linux Java version 1.8 or greater
  • Server should communicate with usage.zimbra.com
  • Systemctl (the Systemd utility)
  • Root user access

Download and Install

Download the Zimbra Usage Reporting Tool

Installation on Zimbra Server

  1. Download the Zimbra Usage Reporting Tool
  2. Extract it on the target server
    tar -xvzf zimbra-URT-1.0.0-BETA-xx.tgz
  3. Navigate to the extracted directory
    cd zimbra-URT-1.0.0-BETA-xx
  4. Run as root
    ./install.sh
  5. The installation process prompts you to provide installation path to install the ZURT service. The default location is
    /opt/zimbra-urt
    To keep the default location press Enter.

Installation on non-Zimbra Server

  1. Download the Zimbra Usage Reporting Tool
  2. Extract it on the target server
    tar -xvzf zimbra-URT-1.0.0-BETA-xx.tgz
  3. Edit conf/zurt_ldap_config.xml located in the extracted ZURT tar and update the value for each key as defined below.
    You can get the below details by running
    zmlocalconfig -s | grep -i ldap
    as zimbra user
    1. ldap_host - set the value of ldap_host
    2. zimbra_ldap_password - set the value of zimbra_ldap_password
    3. ldap_port - by default its 389, if different set value of ldap_port
    4. zimbra_ldap_userdn - set value of zimbra_ldap_userdn

Once these details are specified, run the installation script (install.sh).

View Usage Report

Once installed, log in to Usage Portal. Please contact Zimbra sales for your login credentials.

Getting detailed usage data

  • To get account level data CSV dumps locally i.e. list of accounts CSV with features enabled for individual accounts, edit conf/zurt.properties file created on installation path (default/opt/zimbra-urt).
  • Change the value of account.level.data to true and restart ZURT service.


Consider ZURT installation location is /opt/zimbra-urt

vi /opt/zimbra-urt/conf/zurt.properties

set account.level.data to true

service zurt restart
  • Once service is restarted it will start dumping CSV files with account-level data for features enabled on individual accounts within the data folder of installation path.
  • To turn CSV dumps off, edit the properties file (conf/zurt.properties) and set the value back to false and restart the service.

ZURT Service Management

ZURT service commands
  • ZURT Start - service zurt start
  • ZURT Stop - service zurt stop
  • ZURT Restart - service zurt restart
  • ZURT Status - service zurt status


ZURT Installation Folder Contents

Files & folder at installation path (default/opt/zimbra-urt) contains

  • bin - folder contains zurt.sh script to run the usage data collection process
  • lib - contains jars for usage data collection
  • conf - contains
    • zurt.properties - property file to turn on/off for dumping account data and turn on/off collection of domain level data
    • log4j2.xml - For logging purpose
    • zurt_ldap_config.xml - For ldap details configuration in case of non zimbra server.
  • data - folder contains account level data CSV dumps
  • log - logs related the service can be accessed from this folder


Uninstall ZURT

To uninstall the ZURT service

  • stop the service
  • remove service files
  • delete the folder created as installation path
  • delete the folder extracted from ZURT tar
systemctl stop zurt
rm -rf /opt/zimbra-urt
rm /etc/systemd/system/zurt.service
rm -rf zimbra-URT-1.0.0-BETA-xx
Jump to: navigation, search