TetraScience

Tetra Data Platform Documentation

Welcome to TetraScience Tetra Data Platform (TDP) documentation site. Here, you'll find Product Documentation, API Documentation, and Release Notes for TDP components.

Release Notes    API Documentation

Audit Logs

The Tetra Data Platform has a robust audit trail feature that automatically logs system and user actions. The audit trail function can be used for the auditing of and compliance with 21 CFR reporting. Note that audit trail records cannot be altered. Only administrators can access audit trail records.

Audit trail records include:

  • User Actions are performed by users in the TetraScience software.
  • System Actions are programmatically performed in the TetraScience software.

📘

NOTE

AWS Infrastructure logs that contain automated and user-initiated data is captured in AWS CloudWatch and CloudTrail. For more information on these two features, see this documentation: CloudWatch, CloudTrail.

If you are an administrator, you can access the audit trail page, filter and view audit trail records, and download them to a CSV for further analysis.

Access the Audit Trail Page

Only administrators can access the user audit trail page. To access the page, do the following.

  1. Click the profile icon.
  1. Click Account.
  1. Click Audit Trail from the menu on the left side of the page.
  1. The Audit Trail page appears with audit log records. The most recent records appear first.

View Audit Trail Records

To view audit trail records, complete the following steps.

  1. In the Audit Trail page, filter the records by selecting options at the top of the page. If you want to see all of the options, leave all of the filtered fields blank. The table below lists the audit trail filters.

Audit Trail Filters

Field

Description

Actor Name

The name of the actor who/that initiated the action. The actor name can be a service account's name or an individual user's name.

For example, if you want to see all of the authorization tokens a specific user created, enter the name of the user in the Actor Name field.

Start Date/End Date

Enter the start date and end date if you want to see audit logs that were generated on or between specific dates. Note that you can also indicate the hours/minutes. For example, you could see all user logins between March 1, 2021 at 11:00 pm to March 3, 2021 6:00 am.

Fields should be entered in the following format: YYYY-MM-DD HH:MM AM/PM Clicking on the field displays a calendar. Once the calendar date is selected, you can select the time.

If you would prefer to see audit logs for all dates, leave these fields blank.

Entity

Indicates what the action was performed on. For example, you could choose "Pipeline" to view the logs related to pipelines. Entities and corresponding actions are listed in the Entities and Logged Actions table.

Action

Indicates what was done to the entity. This field displays different information based on what is selected for the entity. For example, if you choose Pipeline for the entity, you could choose to see all pipelines that were created, updated, deleted, or reprocessed.

Entities and corresponding actions are listed in the Entities and Logged Actions table.

Actors and Logged Actions

Entity

Actions

Auth (Authorization Token)

Create

DataHub

Activate, Create, Update, Delete, Sync, Update Config

DataHub Agent

Create, Update, Delete

Datahub Connector

Create, Update, Delete, Enable, Disable

File

Upload, Update Tags, Update Metadata, Update Metadata and Tags, Delete

Filter Field

Create, Delete

Integration

Create, Update, Delete

Source

Create, Update, Delete, Enable, Disable, Enable Queue, Disable Queue

IoT Integration

Create, Update, Delete

IoT Source

Create, Update, Delete

Label

Create, Delete

Metadata

Create, Delete

Organization

Create, Update, Delete

Pipeline

Create, Update, Delete, Reprocess

Service User

Create, Update, Delete, Enable, Disable, Unlock, Change Role

Shared Secret

Create, Update, Delete

Shared Setting

Create, Update, Delete

User

Create, Update, Delete, Enable, Disable, Unlock, Change Role, Change Password, Login Attempt

User Setting

Create, Update, Delete

Tag

Create, Delete

Workflow

Restart

  1. After you've adjusted the filters, results appear.

User Action Audit Trail

Audit Trail Result Fields

Field

Description

Entity

Name of the entity the action was performed on. The entity has three lines of information.

  • The first line contains the brief one line summary of the entity, such as the specific pipeline's name or the specific label's title.
  • The second line contains the ID number of the specific entity.
  • The third line allows us to view the specific entity in the Tetra Data Platform. For example, for a pipeline, it shows the pipeline in the Edit Pipeline page.

EntityType

Lists the entity type. Types are Auth (Authorization Token), DataHub, DataHub Agent, Datahub Connector, File, Filter Field, Integration, Source, IoT Integration, IoT Source, Label, Metadata, Organization, Pipeline, Service User, Shared Secret, Shared Setting, User, User Setting, Tag, Workflow.

Action

This menu indicates the action taken by the Entity/Type. For a list of Actors and Actions see the Actors and Logged Actions table.

The action has two lines of information.

  • The first line lists the type of action (such as Create or Login Attempt). For a full list of actions and how they relate to entity types, see the Actors and Logged Actions table.
  • The second line is a link to the code that shows the change.

Actor Name

The actor indicates who initiated the action. The actor name can be a service account's name or an individual user's name.

The actor has three lines of information.

  • Name of the actor.
  • Type of actor (e.g. User)
  • IP address.

Date

Date and time of the audit log entry.

  1. If you need to see the next page of results, click the page number or arrow keys at the bottom right corner of the window.

Export Audit Trail History

You can export your audit trail history to a CSV file. To do this, complete the following steps.

  1. In the Audit Trail window, click one or more checkboxes for the audit logs you want to export. If you want to export all of the records retrieved, click the checkbox next to the 'ENTITY' column label.
  1. Once one or more checkboxes are selected, the Export Selected (CSV) button appears. Click the button.
  2. The CSV file is downloaded and is ready for use. Note that the CSV file provides additional information that is not shown in the audit trail results list. The following appears in the CSV file:
  • id - Unique identifier of the specific entities in the log files.
  • org_slug - Organizational slug of the actor.
  • actor_id - Unique identifier for the actors.
  • actor_type - Indicates the type of actor (e.g. User).
  • actor_name - Name of the actor.
  • actor_email - Email address of the actor.
  • ip_address - Actor's IP address.
  • auth_token - Last 7 characters of the authorization token.
  • entity_type - Type of entity.
  • entity_id - ID for the entity.
  • action - Action performed on the entity.
  • before - Entity details before the action was taken. Typically, for "create" or "login-attempt" actions, this field remains empty. For update or delete actions, the field shows the state of the entity before the action occured.
  • after - Entity details after the action was taken. For delete actions, this field typically is empty.
  • entity-schema-version - Indicates the schema version for the entity (if the entity has one).
  • created_at - Indicates the date/timestamp for the log entry.

View Historical Audit Trail Data From Previous Tetra Data Platform Versions

To view the audit trail data for historical audit trail data prior to upgrade to version 3.0 of the system, do the following.

  1. Click the Historical Audit Trail Data link in the upper right corner of the page.
  1. The Historical Audit Data page appears.
  1. Adjust the filters to view the logs. Filters are:
  • From date/time - Display log entries starting with this date and time.
  • To date/date - Display log entries through this date and time.
  • Apply Date Time Filter - Click this button to apply the date/time filters.
  • Entity - Select the entity you'd like to view.
  1. You can adjust the number of logs shown per page by selecting a number in the Logs per Page drop-down menu near the bottom of the window. You can view choose to view anywhere from 20 to all log entries.

  2. If you want to export your results as a CSV file, click Export as CSV near the top right corner of the page.

  3. To view the current audit trail data again, click the Current Audit Data link.

Updated 2 months ago


Audit Logs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.