diff --git a/site/en/guides/get_started/install_milvus/cpu_milvus_docker.md b/site/en/guides/get_started/install_milvus/cpu_milvus_docker.md index 8924e7aa8..f27874b7a 100644 --- a/site/en/guides/get_started/install_milvus/cpu_milvus_docker.md +++ b/site/en/guides/get_started/install_milvus/cpu_milvus_docker.md @@ -112,14 +112,7 @@ For Step 3, instead of using `wget` to obtain the files, it is suggested to crea For Step 4, start the docker by mapping Milvus files to the right path. The following command is run in Windows Command shell: ```shell -$ docker run -d --name milvus_cpu_{{var.release_version}} \ --p 19530:19530 \ --p 19121:19121 \ --v C:\milvus\db:/var/lib/milvus/db \ --v C:\milvus\conf:/var/lib/milvus/conf \ --v C:\milvus\logs:/var/lib/milvus/logs \ --v C:\milvus\wal:/var/lib/milvus/wal \ -milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} +$ docker run -d --name milvus_cpu_{{var.release_version}} -p 19530:19530 -p 19121:19121 -v C:\milvus\db:/var/lib/milvus/db -v C:\milvus\conf:/var/lib/milvus/conf -v C:\milvus\logs:/var/lib/milvus/logs -v C:\milvus\wal:/var/lib/milvus/wal milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` ## Install Milvus on macOS diff --git a/site/en/reference/milvus_config.md b/site/en/reference/milvus_config.md index 10e365d4d..d7582e09a 100644 --- a/site/en/reference/milvus_config.md +++ b/site/en/reference/milvus_config.md @@ -35,17 +35,15 @@ You can update parameters in `server_config.yaml` from a Milvus client. See [Cli Updates to the following parameters take effect immediately. - - section `cache_config` - - `cpu_cache_capacity` - - `cache_insert_data` - - section `engine_config` - - `use_blas_threshold` - - `gpu_search_threshold` - - section `gpu_resource_config` + - section `cache` + - `cache_size` + - `insert_buffer_size` + - section `gpu` - `enable` - - `cache_capacity` - - `search_resources` - - `build_index_resources` + - `cache_size` + - `gpu_search_threshold` + - `search_devices` + - `build_index_devices` For other parameters, you still need to restart Milvus for the changes to take effect. @@ -60,7 +58,7 @@ Before changing these settings, welcome to consult Milvus team on [GitHub issues | Parameter | Description | Type | Default | | ------------------------ | ------------------------------------------------------------ | ------- | --------------- | | `enable` | If running with Mishards, set it as `true`, otherwise set it as `false`. | Boolean | `false` | -| `role` | Milvus deployment role: rw / ro | Role | `rw` | +| `role` | Milvus deployment role: `rw` / `ro` | Role | `rw` | ### Section `general` @@ -69,8 +67,8 @@ Before changing these settings, welcome to consult Milvus team on [GitHub issues | Parameter | Description | Type | Default | | ------------------------ | ------------------------------------------------------------ | ------- | --------------- | -| `timezone` | Uses UTC-x or UTC+x to specify a time zone. | Timezone | `false` | -| `meta_url` | URI for metadata storage, using SQLite (for single server Milvus) or MySQL (for distributed cluster Milvus). Format: dialect://username:password@host:port/database. Keep 'dialect://:@:/', 'dialect' can be either `sqlite` or `mysql`. Replace the other fields with the real values. | URI | `sqlite://:@:/` | +| `timezone` | Uses UTC-x or UTC+x to specify a time zone. | Timezone | `UTC+8` | +| `meta_uri` | URI for metadata storage, using SQLite (for single server Milvus) or MySQL (for distributed cluster Milvus). Format: `dialect://username:password@host:port/database`. Keep `dialect://:@:/`, `dialect` can be either `sqlite` or `mysql`. Replace the other fields with the real values. | URI | `sqlite://:@:/` | @@ -86,7 +84,7 @@ Before changing these settings, welcome to consult Milvus team on [GitHub issues | `http.port` | Port that Milvus HTTP server monitors. Port range (1024, 65535). | Integer | `19121` | -### Section `storage_config` +### Section `storage`
@@ -97,7 +95,7 @@ Before changing these settings, welcome to consult Milvus team on [GitHub issues
-### Section `wal_config` +### Section `wal`
@@ -105,24 +103,23 @@ Before changing these settings, welcome to consult Milvus team on [GitHub issues | -------------------- | ------------------------------------------------------------ | ------------ | ------- | | `enable` | Whether to enable write-ahead logging (WAL) in Milvus. If WAL is enabled, Milvus writes all data changes to log files in advance before implementing data changes. WAL ensures the atomicity and durability for Milvus operations. | Boolean | true | | `recovery_error_ignore` | Whether to ignore logs with errors that happens during WAL recovery. If true, when Milvus restarts for recovery and there are errors in WAL log files, log files with errors are ignored. If false, Milvus fails to restart when there are errors in WAL log files. | Boolean | true | -| `buffer_size` | Sum total of the read buffer and the write buffer in MBs. `buffer_size` must be in range `[64MB, 4096MB]`. If the value you specified is out of range, Milvus automatically uses the boundary value closest to the specified value. It is recommended you set `buffer_size` to a value greater than the inserted data size of a single insert operation for better performance. | String | `256MB` | +| `buffer_size` | Sum total of the read buffer and the write buffer in Bytes. `buffer_size` must be in range `[64MB, 4096MB]`. If the value you specified is out of range, Milvus automatically uses the boundary value closest to the specified value. It is recommended you set `buffer_size` to a value greater than the inserted data size of a single insert operation for better performance. | String | `256MB` | | `wal_path` | Location of WAL log files. | String | `/var/lib/milvus/wal` |
-### Section `cache_config` +### Section `cache`
| Parameter | Description | Type | Default | | -------------------- | ------------------------------------------------------------ | ------- | --------- | - -| `cache_size` | The size of the CPU memory for caching data for faster query. The sum of `cpu_cache_capacity` and `insert_buffer_size` must be less than the system memory size. | String | `4GB` | -| `insert_buffer_size` | Buffer size used for data insertion. The sum of `insert_buffer_size` and `cpu_cache_capacity` must be less than the system memory size. | String | `1GB` | +| `cache_size` | The size of the CPU memory for caching data for faster query. The sum of `cache_size` and `insert_buffer_size` must be less than the system memory size. | String | `4GB` | +| `insert_buffer_size` | Buffer size used for data insertion. The sum of `insert_buffer_size` and `cache_size` must be less than the system memory size. | String | `1GB` | | `preload_collection` | A comma-separated list of collection names that need to be pre-loaded when Milvus server starts up. '*' means preload all existing tables (single-quote or double-quote required). | StringList | N/A |
-### Section `gpu_config` +### Section `gpu` This section determines whether to enable GPU support/usage in Milvus. GPU support, which uses both CPU and GPUs for optimized resource utilization, can achieve accelerated search performance on very large datasets. @@ -135,16 +132,16 @@ This section determines whether to enable GPU support/usage in Milvus. GPU suppo | `cache_size` | Size of the GPU memory for caching data. | String | `1GB` | | `gpu_search_threshold` | A Milvus performance tuning parameter. This value will be compared with 'nq' to decide if the search computation will be executed on GPUs only. If nq >= `gpu_search_threshold`, the search computation will be executed on GPUs only; otherwise, the search computation will be executed on both CPUs and GPUs. | Integer | `1000` | | `search_devices` | A list of GPU devices used for search computation. Must be in format: `gpux`, where `x` is the GPU number, such as `gpu0`. | DeviceList | `gpu0` | -| `build_index_resources` | A list of GPU devices used for index building. Must be in format: `gpux`, where `x` is the GPU number, such as `gpu0`. | DeviceList | `gpu0` | +| `build_index_devices` | A list of GPU devices used for index building. Must be in format: `gpux`, where `x` is the GPU number, such as `gpu0`. | DeviceList | `gpu0` | -> Note: In Milvus, index building and search computation are separate processes, which can be executed on `cpu`, `gpu`, or both. You can assign multiple GPUs to index building and search computation by adding GPUs under `search_resources` or `build_index_resources`. The following YAML code shows an example: +> Note: In Milvus, index building and search computation are separate processes, which can be executed on `cpu`, `gpu`, or both. You can assign multiple GPUs to index building and search computation by adding GPUs under `search_devices` or `build_index_devices`. The following YAML code shows an example: ```yaml - search_resources: + search_devices: - gpu0 - gpu1 - build_index_resources: + build_index_devices: - gpu0 - gpu1 ``` @@ -158,11 +155,11 @@ This section determines whether to enable GPU support/usage in Milvus. GPU suppo | `level` | Log level in Milvus. Must be one of `debug`, `info`, `warning`, `error`, `fatal`. | String | `debug` | | `trace.enable` | Whether to enable trace level logging. | Boolean | `true` | | `path` | Absolute path to the folder holding the log files. | String | `/var/lib/milvus/logs` | -| `max_log_file_size` | The maximum size of each log file. Range: [512MB, 4096MB] | String | `1024` (MB) | +| `max_log_file_size` | The maximum size of each log file. Range: [512MB, 4096MB] | String | `1024MB` | | `log_rotate_num` | The maximum number of log files that Milvus keeps for each logging level. Range: [0, 1024]. `0` means that the number does not have an upper limit. | Integer | `0` | -### Section `metric_config` +### Section `metric`
diff --git a/site/zh-CN/guides/get_started/install_milvus/cpu_milvus_docker.md b/site/zh-CN/guides/get_started/install_milvus/cpu_milvus_docker.md index 1068af0d7..da20e4237 100644 --- a/site/zh-CN/guides/get_started/install_milvus/cpu_milvus_docker.md +++ b/site/zh-CN/guides/get_started/install_milvus/cpu_milvus_docker.md @@ -110,14 +110,7 @@ $ docker logs 第四步，启动 Docker 容器，将 Milvus 文件映射到你本地的文件路径。下面的命令是在命令提示符中运行的： ```shell -$ docker run -d --name milvus_cpu_{{var.release_version}} \ --p 19530:19530 \ --p 19121:19121 \ --v C:\milvus\db:/var/lib/milvus/db \ --v C:\milvus\conf:/var/lib/milvus/conf \ --v C:\milvus\logs:/var/lib/milvus/logs \ --v C:\milvus\wal:/var/lib/milvus/wal \ -milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} +$ docker run -d --name milvus_cpu_{{var.release_version}} -p 19530:19530 -p 19121:19121 -v C:\milvus\db:/var/lib/milvus/db -v C:\milvus\conf:/var/lib/milvus/conf -v C:\milvus\logs:/var/lib/milvus/logs -v C:\milvus\wal:/var/lib/milvus/wal milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` ## 在 macOS 上安装 Milvus diff --git a/site/zh-CN/reference/milvus_config.md b/site/zh-CN/reference/milvus_config.md index d910b78d6..81adfffa8 100644 --- a/site/zh-CN/reference/milvus_config.md +++ b/site/zh-CN/reference/milvus_config.md @@ -36,18 +36,15 @@ $ docker restart 对以下参数的运行时修改是立即生效的： - - `cache_config` 区域 - - `cpu_cache_capacity` + - `cache` 区域 + - `cache_size` - `insert_buffer_size` - - `cache_insert_data` - - `engine_config` 区域 - - `use_blas_threshold` - - `gpu_search_threshold` - - `gpu_resource_config` 区域 + - `gpu` 区域 - `enable` - - `cache_capacity` - - `search_resources` - - `build_index_resources` + - `cache_size` + - `gpu_search_threshold` + - `search_devices` + - `build_index_devices` 对于其它参数，你必须重新启动 Milvus 才能使改动生效。 @@ -55,77 +52,77 @@ $ docker restart 若有任何疑问，欢迎在 GitHub 上给我们 [创建 issue](https://github.com/milvus-io/milvus/issues/new/choose) 或是 [加入 Slack 社区讨论](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)。 -### `server_config` 区域 +### Section `cluster`
| 参数 | 说明 | 类型 | 默认值 | -| ----------- | ------------------------------------------------------------ | ------- | --------- | -| `address` | Milvus 服务端监听的 IP 地址。 | String | `0.0.0.0` | -| `port` | Milvus 服务端监听的端口号，范围：(1024, 65535)。 | Integer | `19530` | -| `deploy_mode` | Milvus 部署类型。选择 `single` ，`cluster_readonly` 或 `cluster_writable`。 | DeployMode | `single` | -| `time_zone` | 使用 UTC-x 或 UTC+x 来指定时区。比如，你可以使用 `UTC+8` 来代表中国标准时间。 | Timezone | `UTC+8` | -| `web_enable` | 选择是否启用 Web 服务器。 | Boolean | `true` | -| `web_port` | Milvus 网络服务端监听的端口号，范围：(1024, 65535)。你可以使用 Milvus 网络服务端与 [Milvus RESTful API](sdk.md) 通信。 | Integer | `19121` | +| --------- | ------------------------------------------------------------ | ------- | ------- | +| `enable` | 如需与 Mishards 配合使用，请将其设为 `true`，不然就设为 `false`。 | Boolean | `false` | +| `role` | Milvus 部署角色: `rw` / `ro` | Role | `rw` |
-### `db_config` 区域 +### Section `general`
-| 参数 | 说明 | 类型 | 默认值 | -| -------------------- | ------------------------------------------------------------ | ----------- | --------------- | -| `backend_url` | 元数据存储的 URL 。使用 SQLite（单机部署） 或 MySQL（分布式集群部署）来存储元数据。
`backend_url` 的格式为：`dialect://username:password@host:port/database`。（ `dialect` 可以是 `mysql` 或 `sqlite`，取决于你是用了 MySQL 还是 SQLite 数据库。） | String | `sqlite://:@:/` | -| `preload_collection` | 定义在 Milvus 服务再次启动后，是否将之前已经导入并保存在磁盘的 collection 预加载到内存。支持全部 collection 或者部分 collection 的预加载。
若要加载所有 collection，使用 `'*'` (包含引号)；若要加载部分 collection，列出所有需要加载的 collection 名，以逗号隔开。如果无需加载 collection，请将该值留空 （ ` ` ）。 | StringList | ` ` | -| `auto_flush_interval` | Milvus 每次自动将缓存中的插入数据 flush 的时间间隔，单位为秒。如果 `auto_flush_interval` 值为0，则 Milvus 不会定时自动将数据 flush。如果缓存空间已满，Milvus 总是会自动将数据 flush，这和 `auto_flush_interval` 的值无关。 | Integer | 1 (s) | +| 参数 | 说明 | 类型 | 默认值 | +| ---------- | ------------------------------------------------------------ | -------- | --------------- | +| `timezone` | 通过 `UTC-x` 或 `UTC+x` 设定时区。 | Timezone | `UTF+8` | +| `meta_uri` | 用于存储元数据的 URI。单机版 Milvus 请使用 SQLite，分布式集群版 Milvus 请使用 MySQL。 格式： `dialect://username:password@host:port/database`。请保持 `dialect://:@:/` 的格式。 `dialect` 可以是 `sqlite` 也可以是 `mysql`。至于其他区域请填入对应的真实值。 | URI | `sqlite://:@:/` | + +
+ +### Section `network` + +
+ +| 参数 | 说明 | 类型 | 默认值 | +| -------------- | ------------------------------------------------------------ | ------- | --------- | +| `bind.address` | Milvus 服务器监听的 IP 地址。 | IP | `0.0.0.0` | +| `bind.port` | Milvus 监听的端口号. 范围： (1024, 65535) | Integer | `19530` | +| `http.enable` | 是否启用 HTTP 服务器。 | Boolean | `true` | +| `http.port` | Milvus HTTP 服务器监听的端口号。 范围： (1024, 65535)。 | Integer | `19121` | +
-### `storage_config` 区域 +### `storage` 区域
| 参数 | 说明 | 类型 | 默认值 | | -------------------- | ------------------------------------------------------------ | ----------- | --------------- | -| `primary_path` | 导入 Milvus 的向量文件、索引文件和元数据存储的首选路径。 | Path | `/var/lib/milvus` | -| `secondary_path` | 导入 Milvus 的向量文件和索引文件存储的二级路径，可以填多个，两个路径中间以分号隔开。当数据量很大，`primary_path` 指定的磁盘空间不够用时，可以设置此参数。
`primary_path` 和 `secondary_path` 平均分配导入的数据。每个路径下的数据大小 = 数据总大小 / 路径数量。请确保这些路径下文件可用的存量差不多且够用。 | Path | ` ` | -| `file_cleanup_timeout` | 从标记一个文件为 `deleted` 到该文件在磁盘被物理删除的时间差。单位为秒。范围：[0, 3600]。 | Integer | `10` (s) | +| `path` | 导入 Milvus 的向量文件、索引文件和元数据存储的路径。 | Path | `/var/lib/milvus` | +| `auto_flush_interval` | Milvus 自动将数据 flush 到硬盘的时间间隔。单位为秒。0: 不启用定期 flush。 | Integer | `1` (s) |
- -### `metric_config` 区域 +### `wal` 区域
-| 参数 | 说明 | 类型 | 默认值 | -| ------------------------- | ------------------------------ | ------- | ------------ | -| `enable_monitor` | 设置为 `true` 以启动监控功能。 | Boolean | `false` | -| `address` | 访问 Prometheus Pushgateway 的 IP 地址。 | IP | 127.0.0.1 | -| `port` | 访问 Prometheus Pushgateway 的端口号。 | Integer | `9091` | +| 参数 | 说明 | 类型 | 默认值 | +| -------------------- | ------------------------------------------------------------ | ------------ | ------- | +| `enable` | 是否开启预写式日志（write-ahead logging，WAL）。如果开启，Milvus 会将所有数据变化预先写入日志文件，之后才会执行数据操作。WAL 可以保证 Milvus 操作的原子性和持久性。 | Boolean | true | +| `recovery_error_ignore` | 在通过 WAL 执行恢复操作时，是否忽略出现错误的日志。如果设为 true，当 Milvus 重启恢复时，如果有日志出现错误，则 Milvus 会忽略出现错误的日志。如果设为 false，如果 WAL 日志中存在错误，则 Milvus 会启动失败。 | Boolean | true | +| `buffer_size` | 读取缓冲区和写入缓冲区的总大小，单位为 MB。`buffer_size` 的值必须在 `[64, 4096]` 范围内。如果你设的值超出范围，Milvus 自动使用与所设的值最接近的边界值。建议 `buffer_size` 的值要大于单次插入的数据量，以获取更好的性能。 | String | `256MB` | +| `wal_path` | 预写式日志文件路径。 | String | `/var/lib/milvus/wal ` |
-### `cache_config` 区域 +### `cache` 区域
| 参数 | 说明 | 类型 | 默认值 | | -------------------------- | ------------------------------------------------------------ | ------- | --------- | -| `cpu_cache_capacity` | 内存中用于驻留搜索数据的缓存空间，`cpu_cache_capacity` 和 `insert_buffer_size` 之和不能超过内存总量。 | Integer | `4` (GB) | -| `insert_buffer_size` | 用于数据导入的 buffer 所使用的最大内存量。`insert_buffer_size` 和 `cpu_cache_capacity` 之和不能超过内存总量。 | Integer | `1` (GB) | -| `cache_insert_data` | 设置为 `true` ，则新插入的数据会自动加载到缓存以备搜索。| Boolean | `false` | +| `cache_size` | 内存中用于驻留搜索数据的缓存空间，`cache_size` 和 `insert_buffer_size` 之和不能超过内存总量。 | String | `4GB` | +| `insert_buffer_size` | 用于数据导入的 buffer 所使用的最大内存量。`insert_buffer_size` 和 `cache_size` 之和不能超过内存总量。 | String | `1GB` | +| `preload_collection` | Milvus 服务器启动时需要预加载的集合。集合名以逗号分隔。'*' 表示预加载全部现有表格。必须用单引号或者双引号。 | StringList | N/A |
-### `engine_config` 区域 -
- -| 参数 | 说明 | 类型 | 默认值 | -| -------------------- | ------------------------------------------------------------ | ------- | ------ | -| `use_blas_threshold` | Milvus 性能调优参数。此参数必须与 `nq` 比较以确定是否触发使用 OpenBLAS 计算库的阈值。
如果 `nq` >= `use_blas_threshold` ，则使用 OpenBLAS，搜索响应时间波动较小，但搜索速度较慢。如果 `nq` < `use_blas_threshold` ，则使用 AVX 或 SSE 指令集，搜索速度明显提升，但搜索响应时间波动较大。取值范围为 >= 0. | Integer | `1100` | -| `gpu_search_threshold` | Milvus 性能调优参数。此参数必须与 `nq` 比较以确定搜索计算是否只在 GPU 上进行。
如果 `nq` >= `gpu_search_threshold` ，则搜索计算只在 GPU 上进行。如果 `nq` < `gpu_search_threshold` ，则搜索计算将在 CPU 和 GPU 上协同进行。| Integer | `1000` | -
-### `gpu_resource_config` 区域 +### `gpu` 区域 在该区域选择是否在 Milvus 里启用 GPU 用于搜索和索引创建。同时使用 CPU 和 GPU 可以达到资源的最优利用，在特别大的数据集里做搜索时性能更佳。 @@ -135,57 +132,63 @@ $ docker restart | 参数 | 说明 | 类型 | 默认值 | | ------------------ | ------------------------------------------------------------ | ------- | ---------- | -| `enable` | 选择是否在 Milvus 里启用 GPU 用于搜索和索引创建。 | Boolean | `true` | -| `cache_capacity` | 显存中用于驻留搜索数据的缓存空间，该值不能超过显存总量。 | Integer | `1` (GB) | -| `search_resources` | 定义 Milvus 里用于搜索的 GPU 资源。格式为：`gpux`，其中 `x` 是 GPU 的序号，例如 `gpu0`。 | DeviceList | `gpu0` | -| `build_index_resources` | 定义 Milvus 里用户创建索引的 GPU 资源。格式为：`gpux`，其中 `x` 是 GPU 的序号，例如 `gpu0`。 | DeviceList | `gpu0` | +| `enable` | 选择是否在 Milvus 里启用 GPU 用于搜索和索引创建。 | Boolean | `false` | +| `cache_size` | 显存中用于驻留搜索数据的缓存空间。 | String | `1GB` | +| `gpu_search_threshold` | Milvus 性能调优参数。此参数必须与 `nq` 比较以确定搜索计算是否只在 GPU 上进行。
如果 `nq` >= `gpu_search_threshold` ，则搜索计算只在 GPU 上进行。如果 `nq` 小于 `gpu_search_threshold` ，则搜索计算将在 CPU 和 GPU 上协同进行。| Integer | `1000` | +| `search_devices` | 定义 Milvus 里用于搜索的 GPU 资源。格式为：`gpux`，其中 `x` 是 GPU 的序号，例如 `gpu0`。 | DeviceList | `gpu0` | +| `build_index_devices` | 定义 Milvus 里用户创建索引的 GPU 资源。格式为：`gpux`，其中 `x` 是 GPU 的序号，例如 `gpu0`。 | DeviceList | `gpu0` |
-> 注意：在 Milvus 里，创建索引和搜索是两个独立分开的过程，可以只在 `cpu`，或同时在 `cpu` 和 `gpu` 里进行。通过将 GPU 添加至 `search_resources` 或者 `build_index_resources` 下方，你可以指定多张 GPU 来进行创建索引或搜索。 请参考下面的 YAML 示例代码： +> 注意：在 Milvus 里，创建索引和搜索是两个独立分开的过程，可以只在 `cpu`，或同时在 `cpu` 和 `gpu` 里进行。通过将 GPU 添加至 `search_devices` 或者 `build_index_devices` 下方，你可以指定多张 GPU 来进行创建索引或搜索。 请参考下面的 YAML 示例代码： - ```yaml - search_resources: +```yaml + search_devices: - gpu0 - gpu1 - build_index_resources: + build_index_devices: - gpu0 - gpu1 - ``` +``` -### `tracing_config` 区域 +### `logs` 区域
-| 参数 | 说明 | 类型 | 默认值 | +| 参数 | 说明 | 类型 | 默认值 | | -------------------- | ------------------------------------------------------------ | ------------ | ------- | -| `json_config_path` | 追踪系统配置文件的绝对路径。如果该值为空，则 Milvus 会创建一个空的追踪系统。 | Path | ` ` | +| `level` | Milvus 日志等级。必须为 `debug`、 `info`、 `warning`、 `error` 和 `fatal` 其中之一。 | String | `debug` | +| `trace.enable` | 是否开启 trace 级别日志打印。 | Boolean | `true` | +| `path` | 日志文件绝对路径。 | String | `/var/lib/milvus/logs` | +| `max_log_file_size` | 每份日志文件的最大值。范围： [512MB, 4096MB]。 | Integer | `1024MB` (MB) | +| `log_rotate_num` | Milvus 为每个日志打印级别保存的最多文件数。范围： [0, 1024]。 `0` 代表日志文件数无上限。| Integer | `0` |
-### `wal_config` 区域 + + + +### `metric_config` 区域
-| 参数 | 说明 | 类型 | 默认值 | -| -------------------- | ------------------------------------------------------------ | ------------ | ------- | -| `enable` | 是否开启预写式日志（write-ahead logging，WAL）。如果开启，Milvus 会将所有数据变化预先写入日志文件，之后才会执行数据操作。WAL 可以保证 Milvus 操作的原子性和持久性。 | Boolean | true | -| `recovery_error_ignore` | 在通过 WAL 执行恢复操作时，是否忽略出现错误的日志。如果设为 true，当 Milvus 重启恢复时，如果有日志出现错误，则 Milvus 会忽略出现错误的日志。如果设为 false，如果 WAL 日志中存在错误，则 Milvus 会启动失败。 | Boolean | true | -| `buffer_size` | 读取缓冲区和写入缓冲区的总大小，单位为 MB。`buffer_size` 的值必须在 `[64, 4096]` 范围内。如果你设的值超出范围，Milvus 自动使用与所设的值最接近的边界值。建议 `buffer_size` 的值要大于单次插入的数据量，以获取更好的性能。 | Integer | `256` (MB) | -| `wal_path` | 预写式日志文件路径。 | String | ` ` | +| 参数 | 说明 | 类型 | 默认值 | +| ------------------------- | ------------------------------ | ------- | ------------ | +| `enable` | 是否启用监听功能。 | Boolean | `false` | +| `address` | 访问 Prometheus Pushgateway 的 IP 地址。 | IP | `127.0.0.1` | +| `port` | 访问 Prometheus Pushgateway 的端口号。 范围 (1024, 65535)。 | Integer | `9091` |
-### `logs` 区域 + + + + +### `tracing_config` 区域
-| 参数 | 说明 | 类型 | 默认值 | +| 参数 | 说明 | 类型 | 默认值 | | -------------------- | ------------------------------------------------------------ | ------------ | ------- | -| `trace.enable` | 是否开启 trace 级别日志打印。 | Boolean | `true` | -| `debug.enable` | 是否开启 debug 级别日志打印。 | Boolean | `true` | -| `info.enable` | 是否开启 info 级别日志打印。 | Boolean | `true` | -| `warning.enable` | 是否开启 warning 级别日志打印。 | Boolean | `true` | -| `error.enable` | 是否开启 error 级别日志打印。 | Boolean | `true` | -| `fatal.enable` | 是否开启 fatal 级别日志打印。 | Boolean | `true` | -| `path` | 日志文件绝对路径。 | String | ` ` | -| `max_log_file_size` | 每份日志文件的最大值。范围： [1024, 4096]。 | Integer | `1024` (MB) | -| `logrotate` | Milvus 为每个日志打印级别保存的最多文件数。范围： [0, 1024]。 `0` 代表日志文件数无上限。| Integer | `0` | -
\ No newline at end of file +| `json_config_path` | 追踪系统配置文件的绝对路径。如果该值为空，则 Milvus 会创建一个空的追踪系统。 | Path | ` ` | + + + +