Skip to main content
Version: User Guides (BYOC)

Configure Access Logs

This guide covers the full lifecycle of access logs on Zilliz Cloud: enabling, adjusting settings, and disabling.

📘Notes

This release logs search- or query-class actions only: Search, HybridSearch, and Query. Support for the full action list is planned for a future release.

Before you start​

  • An object storage integration (AWS S3, Google Cloud Storage, or Azure Blob Storage) configured in the same region as your target cluster.

  • Organization Owner or Project Admin permissions for the project. If you do not have the required permissions, contact your Zilliz Cloud administrator.

Enable access logs​

1

Open the Zilliz Cloud console and navigate to your target cluster.

2

On the cluster configuration page, click the Access Log tab, then click Enable.

3

In the Access Log Settings dialog box, configure the following settings:

  • Storage Integration: Select the integrated storage bucket where log files will be delivered.

  • Directory: Specify a directory within the bucket to store audit logs.

  • Sampling Rate: Set the percentage of queries to log. A rate of 100% captures every operation. For high-volume workloads, a lower rate (such as 1%) reduces storage costs while preserving statistical significance.

  • Actions: Specify which operation types (for example, Search or HybridSearch) are recorded as access log entries.

  • Output Fields: Specify which metadata fields are included in each access log entry written to your object storage. Fields marked as Always included are recorded for every entry, while the selected fields are additionally captured.

4

Click Save. Log files begin appearing in your bucket within minutes, following the path convention /<Cluster ID>/Access/<Date>/<HH:MM:SS>-<UUID>.log.

Edit access log settings​

You can adjust the sampling rate and output fields at any time without disabling access logs.

1

Open the Zilliz Cloud console and navigate to your cluster.

2

On the cluster configuration page, click the Access Log tab.

3

Click Edit.

4

Adjust the Sampling Rate or Output Fields as needed.

5

Click Save. The updated settings take effect immediately for new log entries. Existing log files in your bucket are not affected.

Disable access logs​

1

Open the Zilliz Cloud console and navigate to your cluster.

2

On the cluster configuration page, click the Access Log tab.

3

Click Disable. New log entries stop immediately. Existing log files remain in your bucket. Billing for Access Logs stops once disabled.