Gravitee.io如何修复maxClauseCount is set to 1024错误

直接修改Elasticsearch服务端elasticsearch.yml中的index.query.bool.max_clause_count配置不生效的核心原因：Gravitee访问Elasticsearch的Java客户端内置了独立的maxClauseCount校验逻辑，默认阈值为1024，该校验在请求发送到ES服务端之前就会触发，服务端配置无法覆盖客户端侧的校验规则。当平台注册API数量较多，筛选、分页、全量拉取等场景生成的bool查询子句数超过阈值时，就会抛出对应报错。

根据实际部署方式选择对应操作即可，注意Management API和Gateway两个组件都需要修改配置，两个组件会独立发起ES查询。

二进制/安装包部署 #

• 进入Gravitee各节点的配置目录，默认路径为${GRAVITEE_HOME}/config/
• 编辑gravitee.yml文件，在Elasticsearch配置段下新增如下配置，原有ES连接、索引前缀等配置保持不变：

elasticsearch:
  # 原有ES配置保留
  settings:
    index:
      query:
        bool:
          max_clause_count: 10240

• 修改完成后重启Management API和Gateway服务即可。

Docker/Docker Compose部署 #

• 无需进入容器修改内部文件，直接给gio_apim_management_api、gio_apim_gateway两个服务注入环境变量即可：

GRAVITEE_ELASTICSEARCH_SETTINGS_INDEX_QUERY_BOOL_MAX_CLAUSE_COUNT=10240

• Compose部署场景下把上述环境变量加到对应服务的environment配置段，重建容器即可生效。

Kubernetes Helm部署 #

• 在Helm的values.yaml中为两个组件添加对应环境变量：

management-api:
  extraEnv:
    - name: GRAVITEE_ELASTICSEARCH_SETTINGS_INDEX_QUERY_BOOL_MAX_CLAUSE_COUNT
      value: "10240"
gateway:
  extraEnv:
    - name: GRAVITEE_ELASTICSEARCH_SETTINGS_INDEX_QUERY_BOOL_MAX_CLAUSE_COUNT
      value: "10240"

• 执行helm upgrade更新发布，等待Pod滚动重启完成即可。

注意：

• 阈值设置为10240足够覆盖绝大多数多API场景，不要设置过大，避免单查询拼接过多子句占用大量堆内存，引发ES OOM或Gravitee服务长时间GC停顿。
• 如果你使用的是3.x及更早版本的Gravitee，配置不需要嵌套settings段，直接将index.query.bool.max_clause_count: 10240写在elasticsearch配置层级下即可。
• 验证生效可以直接触发之前报错的查询操作，观察服务日志无新的maxClauseCount相关报错即为配置成功。

内容的提问来源于stack exchange，提问作者Jason Regex