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.

Activity logging is not automatically enabled. You need to manually enable the logging of activities once Zoomdata is deployed in your environment.

Starting with Zoomdata v2.6, Zoomdata logs activities across two separate log files:

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

CONFIGURE THE Query Engine Activity Log

The Query Engine Activity Log defaults can be configured through properties set in zoomdata.properties file. Changes made to these options do not take effect until the next restart of the Zoomdata Query Engine process. See Managing Configurations in Zoomdata 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 /opt/zoomdata/logs/
qe.activity.logging.file Enable / disable activity logging to file true

CONFIGURE THE Zoomdata Activity Log

The Zoomdata Activity Log defaults can be configured through properties set in zoomdata.properties file. See Managing Configurations in Zoomdata 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 /opt/zoomdata/logs/
zoomdata.activity.logging.file Enable / disable activity logging to file true

Enabling or Disabling Logging

Enabling or disabling the logging of specific activities is performed via a series of REST API calls.

Enable or Disable Logging to the Log File

Run the following cURL command:

curl -u supervisor: password -XPUT 'http:// localhost:8080 /zoomdata/service/system/activity/FILE ' -H "Content-Type: application/json" --data ' true '
  • localhost:8080 - specify the address of the instance on which Zoomdata is installed
  • false - to disable the logging of all activities to the Log file
  • true - to enable the Log file* (please note that you still need to enable each individual activity that you want logged into this file)
  • The flag enables logging to log file itself. By default, no specific activities are logged. You need to enable each individual activity that you want logged.
  • For a list of the activities that can be logged, refer to this Reference Sheet .

Enable or Disable Logging of Specific Activities

You can enable the logging of specific activities by running the following cURL:

curl -u supervisor: password -XPUT 'http :// localhost:8080 /zoomdata/service/system/activity/type/ activityType /FILE ' -H "Content-Type: application/json" --data 'true'
  • localhost:8080 - specify the address of the instance on which Zoomdata is installed
  • activityType - specify the type of selected activity* (for example, AUTHENTICATION and USER )
  • enabled - value options: true orfalse - set the corresponding value to enable or disable selected activity output
For a list of the activities that can be logged, refer to this Quick Reference Sheet .

Checking if an Activity is being logged

To check whether a specific activity type is being logged in the Log File, run the following cURL:

curl -u supervisor: password -XGET 'http:// localhost:8080 /zoomdata/service/system/activity/type/ activityType '
  • localhost:8080 - specify the address of the instance on which Zoomdata is installed
  • activityType - specify the type of selected activity* (for example, AUTHENTICATION and USER )

Related Articles:

Was this topic helpful?