配置config.xml参数

本文介绍了修改云数据库ClickHouse集群config.xml配置文件中全局参数的方法。

背景信息

云数据库ClickHouse集群有若干参数,参数默认值通常配置在config.xmluser.xml,您可以修改参数进行实例优化,其中:

  • user.xml配置文件:您可以通过set global命令修改相关参数值,修改后无需重启,详情请参见user.xml参数修改

  • config.xml配置文件:您可以通过控制台修改相关参数值,请参见本文提示进行修改。

注意事项

  • 若集群为社区版,只有20211201日之后创建才支持XML模式配置参数和修改历史的功能。

  • 企业版集群,不支持XML模式配置参数。

  • XML模式不支持删除参数,XML模式与默认模式支持的配置参数相同。

  • 修改的参数中如果包含需要重启生效的参数,集群会在完成参数修改后自动重启。请先确认重启目标集群不会对业务产生影响,再提交参数。

集群影响

云数据库ClickHouse集群状态为配置变更中时,只能查看集群信息,无法进行升配、扩容和缩容等操作。

修改参数

不同版本的集群,修改参数的操作有所不同。

重要

如果您需要修改prometheus.porttext_log的参数,务必阅读重要参数说明

企业版

  1. 登录云数据库ClickHouse管理控制台

  2. 在页面左上角,选择目标集群所在的地域。

  3. 集群列表页面,选择企业版实例列表,单击目标集群ID。

  4. 在左侧导航栏,单击参数管理

  5. 单击运行参数值列中的修改按钮参数编辑按钮,进入参数编辑状态,您可以根据提示的输入范围,输入参数值,并点击确定,或单击取消退出参数编辑状态。

    参数编辑 单击确定

  6. 修改所有目标参数后,点击页面右上角的提交参数

  7. 在弹出保存配置对话框中,仔细审阅参数修改前后的值,确认修改内容,并填写变更原因后,单击提交参数

    重要

    如果提交的参数中包含需要重启生效的参数,ClickHouse将会在完成参数修改后自动重启集群。请先确认重启目标ClickHouse集群不会对业务产生影响后。

    提交参数后,系统将自动校验参数值。如果参数值设置不合法,将弹出错误提示框。当ErrorCode102时,说明输入的参数值不合法,请返回修改参数值在输入范围内后重新提交。

社区版

  1. 登录云数据库ClickHouse管理控制台

  2. 在页面左上角,选择目标集群所在的地域。

  3. 集群列表页面,选择社区版集群列表,单击目标集群ID。

  4. 在左侧导航栏,单击参数配置

  5. 参数配置页面,单击配置页签。选择默认模式XML模式,修改参数。

    重要

    prometheus.port 参数在云数据库ClickHouse控制台进行了限制范围,您只能填写21823000的端口。

    • 默认模式:单击运行参数值列中的修改按钮参数编辑按钮,进入参数编辑状态,您可以根据提示的输入范围,输入参数值,并点击确定,或单击取消退出参数编辑状态。

      参数编辑 单击确定

    • XML模式:单击页面右上角编辑按钮,进入文件修改状态,修改目标参数。

  6. (可选)勾选页面右上方的只显示已修改过的参数,参数列表页面仅展示修改过但未提交的参数。

    只显示修改参数

  7. 修改所有目标参数后,点击页面右上角的提交参数

  8. 在弹出保存配置对话框中,仔细审阅参数修改前后的值,确认修改内容,并填写变更原因后,单击提交参数

    重要

    如果提交的参数中包含需要重启生效的参数,ClickHouse将会在完成参数修改后自动重启集群。请先确认重启目标ClickHouse集群不会对业务产生影响后。

    提交参数后,系统将自动校验参数值。如果参数值设置不合法,将弹出错误提示框。当ErrorCode102时,说明输入的参数值不合法,请返回修改参数值在输入范围内后重新提交。

撤销修改

说明
  • 撤销修改只支持未提交的已修改参数。

  • 社区版集群的XML模式与企业版集群,仅支持撤销全部参数值的修改。

修改参数后,如果您需要撤销修改,请在提交参数之前,执行以下操作:

  • 撤销单个参数值的修改:单击参数值后面撤销图标按钮,云数据库ClickHouse将会撤销单条已修改但未提交的参数值,显示为修改前的参数值。

  • 撤销全部参数值的修改:单击参数列表右上角的撤销按钮,云数据库ClickHouse将会撤销全部已修改但未提交的参数值,显示为修改前的参数值。

查看修改历史

  1. 登录云数据库ClickHouse控制台

  2. 在页面左上角,选择目标集群所在的地域。

  3. 集群列表页面,选择集群列表类型,单击目标集群ID。

    • 企业版集群选择企业版集群列表

    • 社区版集群选择社区版集群列表

  4. 在左侧导航栏,单击参数配置参数管理

  5. 参数配置参数管理页面,选择修改历史页签,通过以下两种方式查看历史修改记录。

    • 单击307,查看近30天或近7天的历史修改记录。

    • 选择开始和结束时间,单击查询,可以查看指定时间范围内的历史修改记录。

    image

    重要参数说明

    • prometheus.port参数在云数据库ClickHouse控制台进行了限制范围,您只能填写21823000的端口。

    • 部分版本集群未开启text_logtext_log.level太低,如您需查看text_log,请根据自己需求设置text_log.level参数:

      参数值

      描述

      适用场景

      trace

      最详细的日志级别,它会记录所有的操作和事件。

      追踪程序的执行流程,开发和调试过程。

      debug

      它包含了在开发过程中可能需要的详细信息,但相比于 trace 级别,它的冗长程度较低。通常情况下,它会记录函数的调用、变量的状态等相关信息。

      调试程序。

      information

      用于记录系统的正常操作和状态信息,例如启动服务、完成某项任务等。该信息通常表明系统处于正常运行状态,且未发生错误。

      warning

      表示潜在的问题或非致命性错误。尽管系统仍在正常运行,但可能存在值得关注的情况。

      监控系统,分析潜在问题,进而优化系统。

      error

      表示系统出现了错误,已对系统的某些功能或操作产生影响。尽管系统可能仍在正常运行,但需及时关注并处理这些错误。

      监控系统,分析已发生的错误,便于解决问题。