Monitoring

Audit logs track activity. Metrics track usage on the Instabase platform.

Audit logs

Audit logs track activity in the Instabase platform.

To access audit logs programmatically, use the Audit log APIs.

The audit logs you can view depend on your role:

  • Admins can view all activity in the Instabase platform.

  • Users can see only their specific activity across the platform.

View audit logs

  1. On the left navigation dock, select All apps, and then select Audit Logs.

  2. Use the Filter by fields to select the audit logs you want to view. When you define new filters, the results are automatically updated in a spreadsheet-style table.

  3. Click the top of each output column to change the sort order from Sort Asc (default) to Sort Desc.

  4. Click Load More to load the next set of results.

To access advanced processing features, click the download icon in the top right corner of the output table to download the audit log results data as a CSV or JSON file you can use for downstream processing.

Filters

To view and filter the audit log results, select one or more of these inputs:

  • User - View activity by a specific username or email.

  • Log - Select a log type to view the activity.

    • All - Activity across all log types.

    • Account - Generated on new account creation or account metadata modification.

    • Access Control - Generated on access control modifications to repository file and folder paths. Information about access control modification, such as the repository name and owner, the specific resource being modified, the ACL type (read or write), and the user principal that is associated with the change.

    • API - Generated when a public REST API call is made. Information about the API call including the host URL and path suffix, the query string, the request method, and authentication method.

    • App Access - Generated when users attempt to access an app.

    • Diff - Generated when the Diff operation is run from review OCR or Diff app front end.

    • Flow - Generated when a Flow is run. The logs contain:

      • The type of Flow

      • A Flow start log that contains start information about the Flow, the Flow path, input directory, job id, and so on.

      • A Flow finish log that contains the result information of the Flow including the Flow output directories and more.

    • Flow Correction - Generated when a Flow result phrase is corrected. The Flow path being run, the .ibocr path being modified, the phrases being corrected, and the job id.

    • Login - Generated at user login.

    • NLP - Generated when an NLP Pipeline is run.

    • NLP Step - Generated when an NLP Pipeline step is run.

    • Organization - Generated on creation, deletion, or membership modifications of organizations.

    • Redactor - Generated when the Redactor app is run.

    • Repo - Generated on operations that affect a repository. Types of repository operations include creation or deletion, rename, ownership transfer, visibility updates, and changes to collaborators.

    • Team - Generated on creation, deletion, or membership modifications of teams.

  • Period - Choose from a common range of time periods or define a specific point in time to view log data.

  • Number of results - Change the number of results that is returned in the results pane. The default number of results is 50, but you can increase this value to view a larger number of results.

Metrics

The Metrics app is where you can view activity usage for various Instabase apps, including Flow, Reader, and Refiner.

Note

Metrics visibility is role-restricted. Admins can view metrics data about Instabase usage across the platform whereas non-admin users can only view their own usage.

View metrics

  1. Open the Metrics app by selecting All apps > Metrics.

  2. In the Query by pane, select an app from the Apps dropdown.

  3. Select a metric from the Metrics dropdown. Available metrics vary by app.

    Note

    To learn more about the selected metric, hover over the Metrics dropdown’s tooltip to see a description.

  4. Use the Group by options to group by attribute or by time interval. Group by attributes vary by app and metric.

    Note

    By default, each metric is grouped on total usage by day.

  5. Use the Period widget to select a time period to view metrics for.

    You can select a specific time period using the calendar widgets or click the time period shortcut options such as Past 3 months or Past year.

  6. In the Filter by pane, set results filters. Filter attributes vary by app and metric.

Results

Metrics are output as a time-based series bar chart in the Results pane. The total output of a series is displayed at the bottom of the chart. You can also hover over a specific bar to view the exact metric count for that time interval.

You can download the results of your metrics query as a CSV or JSON file for downstream processing.

  1. Define your metrics query.

  2. In the Results pane, click the download (cloud and arrow) icon.

  3. Select CSV or JSON. The metrics query results download.