milvus-logo
LFAI
Home
  • Reference

Proxy-related Configurations

This topic introduces the proxy-related configurations of Milvus.

Proxy is the access layer of the system and endpoint to users. It validates client requests and reduces the returned results.

Under this section, you can configure proxy port, system limits, etc.

proxy.port

Description Default Value
TCP port of proxy. 19530

proxy.grpc.serverMaxRecvSize

Description Default Value
  • The maximum size of each RPC request that the proxy can receive.
  • Unit: Byte
  • 536870912

    proxy.grpc.serverMaxSendSize

    Description Default Value
  • The maximum size of each respond the proxy can send when receiving an RPC request.
  • Unit: Byte
  • 536870912

    proxy.grpc.clientMaxRecvSize

    Description Default Value
  • The maximum size of each respond that the proxy can receive when sending an RPC request.
  • Unit: Byte
  • 104857600

    proxy.grpc.clientMaxSendSize

    Description Default Value
  • The maximum size of each RPC request that the proxy can send.
  • Unit: Byte
  • 104857600

    proxy.timeTickInterval

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

    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. 64

    proxy.maxDimension

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

    proxy.maxShardNum

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

    proxy.maxTaskNum

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

    proxy.accessLog.enable

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

    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. Empty string

    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.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.maxBackups

    Description Default Value
    The maximum number of sealed access log files that can be retained. If the number of sealed access log files exceeds this limit, the oldest one will be deleted. 8

    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.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.base.format

    Description Default Value
    The log format with dynamic metrics. This format applies to all methods by default. For more information about metrics, see Configure Access Logs. Empty string

    proxy.accessLog.<custom_formatter_name>.format

    Description Default Value
    The custom log format that you configure for specific methods. This parameter works together with proxy.accessLog.<custom_formatter_name>.methods. Empty string

    proxy.accessLog.<custom_formatter_name>.methods

    Description Default Value
    The methods to which the custom formatter applies. This parameter works together with proxy.accessLog.<custom_formatter_name>.format. Empty string