Using Audit Log

Prerequisites

Admin Access Required: Only users with Admin privileges can generate audit logs.

Accessing the Audit Log Feature

1. Sign In: Log in to your account with your Admin credentials.
2. Navigate to Company Settings:
   1. Click on the "Setting" section located at the lower-left corner of the page.
   2. Select the “General” Tab. Scroll down to the bottom of the page.

Generating an Audit Log

1. Select Time Frame:
   1. Choose the start and end dates for the period you want to audit.
   2. Use the calendar tool to pick the dates accurately.
2. Choose File Format:
   1. Select your preferred format for the audit log:
      1. CSV: Ideal for viewing in spreadsheet applications like Microsoft Excel or Google Sheets.
      2. JSON: Suitable for developers or for importing into other software tools.
3. Generate the Audit Log:
   1. Click on the Downlog log button.
   2. Wait for the system to compile the log. This may take a few moments depending on the time frame selected.
   3. Once ready, a the audit log will be downloaded to your local download drive.

Understanding the Audit Log Fields

The audit log file contains several fields that provide detailed information about each recorded action:

• organization_id: Unique identifier for your organization.
• team_id: Unique identifier for the team involved in the action.
• account_id: Unique identifier for the user account that performed the action.
• repository_id: Unique identifier for the repository affected.
• created_at: Timestamp indicating when the action occurred.
• category: Broad classification of the action (e.g., Authentication, Repository Management).
• sub_category: More specific classification within the category (e.g., Login, Repository Deletion).
• description: Brief summary of the action taken.
• metadata:
  • Contains details of any fields and values that were changed.
  • Presented as key-value pairs.
  • Example: {'workingDays': {'newValue': '1-5', 'oldValue': '1-6'}}
• type: Indicates the origin of the action.
• Values:
  • User: Action was performed by a user.
  • System: Action was performed automatically by the system.

Tips for Interpreting Audit Logs

Filtering Data:

• Use spreadsheet functions or JSON parsing tools to filter and sort data.
• Focus on specific categories or users to narrow down the information.

Monitoring Changes:

• Pay special attention to the metadata field to understand what changes were made.
• Review actions listed as System type to ensure automated processes are functioning correctly.

Security Audits:

• Regularly check for any unauthorized access or unusual activities.
• Verify that all actions performed by users are compliant with your organization's policies.

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:

• Verify that you are logged in with an Admin account.
• Verify that you are viewing the “Company” setting.
• If you still cannot access it, contact LinerB support.

Slow Download or Generation Time:

• Large time frames may result in large files.
• Try selecting a shorter time frame to reduce the 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.