访问日志参考

公测版

访问日志 以 JSON Lines 格式传输——每行一个 JSON 对象。每行是一个独立的 JSON 对象，代表一次操作。以下示例展示了一个 Search 操作，为便于阅读进行了格式化：

{
    "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]
    }
}

实际使用中，每条记录在 .log 文件中占一行。以下各节详细描述每个字段。

日志字段 Schema

字段	必填	类型	描述	示例
action	是	string	操作名称。参见支持的操作。	"Search"
database	否	string	操作所在的数据库。	"Database1"
log_type	是	string	日志类别："Access"、"Audit" 或 "Slow"。	"Access"
user	是	string	发起请求的用户或 API Key。	"key-xxxxxxxxxx"
cluster_id	是	string	集群的唯一标识符。	"in01-668744cf5e27e2d"
timestamp	是	int	代理接收请求时的 Unix 时间戳，单位为毫秒（13 位）。	1742798170636
trace_id	是	string	操作的唯一 ID。用于关联属于同一请求的多条日志记录。	"90c09bcd04d8f41871ebe2c3aa7126d4"
result	是	int	操作结果码。0 表示成功；非零值表示错误。	0
interface	是	string	接口类型：Restful 或 SDK。	"Restful"
params	是	object	操作相关参数。嵌套字段详见下文。	--

params 字段

字段	必填	类型	描述	示例
params.sdk	否	string	SDK 语言，在 interface 为 SDK 时记录。	"Python"
params.expr	否	string	请求中传递的过滤表达式。	""
params.collection	否	string	目标 Collection。Search、HybridSearch 和 Query 操作必填。	"medium_articles"
params.partition	否	string	目标 Partition（如已指定）。	"partition1"
params.input_params	否	object	操作的输入参数（搜索参数、offset、topk 等）。	{"topk": "10", "offset": "0"}
params.output_fields	否	array	查询中请求的输出字段。	["title", "id"]
params.consistency_level	否	int	操作使用的一致性级别。	2
params.execution_time	否	string	服务端执行时间，从代理接收完整载荷到开始发送响应的时间，单位为毫秒。不包含网络传输时间。	"2.924823ms"
params.ids	否	array	查询结果中的主键。仅在 Search、HybridSearch 和 Query 操作中出现，且需配置输出参数包含该字段。	["53d85e82-...", "9ead30cf-..."]
params.scores	否	array	与 params.ids 中各条目对应的相似度分数。仅在 Search、HybridSearch 和 Query 操作中出现。	[0.11, 0.12, 0.13]

支持的操作

当前版本仅记录查询类操作：

操作	描述
Search	向量相似性搜索
HybridSearch	多向量搜索并重排序
Query	标量过滤查询

📘说明

更多操作的支持计划在后续版本中发布。

文件路径与命名

日志文件在你的对象存储桶中按照以下路径结构组织：

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

组成部分	格式	示例
Cluster ID	集群的唯一标识符	in03-c7be749d5f403ad
Log type	access、audit 或 slow	access
Date	ISO 日期（YYYY-MM-DD）	12/20/2024
File name	HH:MM:SS-<UUID>，其中 HH:MM:SS 为 UTC 时间，<UUID> 为随机字符串以确保唯一性	09:16:53-jz5l7D8Q
File name suffix	.log	.log

完整路径示例：

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