Using the Audit Log

The LinearB Audit Log allows admins to monitor system activity, track changes, and maintain compliance by exporting detailed logs of actions performed across the platform.

Prerequisites

Admin access is required. Only users with Admin permissions can view and generate audit logs.

Accessing the Audit Log

1. Sign in to your LinearB account using Admin credentials.
2. Navigate to Company Settings.
3. Click the Setting section in the lower-left corner of the page.
4. Navigate to the General tab.
5. Scroll to the bottom of the page to locate the Audit Log section.

   

Generating an Audit Log

1. Select a Time Frame

• Use the calendar tool to choose the start and end dates for the period you want to audit.
• Example: Oct 4 – Nov 3 (Past 30 days)

1. Choose File Format

• CSV – Ideal for analysis in tools like Microsoft Excel or Google Sheets.
• JSON – Best for developers or importing into other systems.

1. Download the Log

• Click Download Log.
• The system will compile and download the file. Depending on the selected date range, this may take a few moments.
• The log file is saved to your local download location.

Audit Log Field Descriptions

Each record in the audit log contains the following fields:

• organization_id – Unique ID of your organization
• team_id – Team associated with the action
• account_id – ID of the user who performed the action
• repository_id – Affected repository’s unique ID
• created_at – Timestamp of the action
• category – Broad category (e.g., Authentication, Repository Management)
• sub_category – Specific event type (e.g., Login, Repository Deletion)
• description – Short explanation of the action
• type – Source of the action
  • User – Performed by a user
  • System – Performed by LinearB automatically
• metadata – Key-value pairs showing what changed
  • Example: {"workingDays": {"newValue": "1-5", "oldValue": "1-6"}}

Tips for Interpreting the Audit Log

Filtering Data

• Use spreadsheet functions (for CSV) or parsing tools (for JSON) to:
• Filter by user, team, or action type
•  Isolate specific categories (e.g., Auth, Repository)

Monitoring Changes

• Focus on the metadata field to identify what values were changed and when.
• Review System entries to confirm automated actions are running as expected.

Security Audits:

• Regularly scan logs for unusual activity or unauthorized access attempts.
• Ensure all actions are consistent with company policy.

Best Practices

Regular Reviews

• Schedule periodic audits to stay proactive in managing your organization's security.

Data Storage

• Keep audit logs in a secure location with restricted access.
• Consider encrypting the files if they contain sensitive information.

Compliance

• Ensure that the handling of audit logs complies with relevant regulations and standards applicable to your industry.

Troubleshooting

Cannot Access Audit Logs

• Ensure you’re logged in with an Admin role.
• Confirm you’re in the Company setting.
• Still blocked? Contact LinearB support.

Slow Log Generation or Download

• Logs covering long periods may take longer to generate.
• Try a shorter time frame to reduce processing time and file size.

File Format Issues

• Ensure you have compatible software to open CSV or JSON files.
• For CSV files, use spreadsheet applications like Excel or Google Sheets.
• For JSON files, use a text editor or specialized JSON viewer.