This section lists the events that are logged for each of the SuperSTAR components, as well as what data is logged in each event record.
Common Data
All event records contain the following information:
| Key | Description | Example |
|---|
time | The time the event occurred (UNIX timestamp, in UTC). The accuracy of the timestamp information depends on the machine where the event logger is running. | 1361592000 |
hostname | The name of the host machine that generated the event. | myhostname |
source | The name of the source application that generated the event. | SuperWEB2 |
action | The action being logged. See the tables below for more details about the actions that are logged by each application. | login |
user | The username of the user who generated the event.
For Job Queue Manager events, the audit logs will always record the user that you configured JQM to use (configured in service-config.xml), rather than the user who actually submitted the job. See Configure JQM for more details.
| johndoe |
groups | The groups this user belongs to. | [ group1, group2 ] |
thread | A thread ID. | 42 |
Some event records include additional data, which is listed in the tables below.
SuperWEB2/Job Queue Manager
| Action | Description |
|---|
action | The type of event: login | A user has successfully logged in to SuperWEB2. |
|---|
logout | A user has logged out of SuperWEB2. |
|---|
login.failed | Unsuccessful login attempt. The user value shows the username that was used in the failed login attempt. |
|---|
query | A tabulation query has completed successfully. When this event is logged, full details of the table that was used in the query are recorded in txd in TXD (Textual Table Definition) format. This is a proprietary text based format for describing the structure of a SuperSTAR table; it is one of the SuperCROSS save options and is the internal format used to save tables inside SuperWEB2. TXD files can be loaded into SuperCROSS, added to SuperWEB2 by an administrator, and used with the Production System. |
|---|
query.failed | A tabulation query was not successful. The details of the query will be recorded in txd. |
|---|
jqmQuery | A query has been submitted to Job Queue Manager. The jqmStatus will contain more information about the submitted job. |
|---|
table.displayed | A table has been displayed in SuperWEB2. The txdId can be used to identify the related query record in the logs. |
|---|
chart.displayed | A chart has been displayed in SuperWEB2. The txdId can be used to identify the related query record in the logs. |
|---|
map.displayed | A map has been displayed in SuperWEB2. The txdId can be used to identify the related query record in the logs. |
|---|
unitdata.displayed | Unit record data has been displayed in SuperWEB2 (RecordVIEW). Use selectedColumns to see a list of the columns that were displayed. |
|---|
userDataChange | A user has created, updated or deleted custom data. The dataType, operation and udrId fields contain more information about the change. |
|---|
login and logout events are also recorded for implicit login and logout events, such as a direct URL. When someone accesses one of these links the system automatically logs them in as the guest user (and will also automatically log them out of the guest account if that user does not have access to the linked resource).
|
ipAddress | The IP address used to log in (only recorded for login events). Please see these steps for some additional configuration that is required in order to correctly log the end user's IP address, rather than the gateway IP address. |
jobUuid | A unique ID for this tabulation request. The same ID is recorded in the SuperSERVER log for events relating to this tabulation. |
txd | The TXD used in the query (up to 60,000 characters). |
txdId | A unique ID for this TXD. This can be used to link events relating to a single table. |
part | If the TXD is very large it will be split into multiple parts (up to 60,000 characters per part). When a TXD has been split in the logs, this will indicate which part this record relates to for a given txdId. Each part of the query will have a unique part number. |
dataType | This will be present when the action is userDataChange. One of the following, indicating the type of data change: TABLE | A saved table. |
|---|
UDF | A user defined field. |
|---|
RECODE | A recode. |
|---|
JOB | A JQM job. |
|---|
|
operation | This will be present when the action is userDataChange. One of the following, indicating the type of data change: UPDATE | A record (table, UDF, recode or JQM job, depending on the dataType) has been created or modified. |
|---|
DELETE | A record has been deleted. |
|---|
|
udrId | This will be present when the action is userDataChange or jqmQuery. The ID of the record that has been updated or deleted. For saved tables it will be a UUID, while for JQM jobs it will be a simple integer. |
jqmStatus | This will be present when the action is jqmQuery. The status of the JQM job: SUBMITTED, COMPLETE, COLLECTED or ERROR. |
SuperADMIN
| Action | Description | Additional Data |
|---|
admin.login | An administrator has logged into SuperADMIN. |
|
admin.logout | An administrator has logged out of SuperADMIN. |
|
group.created | A group has been created. | groupid | The group ID. |
|---|
displayname | The display name of the group. |
|---|
|
group.removed | A group has been removed | |
group.displayname.changed | The display name for a group has been changed. | groupid | The group ID. |
|---|
to | The new display name of the group. |
|---|
|
user.created | A user has been created. | userid | The user ID of the new user. |
|---|
displayname | The user's display name. |
|---|
|
user.removed | A user has been removed. | userid | The user ID of the deleted user. |
|---|
|
user.added.to.group | A user has been added to a group. | userid | The user ID. |
|---|
groupid | The ID of the group this user has been added to. |
|---|
|
user.removed.from.group | A user has been remove from a group. | userid | The user ID. |
|---|
groupid | The ID of the group this user has been removed from. |
|---|
|
user.displayname.changed | A user's display name has been changed. | userid | The user ID. |
|---|
to | The new display name for this user. |
|---|
|
user.locked | A user account has been locked. | |
user.unlocked | A user account has been unlocked. | |
database.added | A dataset has been added to the catalogue. | databaseid | The dataset ID. |
|---|
displayname | The database's display name. |
|---|
path | The location of the database's SXV4 file. |
|---|
|
database.removed | A dataset has been removed from the catalogue. | databaseid | The dataset ID. |
|---|
|
database.location.changed | The location of a dataset's SXV4 file has been changed. | databaseid | The dataset ID. |
|---|
path | The new location of the dataset's SXV4 file. |
|---|
|
database.displayname.changed | The display name of a dataset has been changed. | databaseid | The dataset ID. |
|---|
to | The new display name for this database. |
|---|
|
database.access.granted.to.user | A user has been granted access to a dataset. | databaseid | The dataset ID. |
|---|
userid | The user ID. |
|---|
|
database.access.revoked.from.user | A user's access to a dataset has been revoked. | databaseid | The dataset ID. |
|---|
userid | The user ID. |
|---|
|
database.access.granted.to.group | A group has been granted access to a dataset . | databaseid | The dataset ID. |
|---|
groupid | The group ID. |
|---|
|
database.access.revoked.from.group | A group's access to a dataset has been revoked. | databaseid | The dataset ID. |
|---|
groupid | The group ID. |
|---|
|
database.method.changed | A data control method has been added or removed from this dataset. | databaseid | The dataset ID. |
|---|
method | The name of the method that has changed. |
|---|
change | The change (added or removed). |
|---|
|
database.statfunction.changed | A statistical function has been added or removed from this dataset. | databaseid | The dataset ID. |
|---|
statfunction | The statistical function. |
|---|
change | The change (added or removed). |
|---|
|
database.setting.changed | A setting has been changed for this dataset (such as changing the multilingual status. | databaseid | The dataset ID. |
|---|
setting | The setting that has been changed. |
|---|
|
client | The client that generated the event. This can be one of the following: - SA Console
- SuperWEB2
- SuperCROSS
|
|
SuperSERVER
| Action | Description | Additional Data |
|---|
tabulation.query | Details of the query. By default this will include details of the fact tables and fields, but you can use the server command in SuperADMIN to control what details are logged. See Configure for more details. | jobUuid | The job ID for the query. |
|---|
client | The client that processed the query. For example: SuperWEB2, ODAPI, SuperCROSS. |
|---|
values | (If configured in SuperADMIN) the values used in the query. |
|---|
valueSets | (If configured in SuperADMIN) the value sets used in the query. |
|---|
fields | (If configured in SuperADMIN) the fields used in the query. |
|---|
sumFields | (If configured in SuperADMIN) the measures used in the query. |
|---|
factTables | (If configured in SuperADMIN) the fact tables used in the query |
|---|
|
tabulation.request | A cross tabulation job has been submitted to the server. | jobUuid | The job ID for the query. |
|---|
|
tabulation.started | SuperSERVER has started processing a cross tabulation job. | jobUuid | The job ID for the query. |
|---|
duration | The time taken to complete the action (in milliseconds). |
|---|
|
tabulation.complete | A cross tabulation job has completed successfully. The event record includes the job ID and the time taken to complete the tabulation (in seconds). | jobUuid | The job ID for the query. |
|---|
duration | The time taken to complete the action (in milliseconds). |
|---|
|
tabulation.retrieved | The cross tabulation results have been retrieved by the client. | jobUuid | The job ID for the query. |
|---|
duration | The time taken to complete the action (in milliseconds). |
|---|
|
jobUuid | A unique ID for this tabulation request. The same ID is recorded in the SuperWEB2 log for events relating to this tabulation. |
|
