Skip to content

Audit Logs

Admins for Professional and Enterprise Organizations now have access to the Wherobots Audit Logs feature and its associated REST API endpoint.

Audit Logs Image

Benefits

  • Enhanced Security: Monitor key activities within your Organization to identify potential security risks and ensure compliance.
  • Improved Accountability: Track user actions and system events, providing a clear audit trail for troubleshooting and investigations.
  • Operational Transparency: Gain insights into how Wherobots resources are being used, aiding in resource management and optimization.
  • Data Retention: Utilize the Audit Logs REST API endpoint to preserve logs beyond Wherobots' 90-day retention period, ensuring long-term access to critical information.

Key Features

  • Comprehensive Activity Tracking: Logs actions related to security credentials, file management, job execution, notebook lifecycle, Organizational administration, spatial data management, and runtime environments.
  • Intuitive User Interface: Admins can easily view and filter logs within the Wherobots Cloud interface.
  • Flexible Filtering: Filter logs by date range, search terms, Organization Member, action, resource, IP address, and user agent.
  • On-Demand Export (UI): Export filtered audit log data as a CSV file directly from the Wherobots Cloud interface.
  • Programmatic Export (API): Utilize the Audit Logs REST API endpoint to programmatically export logs, enabling scheduled backups and integrations with external systems.
  • ISO 8601 Date/Time Format: The API utilizes the ISO 8601 standard for startTime and endTime parameters, ensuring consistency and avoiding ambiguity.
  • Admin-Only Access: Access to both the Audit Logs feature and the API endpoint is restricted to users with the Admin role within the Wherobots Organization.
  • Paid Organization Requirement: The Audit Logs feature and API endpoint are available for Admins within Wherobots Professional and Enterprise Edition Organizations.

How Audit Logs Work

The Wherobots Audit Logs feature captures and records significant events that occur within your Wherobots Organization. These events encompass a wide range of actions, from user authentication and authorization to resource creation, modification, and deletion.

Data Collection: As Organization Members interact with Wherobots, the platform records these actions along with relevant details such as:

  • Timestamp: The exact time the event occurred.
  • User Information: The ID and username (email or display name) of the Organization Member who initiated the action.
  • User Agent: Information about the software used to make the request (e.g., browser, operating system).
  • Source IP Address: The IP address from which the request originated.
  • Action Name: A description of the specific action performed (e.g., CreateNotebook, DeleteFile).
  • Resource Information: The name and ID of the resource affected by the action (if applicable).
  • Compute Region: The compute region where the event originated (if applicable).

Data Storage and Retention: The collected audit logs are stored securely within the Wherobots platform. These logs are retained for a period of 90 days.

Access and Export:

  • Wherobots Cloud Interface: Administrators can access and view these logs through the Audit Logs section in the Organization Settings of the Wherobots Cloud interface. The interface provides filtering and pagination capabilities to help navigate and analyze the logs. Logs can be exported on-demand as CSV files.
  • Audit Logs REST API: For programmatic access and long-term retention, the Audit Logs REST API endpoint allows administrators to export logs based on specific criteria (time range, search terms). This enables the automation of log backups and integration with external security information and event management (SIEM) systems.

Important Considerations

  • 90-Day Log Retention: Wherobots retains audit logs for a period of 90 days.
  • Proactive Export for Long-Term Retention: To preserve logs beyond the 90-day retention period, you can implement a scheduled script into your workflow that utilizes the Audit Logs REST API endpoint to export and store logs externally.
  • API Rate Limits: The Audit Logs REST API endpoint is subject to a rate limit of 100 requests per 5 seconds. Plan your integrations accordingly.
  • Admin Role Required: Only users with the Admin role within the Wherobots Organization can access and utilize the Audit Logs feature and API endpoint.
  • Paid Organization Requirement: You must have a Professional or Enterprise Edition Organization in order to access Audit Logs and its API endpoint.
  • Data Availability Latency: While events are tracked in real-time, there may be a delay of approximately 10 minutes before they are available for querying and export.

Get Started

Get started and try this feature now!

View Audit Logs

Read the Documentation

For more detailed information and instructions, please refer to the following Wherobots documentation: