Zoomdata Version

Activities Log Reference Sheet

This reference sheet lists the types of activities and corresponding fields that are logged in Zoomdata logs. By default, activity logging is enabled for both the Zoomdata and query engine services, with a few exceptions (described later in this topic).

Activity Logging Defaults

By default, activity logging is enabled for both activity log files, except for the some activities. The following table lists the activities that are logged by default and those that are not for each activity log file. Activities that are not logged by default must have logging manually enabled. See Activity Logging.

Activity Log File Activities Logged by Default Activity Not Logged by Default
query-engine-activity.log

rdd_cache
vis_command

vis_data

zoomdata-activity.log

account
authentication
bookmark
group
security_key
SOURCE
USER
VIS
VIS_DEF

oauth_client
oauth_token
raw_data_export
raw_data_export_csv
upload

If logging or specific activity logging is disabled in a previous Zoomdata version, the disabled status is retained after an upgrade.

Common Log Fields

For each activity, the following common fields are logged as part of each activity record:

Field Name Description
user contains information about the account user and the actions performed
userType contains information about the way the user has accessed Zoomdata, either via: (1) security key (for shared charts, value=KEY) or (2) user credentials (value=USER
accountID contains the user's current account ID
userGroups list of the groups which the user belongs to
userRoles list of security roles the user is assigned
IP contains IP address from which the event has been performed

Additional fields are logged as part of each activity.

Activity Log Fields

The following activity types can be logged by Zoomdata. For each activity, specific fields are logged, in addition to the common fields.

account: Account Maintenance

This activity is logged when a Zoomdata account is created, updated, or deleted. Logging for this activity is enabled by default and captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Name Description
activityType account
status CREATED / UPDATED / DELETED
accountId Generated account ID
name Name of the account from which the event has been triggered.

createdBy

User who created this account.
createdDate Account creating date
lastModifiedBy User who modified the account
disabled TRUE / FALSE

authentication: User Authentication

This activity is logged while user authentication at login. Logging for this activity is enabled by default and captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType authentication
status SUCCEEDED / FAILED
authenticationType BASE, SAML, LDAP, OAUTH, x509

bookmark: Dashboard Maintenance

This activity is logged when a dashboard is created, updated, or updated. Logging for this activity is enabled by default and captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType bookmark
status CREATED / UPDATED / DELETED
bookmarkId Dashboard ID
bookmarkName Dashboard name
description Dashboard description added by the user
shared shows that the dashboard may be shared with other users. In this case security key is created.
keyIds added if the security key is used

group: Group Maintenance

This activity is logged when a user group is created, updated, or updated. Logging for this activity is enabled by default and captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType group
status CREATED / UPDATED / DELETED
groupId Group ID
label Name of the group
description Group description added by the user
groupRoles Roles that have been assigned for the group

oauth_client: OAuth Client Registry Maintenance

Logs the actions taken from the OAuth client application registry - whether records are created, updated or deleted. Logging for this activity is disabled by default. After you have manually enabled logging for this activity, its log records are captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType oauth_client
status CREATED / UPDATED / DELETED
clientId
clientName
autoApprove

oauth_token: OAuth Access Token Processing

Tracks when OAuth access tokens are granted (or created) or deleted. Logging for this activity is disabled by default. After you have manually enabled logging for this activity, its log records are captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType oauth_token
status CREATED / DELETED
tokenId
clientId
tokenUsername
tokenAccountID

raw_data_export: Data Export

This activity is logged when a user exports the raw data to a CSV file or views the details of the selected segment on a chart. Logging for this activity is disabled by default. After you have manually enabled logging for this activity, its log records are captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType raw_data_export
status SUCCEEDED
exportType REST (view details) FILE (export file)
count Number of exported rows
storageType Data source
query Queries sent to the data source
cid Created ID
actionStartedOn Export start time
duration Request processing time

raw_data_export_csv: Data Export to CSV

This activity is logged when a user exports the raw data to a CSV file. Logging for this activity is disabled by default. After you have manually enabled logging for this activity, its log records are captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType raw_data_export_csv
status SUCCEEDED
count Number of exported rows
location DB or FILE
file

location=FILE - the full path to the file in local file system

cid Created ID
actionStartedOn Export start time
duration Request processing time

rdd_cache: Topology RDD Cache Access

This activity is logged when access to the topology RDD cache occurs. Logging for this activity is enabled by default and captured in the query-engine-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType rdd_cache
status MISS / HIT
sourceId ID of the requested data source
query Queries sent to the data source

security_key: Security Key Usage

This activity is logged while working with security key. A security key is created when a user chooses to share a dashboard and the interactive or non interactive link is created. Logging for this activity is enabled by default and captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType security_key
status CREATED / UPDATED / DELETED
keyId ID of the generated key
created Security key creation date
expire Security key expiration date
description Description added by the user
keyType SOURCE / DASHBOARD
objectIds IDs of sources and dashboards which are allowed with this key

source: Data Source Maintenance

This activity is logged when a source is created, updated, or deleted. Logging for this activity is enabled by default and captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType source
status SAVED, UPDATED, DELETED
sourceId Generated source ID
sourceName Name of the source
streamType Demo_record, CSV, API
storageType Data source type
sourceAsString Contains service info about the data source
sourceDescription Source description added by the user

upload: Flat File Upload

This activity is logged when a user uploads the flat file while creating a new data source. Logging for this activity is disabled by default. After you have manually enabled logging for this activity, its log records are captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType upload
status SUCCEEDED
source Data source ID to which the file will be uploaded
fileName Name of the uploaded file
contentType Type of the uploaded file
filesize Size of the uploaded file

user: User Account Maintenance

This activity is logged when user account is created, updated, assigned to a group, assigned a new role, or deleted. Logging for this activity is enabled by default and captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType user
status CREATED / UPDATED / DELETED
userID
userName
userFullname
email
subjectUserGroups Groups which a user belongs to
subjectUserRoles Identifies the user's access privilege
userOrigin NATIVE / SAML / LDAP
accounts Accounts, which a user is assigned to

vis: Chart Maintenance

This activity is logged when a chart is created or updated. Logging for this activity is enabled by default and captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType vis
status CREATED / UPDATED
visualizationID
visualizationName

vis_command: Data Source Requests

This activity is logged when a user is working with a chart and corresponding requests are sent to a data source. Logging for this activity is enabled by default and captured in the query-engine-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType vis_command
status STARTED / FAILED / FINISHED
cid Created ID
actionStartedOn Chart building start time
duration Request processing time
Map<String, Object> request Data request to build the chart

vis_data: Data Retrieval

This activity is logged when a user is working with a chart and the requested data is retrieved from a data source. Logging for this activity is disabled by default. After you have manually enabled logging for this activity, its log records are captured in the query-engine-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType vis_data
status SUCCEEDED
payload Actual data sent to chart
cid Created ID
actionStartedOn Chart building start time
duration Request processing time

vis_def: Chart Label Maintenance

This activity is logged when a user is creating or updating the chart label. Logging for this activity is enabled by default and captured in the zoomdata-activity.log file.

The following fields are recorded for this activity:

Field Value
activityType vis_def
status CREATED / UPDATED
cid Created ID
visualizationId Unique identifier for the chart
visualizationName Name assigned to the chart

Was this topic helpful?