proxy-related Configurations

Related configuration of proxy, used to validate client requests and reduce the returned results.

proxy.timeTickInterval

Description	Default Value
The interval at which proxy synchronizes the time tick, unit: ms.	200

proxy.healthCheckTimeout

Description	Default Value
ms, the interval that to do component healthy check	3000

proxy.msgStream.timeTick.bufSize

Description	Default Value
The maximum number of messages can be buffered in the timeTick message stream of the proxy when producing messages.	512

proxy.maxNameLength

Description	Default Value
The maximum length of the name or alias that can be created in Milvus, including the collection name, collection alias, partition name, and field name.	255

proxy.maxFieldNum

Description	Default Value
The maximum number of field can be created when creating in a collection. It is strongly DISCOURAGED to set maxFieldNum >= 64.	64

proxy.maxVectorFieldNum

Description	Default Value
The maximum number of vector fields that can be specified in a collection. Value range: [1, 10].	4

proxy.maxShardNum

Description	Default Value
The maximum number of shards can be created when creating in a collection.	16

proxy.maxDimension

Description	Default Value
The maximum number of dimensions of a vector can have when creating in a collection.	32768

proxy.ginLogging

Description	Default Value
Whether to produce gin logs.\n please adjust in embedded Milvus: false	true

proxy.ginLogSkipPaths

Description	Default Value
skip url path for gin log	/

proxy.maxTaskNum

Description	Default Value
The maximum number of tasks in the task queue of the proxy.	1024

proxy.mustUsePartitionKey

Description	Default Value
switch for whether proxy must use partition key for the collection	false

proxy.accessLog.enable

Description	Default Value
Whether to enable the access log feature.	false

proxy.accessLog.minioEnable

Description	Default Value
Whether to upload local access log files to MinIO. This parameter can be specified when proxy.accessLog.filename is not empty.	false

proxy.accessLog.localPath

Description	Default Value
The local folder path where the access log file is stored. This parameter can be specified when proxy.accessLog.filename is not empty.	/tmp/milvus_access

proxy.accessLog.filename

Description	Default Value
The name of the access log file. If you leave this parameter empty, access logs will be printed to stdout.

proxy.accessLog.maxSize

Description	Default Value
The maximum size allowed for a single access log file. If the log file size reaches this limit, a rotation process will be triggered. This process seals the current access log file, creates a new log file, and clears the contents of the original log file. Unit: MB.	64

proxy.accessLog.rotatedTime

Description	Default Value
The maximum time interval allowed for rotating a single access log file. Upon reaching the specified time interval, a rotation process is triggered, resulting in the creation of a new access log file and sealing of the previous one. Unit: seconds	0

proxy.accessLog.remotePath

Description	Default Value
The path of the object storage for uploading access log files.	access_log/

proxy.accessLog.remoteMaxTime

Description	Default Value
The time interval allowed for uploading access log files. If the upload time of a log file exceeds this interval, the file will be deleted. Setting the value to 0 disables this feature.	0

proxy.accessLog.cacheSize

Description	Default Value
Size of log of write cache, in byte. (Close write cache if size was 0)	0

proxy.accessLog.cacheFlushInterval

Description	Default Value
time interval of auto flush write cache, in seconds. (Close auto flush if interval was 0)	3

proxy.connectionCheckIntervalSeconds

Description	Default Value
the interval time(in seconds) for connection manager to scan inactive client info	120

proxy.connectionClientInfoTTLSeconds

Description	Default Value
inactive client info TTL duration, in seconds	86400

proxy.maxConnectionNum

Description	Default Value
the max client info numbers that proxy should manage, avoid too many client infos	10000

proxy.gracefulStopTimeout

Description	Default Value
seconds. force stop node without graceful stop	30

proxy.slowQuerySpanInSeconds

Description	Default Value
query whose executed time exceeds the `slowQuerySpanInSeconds` can be considered slow, in seconds.	5

proxy.queryNodePooling.size

Description	Default Value
the size for shardleader(querynode) client pool	10

proxy.http.enabled

Description	Default Value
Whether to enable the http server	true

proxy.http.debug_mode

Description	Default Value
Whether to enable http server debug mode	false

proxy.http.port

Description	Default Value
high-level restful api

proxy.http.acceptTypeAllowInt64

Description	Default Value
high-level restful api, whether http client can deal with int64	true

proxy.http.enablePprof

Description	Default Value
Whether to enable pprof middleware on the metrics port	true

proxy.ip

Description	Default Value
TCP/IP address of proxy. If not specified, use the first unicastable address

proxy.port

Description	Default Value
TCP port of proxy	19530

proxy.grpc.serverMaxSendSize

Description	Default Value
The maximum size of each RPC request that the proxy can send, unit: byte	268435456

proxy.grpc.serverMaxRecvSize

Description	Default Value
The maximum size of each RPC request that the proxy can receive, unit: byte	67108864

proxy.grpc.clientMaxSendSize

Description	Default Value
The maximum size of each RPC request that the clients on proxy can send, unit: byte	268435456

proxy.grpc.clientMaxRecvSize

Description	Default Value
The maximum size of each RPC request that the clients on proxy can receive, unit: byte	67108864