Skip to main content

Audit Logs

Partially Implemented

The audit log viewer UI described in this documentation is not yet implemented. Security events are logged in the backend for compliance purposes, but there is currently no user interface to view these logs. This documentation describes the planned functionality. Check back for updates.

Track and review all activities within your organization for security and compliance purposes.

Overview​

Audit logs provide a complete record of actions taken within Kuviq. They help you:

  • Monitor user activity - See who did what and when
  • Investigate incidents - Track down the source of problems
  • Ensure compliance - Meet regulatory requirements
  • Maintain accountability - Document all changes

Accessing Audit Logs​

Where to Find​

  1. Go to Settings > Security > Audit Logs
  2. Or navigate to Admin > Audit & Compliance

Required Permissions​

  • Super Admin: Full access to all logs
  • Admin: Access to logs within their organization
  • Manager/User: No access to audit logs

Types of Logged Events​

Authentication Events​

EventDescription
LoginUser signed in
LogoutUser signed out
Failed LoginIncorrect credentials
Password ResetPassword was reset
2FA EnabledTwo-factor authentication activated
2FA DisabledTwo-factor authentication deactivated
Session ExpiredUser session timed out

User Management Events​

EventDescription
User CreatedNew user account created
User InvitedInvitation sent to user
User ActivatedAccount activated
User DeactivatedAccount deactivated
Role ChangedUser's role was modified
Location AssignedUser given location access
Location RemovedLocation access revoked

Data Events​

EventDescription
Item CreatedNew item added
Item UpdatedItem details modified
Item DeletedItem removed
Inspection CompletedInspection submitted
Inspection EditedInspection modified
Report GeneratedReport created
Data ExportedData exported from system
Data ImportedData imported into system

Administrative Events​

EventDescription
Settings ChangedOrganization settings modified
Template CreatedInspection template added
Template ModifiedTemplate updated
Location CreatedNew location added
Location ModifiedLocation details changed
Automation CreatedNew automation rule added
Webhook ConfiguredWebhook settings changed

Viewing Audit Logs​

Log Entry Details​

Each log entry includes:

  • Timestamp - When the event occurred (UTC)
  • User - Who performed the action
  • Action - What was done
  • Resource - What was affected
  • Details - Additional context
  • IP Address - Source IP
  • User Agent - Browser/device info

Example Log Entry​

Timestamp: 2024-01-15 14:32:45 UTC
User: john.smith@company.com
Action: Item Updated
Resource: Fire Extinguisher #FE-2024-001
Details: Status changed from "Available" to "Under Maintenance"
IP Address: 192.168.1.100
User Agent: Chrome/120.0 (Windows)

Filtering Logs​

Filter Options​

FilterDescription
Date RangeStart and end dates
UserSpecific user's actions
Action TypeCategory of action
Resource TypeItems, inspections, users, etc.
KeywordSearch in details

Common Filter Scenarios​

All login attempts:

  • Action Type: Authentication
  • Date Range: Last 30 days

Specific user's activity:

  • User: Select user
  • Date Range: As needed

All data exports:

  • Action Type: Data Export
  • Date Range: Last 90 days

Failed inspections:

  • Action Type: Inspection Completed
  • Details contains: "failed"

Searching Logs​

  1. Use the search bar
  2. Enter keywords
  3. Search across all log details

For complex queries:

  1. Click Advanced Search
  2. Combine multiple criteria
  3. Use operators (AND, OR)
  4. Save search as filter

Exporting Logs​

Export Formats​

  • CSV - For spreadsheet analysis
  • PDF - For documentation
  • JSON - For integration

How to Export​

  1. Apply desired filters
  2. Click Export
  3. Choose format
  4. Download file

Export Limits​

  • Maximum 50,000 records per export
  • Large exports may take time
  • Consider narrowing date range

Log Retention​

Retention Periods​

PlanRetention
Free30 days
Starter90 days
Professional1 year
EnterpriseCustom

Extending Retention​

For compliance needs:

  1. Contact sales
  2. Custom retention available
  3. Archive options available

Real-Time Monitoring​

Activity Dashboard​

View recent activity:

  1. Go to Security Dashboard
  2. See real-time log stream
  3. Monitor for unusual activity

Alert Configuration​

Set up alerts for:

  • Multiple failed logins
  • Mass data exports
  • After-hours activity
  • Sensitive changes

Compliance Features​

Audit Reports​

Generate compliance reports:

  1. Go to Reports > Audit Reports
  2. Select report type
  3. Choose date range
  4. Generate report

Available Reports​

ReportContent
User Access ReportAll user access and permissions
Data Access ReportWho accessed what data
Change ReportAll modifications to data
Security ReportSecurity-related events

Report Scheduling​

Schedule automatic reports:

  1. Create report
  2. Click Schedule
  3. Set frequency
  4. Choose recipients

Best Practices​

Regular Review​

  1. Weekly: Review failed logins
  2. Monthly: Check data exports
  3. Quarterly: Full audit review
  4. Annually: Comprehensive compliance audit

Investigating Issues​

When something goes wrong:

  1. Note the approximate time
  2. Filter logs by time
  3. Identify affected resources
  4. Trace user actions
  5. Document findings

Maintaining Compliance​

For regulatory compliance:

  1. Export logs regularly
  2. Store exports securely
  3. Maintain for required period
  4. Document access controls

Integration​

SIEM Integration​

For enterprise security:

  1. Configure webhook for logs
  2. Point to SIEM system
  3. Logs streamed in real-time
  4. Analyze with other security data

API Access​

Programmatic access:

  • Use Audit Logs API
  • Query specific events
  • Build custom dashboards
  • Automate compliance checks

Troubleshooting​

Can't Find Specific Event​

  1. Expand date range
  2. Check filter settings
  3. Use broader search terms
  4. Event may have different name

Missing Log Entries​

  1. Check retention period
  2. Verify time zone settings
  3. Some events may not be logged
  4. Contact support if needed

Export Issues​

  1. Reduce date range
  2. Try different format
  3. Clear filters
  4. Check browser settings