Document toolboxDocument toolbox

Audit logging

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)


Note

Kyvos comes with certain built-in semantic models to help you monitor the Kyvos system. To view the history audit semantic model details, see the  Built-in Kyvos semantic models for monitoring  section. 

Audit logging is an option that is configurable for your installation. If this feature is enabled and your account has the appropriate privileges, you can view audit logs from the Activity Monitor. This feature enables you to track both system and user actions and provides access to historical data. 

On the Monitor page, click the Audit Logs tab to view the following details:

  • User—Name of logged-in system or group users

  • Action—Displays information about the actions performed by the user, such as submitting process jobs, signing in, completing threads, updating advanced properties, and more. You can also view log details for a specific action by applying the Action filter from the Filter pane.

  • Source Name—Displays information about the object on which actions were performed, such as DCM, Range Balancer, Validate semantic model test, and so on. You can also view log details for a specific source by applying the Source Name filter from the Filter pane.

  • Source Type—Displays information about the type of action performed on the object, such as adding, modifying, or deleting a dataset, relationship, semantic model, or workbook. You can also view log details for a specific source type by applying the Source Type filter from the Filter pane.

  • Action Time—Displays information about when the action was performed, including the date and time. You can view log details for a specific action time and date by using the Action Time filter from the Filter pane.

  • Status—The status of each action is displayed to indicate whether it was successful or failed. You can view specific log details of the action's status by applying the Status filter in the Filter pane. This allows you to filter results based on the status of the action, such as Success, Failed, or Partial Success.

To further refine the log details, you can use additional filters from the Filter pane. See the Filtering logs section for more details. 

The log also includes specific administrative actions, such as configuration changes and server restarts, and provides details of what was configured when changes occurred.

On the Audit Logs page, you can:

  • View audit details for a specific user

  • View and analyze historical archived audit data in a new window

  • Narrow down log details by applying filters. For example, apply the 'Action' filter from the Filter pane to view log details for a specific action.

  • Generate Thread Dump logs: Click the Actions menu (...) in the upper right of the window, and then select the Generate Thread Dump Logs option. 

  • Set the Audit Logs page as the landing page: Click the Actions menu (...) in the right of the window, and then select the Set as Landing page option. The Audit Logs page is set as a landing page. You can verify using the Home icon, or the Home option from the toolbox.

To view audit details, perform the following steps. 

  1. From the Toolbox, click Monitor, then click the Audit Logs tab.

  2. Right-click any item in the log and choose Show details. You will view a summary and depending on the entry you are viewing, you can click Show details again to view additional details.

  3. Optionally, you can copy the results to the clipboard by clicking the icon.

  4. Click OK. 

Note

The audit logs are also maintained in an additional file on the BI server machine. Each BI Server has its own separate file containing the audit information.

To analyze archived audit data, perform the following steps. 

  1. Click Show Filter if needed to view the filter options.

  2. Click the option shown at the bottom of the filter settings to analyze archived audit data.

The audit logging data opens as a workbook in a new tab that includes worksheets about actions and queries. You can view and filter the data using features in the workbook. See the Filtering data in worksheets section for more details. 

Filtering logs 

You can apply filters from the Filter pane to narrow down your results. You can filter which logs to view or download. For example, you can filter by date range, user, activity, item type, or name, such as a semantic model, worksheet, user, group, etc. You can specify whether to include or exclude certain items from the results. Additionally, you can specify which actions to filter based on the type of data being logged. For example, you can filter by servers being up or down, queries being run, changes to properties or data security, and so on. Multiple filters can be set at once.

The procedure to apply a filter from the Filter pane is the same for all filters. The following procedure demonstrates how to apply the Action filter from the Filters pane. 

To select Actions to filter, perform the following steps: 

  1. In the Filter pane, click Action and select the required value that you want to apply. 
    For example, you can choose Update User from the value list. The filter is immediately applied to the list. The record count is automatically updated once the filter is applied.

Similarly, you can apply the other filters from the Filter pane. For details, see Filtering in the Monitor.


Related topics

Copyright Kyvos, Inc. All rights reserved.