Access Log Reference

Contact Sales to Enable BYOC

Access logs are delivered in JSON Lines format - one JSON object per line. Each line is a self-contained JSON object representing a single operation. The following example shows a log entry of the Search operation:

{
    "action": "Search",
    "database": "Database1",
    "log_type": "Access",
    "user": "key-xxxxxxxxxx",
    "cluster_id": "in01-668744cf5e27e2d",
    "timestamp": 1742798170636,
    "trace_id": "90c09bcd04d8f41871ebe2c3aa7126d4",
    "result": 0,
    "interface": "Restful",
    "params": {
        "sdk": "Python",
        "expr": "",
        "collection": "medium_articles",
        "partition": "partition1",
        "input_params": {
            "anns_field": "",
            "offset": "0",
            "params": "{}",
            "round_decimal": "-1",
            "topk": "3"
        },
        "output_fields": ["title", "link", "id"],
        "consistency_level": 2,
        "execution_time": "2.924823ms",
        "ids": [
            "53d85e82-8fa0-4569-8dc9-7ecb2f9cc264",
            "9ead30cf-fa05-450a-8704-76c994dae0f2",
            "b85acff9-2375-4105-9baf-e82dea772a24"
        ],
        "scores": [0.11, 0.12, 0.13]
    }
}

In practice, each entry occupies a single line in the .log file. The sections below describe each field in detail.

Log field schema

Field	Required	Type	Description	Example
action	Yes	string	The operation name. See Supported actions.	"Search"
database	No	string	The database where the operation occurred.	"Database1"
log_type	Yes	string	Log category: "Access", "Audit", or "Slow".	"Access"
user	Yes	string	The user or API key that issued the request.	"key-xxxxxxxxxx"
cluster_id	Yes	string	The unique identifier of the cluster.	"in01-668744cf5e27e2d"
timestamp	Yes	int	Unix timestamp in milliseconds (13 digits) when the proxy received the request.	1742798170636
trace_id	Yes	string	A unique ID for the operation. Use this to correlate multiple log entries belonging to the same request.	"90c09bcd04d8f41871ebe2c3aa7126d4"
result	Yes	int	The operation result code. 0 indicates success; non-zero values indicate errors.	0
interface	Yes	string	The interface type: "Restful" or "SDK".	"Restful"
params	Yes	object	Action-specific parameters. See below for nested fields.	--

params fields

Field	Required	Type	Description	Example
params.sdk	No	string	The SDK language, recorded when interface is SDK.	"Python"
params.expr	No	string	The filter expression passed with the request.	""
params.collection	No	string	The name of the target collection. Required for Search, HybridSearch, and Query actions.	"medium_articles"
params.partition	No	string	The target partition, if specified.	"partition1"
params.input_params	No	object	Input parameters for the operation (offset, limit, etc.).	{"limit": "10", "offset": "0"}
params.output_fields	No	array	The output fields requested in the query.	["title", "id"]
params.consistency_level	No	int	The consistency level used for the operation.	2
params.execution_time	No	string	Server-side execution time in milliseconds, measured from when the proxy receives the full payload to when it begins sending the response. Does not include network transit time.	"2.924823ms"
params.ids	No	array	The value of the primary key in the query result. Appears only for Search, HybridSearch, and Query actions when output fields are configured to include it.	["53d85e82-...", "9ead30cf-..."]
params.scores	No	array	The similarity scores corresponding to each entry in params.ids. Appears only for Search, HybridSearch, and Query actions.	[0.11, 0.12, 0.13]

Supported actions

This release logs search- or query-class actions only:

Action	Description
Search	Vector similarity search
HybridSearch	Multi-vector search with reranking
Query	Scalar filtering query

📘Notes

Support for additional actions is planned for a future release.

File path and naming

Log files are organized in your object storage bucket with the following path structure:

/<Cluster ID>/<Log type>/<Date>/<File name><File name suffix>

Component	Format	Example
Cluster ID	The cluster's unique identifier	in03-c7be749d5f403ad
Log type	access, audit, or slow	access
Date	ISO date (YYYY-MM-DD)	2024-12-20
File name	HH:MM:SS-<UUID>, where HH:MM:SS is the UTC time and <UUID> is a random string for uniqueness	09:16:53-jz5l7D8Q
File name suffix	.log	.log

Full path example:

/in03-c7be749d5f403ad/access/2024-12-20/09:16:53-jz5l7D8Q.log