📜 Operation Logs

Operation logs record key operations and API calls in the system and are critical for auditing, troubleshooting, and security compliance.

In one sentence

Who did what, when, in which module, and whether it succeeded or failed—all can be found here.

🔍 What you see in the log list

On the Operation Logs page, each row shows core information for one record:

• Operation time

  • Exact timestamp of the operation.
  • When you have permission, the time appears as a blue link; clicking opens a details drawer.

• Operator

  • User nickname / account that performed this operation.
  • Used to trace responsibility or collaborate in investigations.

• Operation description

  • Human-readable description such as: create environment, change group, authorize user, etc.
  • Supports multiple languages for international teams.

• Module

  • Which business module was involved, for example: Environment Management, Group Management, Members & Permissions, etc.
  • Helps you narrow down the scope quickly.

• Status

  • Success: green tag with “Success”.
  • Failure: red tag; hover to see a short error message (errorMsg).

• IP and location

  • Operation IP: IP address of the request origin.
  • Location: Geolocation from the IP (country/region/city).

• Latency

  • Time from request to response, in ms.
  • Color-coded for performance:
    • Green: < 200 ms
    • Yellow: 200–500 ms
    • Red: > 500 ms

• Browser and OS

  • Browser type and OS of the client.
  • Useful for diagnosing compatibility issues on specific endpoints.

🎯 How to filter logs quickly

Filters at the top of the page help you narrow down results:

• Search by operator

  • Type nickname or username into “Search operator”.
  • Press Enter or change the field to refresh the list.

• Search by IP / location

  • Type keywords into “Search IP or location”.
  • Useful when investigating specific office networks or regions.

• Filter by module

  • Use the “Module” dropdown to select a specific module.
  • Options come from the backend and stay aligned with business modules.

• Filter by time range

  • Default range is last 7 days.
  • Use the date picker to set start and end times.
  • Changing the range reloads data automatically.

Combined with pagination, you can efficiently locate logs in the right time window and for the right operations.

📂 View details of a single operation

For deeper analysis, click the “Operation time” link to open the details drawer:

• Basic info

  • Log ID, TraceID.
  • Operator, operation time.
  • Description, module.
  • IP, location.
  • Browser, OS.
  • Status (success/failure) and latency.

• Request

  • Request URI (endpoint).
  • Request headers (JSON).
  • Request body (formatted JSON).

• Response

  • Response headers (JSON).
  • Response body (formatted result or error).

All JSON content is formatted and scrollable for easy copy-and-paste into external tools.

About TraceID

TraceID can be used in backend logs or tracing systems to follow the entire lifecycle of this request and quickly locate server-side problems.

🧭 Common usage scenarios

• Find why an operation failed

  • Filter by operator/module/time to find the target record.
  • Check whether status is “Failure” and hover for the error summary.
  • If needed, open details and inspect request parameters and response body.

• Audit high-risk operations

  • For example, group permission changes, user disable actions, billing-related operations.
  • Filter by module and review operations and operators in time order.

• Analyze performance bottlenecks

  • Focus on red/yellow entries in the latency column.
  • For slow operations, open details to see path and parameters and pass them to dev/ops for optimization.

• Locate abnormal behavior

  • When you observe anomalies (frequent retries, mass delete failures, etc.),
  • Use IP/location + operator filters to determine whether it’s internal misuse or external suspicious access.

🔒 Security & compliance recommendations

• Reasonable retention period

  • Choose a retention period based on your internal security and compliance policy (for example, 6 months or 1 year).
  • Keep enough history for audit without consuming unnecessary storage.

• Access control

  • Operation logs should usually be visible only to admins and auditors.
  • For normal users, it’s recommended to hide this entry to avoid exposing internal details.

• Sensitive data protection

  • Requests/responses may contain sensitive fields (accounts, phone numbers, etc.).
  • Train staff to respect privacy and comply with data protection regulations.

With operation logs, you can make important operations “controllable before, traceable during, and auditable after”, providing solid support for daily operations, security audits, and incident analysis.