Zoomdata Version

Activities Log Quick Reference Sheet

This reference sheet lists the types of activities and corresponding fields that are recorded when an activity occurs. For each activity, the following common fields are logged as part of the activity record:

Field Names Applicable to All Activities
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

The following activity types can be logged in Zoomdata:

Activities Enabled By Default Activities Needing To Be Manually Enabled
  • Account
  • Authentication
  • RDD
  • RDD_Cache
  • Request
  • Source
  • User
  • Group
  • Bookmark
  • Security_Key
  • Vis_Command
  • Security_Filter
  • Vis
  • Vis_Def
  • OAuth_Client
  • OAuth_Token
  • Raw_Data_Export
  • Raw_Data_Export_CSV
  • Topology
  • Upload
  • Vis_Data
If logging was disabled in a previous version of Zoomdata (or the logging for a particular activity type), that disabled status is retained after an upgrade is done.

For each activity there are specific fields to be logged (marked by red background in the tables) and the set of common fields.

ACTIVITY: Account

This activity is logged when a Zoomdata account is created, updated, or deleted. The following fields are recorded on 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

ACTIVITY: Authentication

This activity is logged while user authentication at login. The following fields are recorded on this activity:

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

Activity: Source

This activity is logged when a source is created, updated, or deleted. The following fields are recorded on 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
sparkIt TRUE / FALSE

Activity: Requesting Data from a Data Source while Working with a Chart

This activity is logged when a user is working with a chart and corresponding requests are sent to a data source. The following fields are recorded on 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

Activity: Creating Or Updating Visualization Definition

This activity is logged when a user is creating or updating the chart label. The following fields are recorded on 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

ACTIVITY: Retrieving Data from the Data Source while Working with a Chart

This activity is logged when a user is working with a chart and the requested data are retrieved from a data source. The following fields are recorded on 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

ACTIVITY: Loading Data from a Data Source to SparkIt

This activity is logged when loading data from a data source is initiated. The following fields are recorded on this activity:

Field Value
activityType RDD
status STARTED / FAILED / FINISHED
storageType Data source type
queries Queries sent to the data source
proxiedUser (for Oracle sources) if the Run as proxy user option is enabled for the Oracle data source, this field will contain name of Oracle user.
cid Created ID
actionStartedOn Chart building start time
duration Request processing time

ACTIVITY: Requesting Details or Exporting Data

This activity is logged when a user exports the raw data to a .csv file or viewing the details of the selected segment on a chart. The following fields are recorded on 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

ACTIVITY: Exporting Raw Data to CSV File

This activity is logged when a user exports the raw data to a .csv file. The following fields are recorded on this activity:

Field Value
activityType RAW_DATA_EXPORT_CSV
status SUCCEEDED
count Number of exported rows
location DB(and/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

ACTIVITY: Uploading a Flat File

This activity is logged when a user uploads the flat file while creating a new data source. The following fields are recorded on 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

ACTIVITY: User

This activity is logged when user account is created, updated, assigned to a group, assigned a new role, or deleted. The following fields are recorded on 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

ACTIVITY: Chart

This activity is logged when a chart is created or updated. The following fields are recorded on this activity:

Field Value
activityType VIS
status CREATED / UPDATED
visualizationID
visualizationName

ACTIVITY: Rdd Cache - access to topology RDD cache

The following fields are recorded on this activity:

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

ACTIVITY: User Group

This activity is logged when a user group is created, updated, or updated. The following fields are recorded on 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

ACTIVITY: Dashboard

This activity is logged when a dashboard is created, updated, or updated. The following fields are recorded on 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

ACTIVITY: Security Key

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. The following fields are recorded on 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

ACTIVITY: OAuth Client

Logs the actions taken from the OAuth client application registry - whether records are created, updated or deleted. The following fields are recorded on this activity:

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

ACTIVITY: OAuth Token

Tracks when OAuth access tokens are granted (or created) or deleted. The following fields are recorded on this activity:

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

ACTIVITY: Request

Request activities are logged on all web requests to Zoomdata services or API endpoints excluding the requests to static resources. The following fields are recorded on this activities:

Field Value
activityType REQUEST
status SUCCEEDED
uri
host Name of host on which Zoomdata is installed
requestTime Request processing time
requestSize Size of the request
responseCode HTTP response status code