アクセスログリファレンス

アクセスログは JSON Lines 形式で配信されます。各行に 1 つの 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 ファイル内の 1 行を占めます。以下のセクションでは、各フィールドについて詳しく説明します。

Log field schema

Field	Required	Type	Description	Example
`action`	Yes	string	操作名。Supported actions を参照してください。	`"Search"`
`database`	No	string	操作が発生したデータベース。	`"データベース1"`
`log_type`	Yes	string	ログカテゴリ：`"Access"`、`"Audit",` または `"Slow"`。	`"Access"`
`user`	Yes	string	リクエストを発行したユーザーまたは API キー。	`"key-xxxxxxxxxx"`
`cluster_id`	Yes	string	クラスターの一意の識別子。	`"in01-668744cf5e27e2d"`
`timestamp`	Yes	int	プロキシがリクエストを受信した時点の Unix タイムスタンプ（ミリ秒単位、13 桁）。	`1742798170636`
`trace_id`	Yes	string	操作の一意の ID。同じリクエストに属する複数のログエントリを関連付けるために使用します。	`"90c09bcd04d8f41871ebe2c3aa7126d4"`
`result`	Yes	int	操作の結果コード。0 は成功を示し、0 以外の値はエラーを示します。	`0`
`interface`	Yes	string	インターフェースタイプ：`"Restful"` または `"SDK"`。	`"Restful"`
`params`	Yes	object	アクション固有のパラメータ。ネストされたフィールドについては以下を参照してください。	--

params fields

Field	Required	Type	Description	Example
`params.sdk`	No	string	interface が SDK の場合に記録される SDK 言語。	`"Python"`
`params.expr`	No	string	リクエストとともに渡されたフィルタ式。	`""`
`params.collection`	No	string	対象コレクションの名前。Search、HybridSearch、および Query アクションで必須です。	`"medium_articles"`
`params.partition`	No	string	指定されている場合の対象パーティション。	`"partition1"`
`params.input_params`	No	object	操作の入力パラメータ（offset、limit など）。	`{"limit": "10", "offset": "0"}`
`params.output_fields`	No	array	クエリで要求された出力フィールド。	`["title", "id"]`
`params.consistency_level`	No	int	操作に使用された整合性レベル。	`2`
`params.execution_time`	No	string	サーバー側の実行時間（ミリ秒単位）。プロキシがペイロード全体を受信してからレスポンスの送信を開始するまでを計測します。ネットワーク転送時間は含まれません。	`"2.924823ms"`
`params.ids`	No	array	クエリ結果における主キーの値。出力フィールドに含めるように構成されている場合、Search、HybridSearch、および Query アクションでのみ表示されます。	`["53d85e82-...", "9ead30cf-..."]`
`params.scores`	No	array	`params.ids` の各エントリに対応する類似度スコア。Search、HybridSearch、および Query アクションでのみ表示されます。	`[0.11, 0.12, 0.13]`

Supported actions

このリリースでは、検索系またはクエリ系のアクションのみをログに記録します：

Action	Description
Search	ベクトル類似度検索
HybridSearch	リランキング付きのマルチベクトル検索
Query	スカラーフィルタリングクエリ

📘Notes

追加のアクションのサポートは、将来のリリースで予定されています。

File path and naming

ログファイルは、オブジェクトストレージバケット内に以下のパス構造で整理されています：

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

コンポーネント	形式	例
クラスター ID	クラスターの一意の識別子	`in03-c7be749d5f403ad`
ログタイプ	access、audit、または slow	`access`
日付	ISO 形式の日付 (YYYY-MM-DD)	`2024-12-20`
ファイル名	HH:MM:SS-<UUID>。ここで HH:MM:SS は UTC 時間、<UUID> は一意性を確保するためのランダムな文字列です	`09:16:53-jz5l7D8Q`
ファイル名の拡張子	.log	`.log`

フルパスの例：

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

Log field schema​

params fields​

Supported actions​

File path and naming​

Log field schema

params fields

Supported actions

File path and naming