Zoomdata Version

Activity Logging

The Zoomdata server records user and server-based activities in log files. These files can be used by Zoomdata administrators to troubleshoot issues that may occur with the Zoomdata server (for example, activities related to setting up data sources or creating charts and dashboards).

Zoomdata logs activities in two separate log files:

  • query-engine-activity.log: captures RDD and query engine-related activity types.
  • zoomdata-activity.log: captures all other activity types.

By default logging to these files are enabled, however some activity types are not automatically logged. To determine which activities are logged by default, see the Activities Log Reference Sheet.

This page covers the following topics:

If you want to use unified logging, see Setting Up Unified Logging. Unified logging is not enabled by default.

Configuring the Query Engine Activity Log

The query engine activity log defaults can be configured through properties set in the zoomdata.properties file. Changes made to these options do not take effect until the next restart of the Zoomdata query engine process. See Configuring Your Zoomdata Installation for more information about modifying property files.

Property Description Default
qe.activity.log.file.max.index Number of log files to keep 1
qe.activity.log.file.size Maximum log file size in Mb 10
qe.activity.logs.dir

File path to store log files. Verify that this log directory has all the necessary permissions and that the owner of the directory is set to zoomdata.

The /home directory cannot be used for logging.

/opt/zoomdata/logs/
qe.activity.logging.file Enable / disable activity logging to file true

Configuring the Zoomdata Activity Log

The Zoomdata activity log defaults can be configured through properties set in the zoomdata.properties file. See Configuring Your Zoomdata Installation for more information about modifying property files.

Property Description Default
zoomdata.activity.log.file.max.index Number of log files to keep 1
zoomdata.activity.log.file.size Maximum log file size in Mb 10
zoomdata.activity.logs.dir

File path to store log files. Verify that this log directory has all the necessary permissions and that the owner of the directory is set to zoomdata.

The /home directory cannot be used for logging.

/opt/zoomdata/logs/
zoomdata.activity.logging.file Enable / disable activity logging to file true

Enabling or Disabling the Logging of Specific Activities

Enabling or disabling the logging of specific activities is performed via a series of REST API calls or by directly updating the appropriate activity property in the query-engine.properties or zoomdata.properties file. For a list of the activities that can be logged and the file in which they can be logged, see the Activities Log Reference Sheet.

To enable or disable logging for a specific activity using the REST API, run the following cURL command:

curl -u supervisor: <password> -XPUT 'http://<host>:<port>/zoomdata/service/system
/activity/type/<activityType> ' -H "Content-Type: application/json" --data '<option>'
  • <host>:<port> - Specify the host IP address and port of the Zoomdata instance.

  • <activityType> - Specify the name of selected activity (for example, AUTHENTICATION or USER).

  • <option> - Specify either true or false. Set the value to true to enable the selected activity output or false to disable it.

To enable or disable logging for a specific activity by changing the appropriate activity property in the properties file:

  1. Locate the correct property file for the activity. The properties file for activities that are logged to the query-engine-activity.log file is query-engine.properties.The properties file for activities that are logged to the zoomdata-activity.log file is zoomdata.properties. To determine which activity property is stored in which properties file, see Activities Log Reference Sheet. For information about accessing Zoomdata configuration (properties) files, see Configuring Your Zoomdata Installation.

  2. Add or edit the appropriate activity property in the file using the following format:

    activity.<activity-name>=<option>

    Activity names (<activity-name>) are listed in the Activities Log Reference Sheet.

    For <option>, specify either true or false. Set the value to true to enable the selected activity output or false to disable it.

  3. Save the properties file.

  4. Restart Zoomdata services. See Restarting Zoomdata Services.

Determining Whether an Activity Is Being Logged

To determine whether a specific activity type is being logged in the log file, run the following cURL command:

curl -u supervisor: <password> -XGET 'http://<host>:<port>/zoomdata/service/system
/activity/type/<activityType>'
  • <host>:<port> - Specify the address of the instance on which Zoomdata is installed.
  • <activityType> - Specify the type of selected activity (for example, AUTHENTICATION or USER). For a list of the activities that can be logged, see the Activities Log Reference Sheet.

Was this topic helpful?