📣 极限科技诚招搜索运维工程师(Elasticsearch/Easysearch)- 全职/北京 👉 : 立即申请加入

适用版本: 6.8-8.9

1. 错误异常的基本描述 #

could not parse slack message. unknown field [field] 是 Elasticsearch Watcher 在解析 Slack 消息配置时抛出的异常。当 Slack 消息对象中出现当前解析器不支持的字段时,就会触发此错误。

此错误通常发生在 Slack action 的 message 对象中,表示消息对象里包含了解析器不接受的字段。

常见现象 #

  • 创建或更新 watch 时返回 HTTP 400 错误。
  • 报错信息明确指出哪个字段是未知的(unknown field [field])。
  • 常见于手动编写 Slack action 配置时,或从不同版本的配置示例复制粘贴时。
  • 如果字段名拼写错误或把 attachment 级字段误放进 message 对象,就容易触发此错误。

典型报错与异常栈 #

{
  "error": {
    "root_cause": [
      {
        "type": "parse_exception",
        "reason": "could not parse slack message. unknown field [invalid_field]"
      }
    ],
    "type": "parse_exception",
    "reason": "could not parse slack message. unknown field [invalid_field]"
  },
  "status": 400
}

服务端日志中可能出现类似以下内容:

[2024-01-15T10:30:00,123][WARN ][o.e.x.w.a.s.SlackAction ] [node-1] failed to parse slack message
ElasticsearchParseException[could not parse slack message. unknown field [invalid_field]]
    at org.elasticsearch.xpack.watcher.actions.slack.SlackMessage.parse(SlackMessage.java:145)
    at org.elasticsearch.xpack.watcher.actions.slack.SlackAction.parse(SlackAction.java:89)

2. 为什么会发生这个错误 #

Watcher 的 Slack message parser 只识别有限字段(如 tofromtextattachmentsdynamic_attachments 等)。若当前字段未命中任何分支,就会抛出 unknown field 异常。

根因通常包括:

  • 使用了错误字段名:例如将 text 误写为 contentmessage 等。
  • 把 attachment 或 action 级字段误放进 message 对象:例如把 attachments 的字段直接放到 message 对象里。
  • 参考了不同版本或第三方示例中的非兼容字段:Slack API 支持的字段可能比 Watcher 解析器支持的更多。
  • JSON 结构嵌套错误:字段放错了层级。
  • 模板渲染问题:使用 Mustache 或 script 模板时,渲染结果可能包含不支持的字段。

3. 如何排查和解决这个异常和解决这个异常 #

排查步骤 #

  1. 找到 watch 中的 Slack action:定位到 actions.<action_name>.slack.message 对象。

  2. 检查 message 对象里的字段是否全部属于当前版本支持集合

# 获取 watch 配置
GET _watcher/watch/<watch_id>?pretty

# 检查 Slack action 的 message 部分
  1. 对照官方文档验证字段合法性:确认该字段是否在当前版本的 Slack message 支持列表中。

  2. 若异常字段应属于 attachment 或 dynamic_attachments,移回正确位置

# 正确的 Slack message 结构示例
PUT _watcher/watch/<watch_id>
{
  "actions": {
    "send_slack": {
      "slack": {
        "message": {
          "to": ["#alerts"],
          "from": "Watcher",
          "text": "Elasticsearch Alert: {{ctx.payload.hits.total}} hits",
          "attachments": []
        }
      }
    }
  }
}

合法的 message 字段包括:

  • to - 接收者(字符串或数组)
  • from - 发送者(字符串)
  • text - 消息文本(字符串)
  • attachments - 附件数组
  • dynamic_attachments - 动态附件

排查时需要注意的问题 #

  • 注意区分 message 级别字段和 attachment 级别字段:它们支持的字段集合不同。
  • 如果使用了 attachments 字段,确保它是一个数组,且每个元素包含合法的 attachment 字段。
  • 检查是否有从 Slack API 文档直接复制过来的字段,这些字段在 Watcher 的 Slack message 中可能不支持。

4. 如何解决这个错误 #

常用修复思路 #

  1. 删除未知字段:从 message 对象中移除不支持的字段。
# 修复前(包含不支持的字段)
PUT _watcher/watch/<watch_id>
{
  "actions": {
    "send_slack": {
      "slack": {
        "message": {
          "to": "#alerts",
          "text": "Alert",
          "invalid_field": "some value"  # 不支持的字段
        }
      }
    }
  }
}

# 修复后(移除不支持的字段)
PUT _watcher/watch/<watch_id>
{
  "actions": {
    "send_slack": {
      "slack": {
        "message": {
          "to": "#alerts",
          "text": "Alert"
        }
      }
    }
  }
}
  1. 将字段移动到正确层级
# 如果字段应该属于 attachment
# 错误:放在 message 中
"message": {
  "to": "#alerts",
  "title": "Alert Title"  # 错误位置,title 应该属于 attachment
}

# 正确:title 应该属于 attachment
"message": {
  "to": "#alerts",
  "attachments": [
    {
      "title": "Alert Title",  # 正确位置
      "text": "Alert message"
    }
  ]
}
  1. 在程序拼装 Slack 消息时固定 schema,避免自由扩展字段。

后续注意事项与推荐建议 #

  • 在编写 Slack message 配置时,严格参照官方文档中的字段列表。
  • 建立配置模板库,复用经过验证的配置片段。
  • 在测试环境验证 Slack 配置,特别是在从其他来源复制配置时。

借助 INFINI 产品提升排障效率 #

  • INFINI Console 提供可视化的 Watch 编辑功能,可以在保存前验证 Slack message 的字段合法性,自动检测不支持的字段。
  • INFINI Gateway 可以记录 Watcher action 的完整请求内容,帮助捕获 Slack 配置的详细错误上下文,并通过流量回放验证修复方案。
  • 通过 INFINI Console 的配置对比功能,可以对比不同版本间的配置差异,快速定位版本兼容性问题。

5. 小结 #

could not parse slack message. unknown field [field] 是一个字段合法性错误,表示 Slack 消息对象中包含了不支持的字段。解决此问题的关键是:确认报错字段名,检查字段是否应该存在于当前层级,移除不支持的字段或将字段移到正确位置。

通过 INFINI Console 的配置验证功能和 INFINI Gateway 的请求捕获能力,可以更高效地定位和修复 Slack message 的字段层级问题。

相关错误 #

参考文档 #

附:日志上下文 #

下面保留当前页面中的源码或日志片段,便于继续结合异常调用栈定位问题:

} else {
    throw new ElasticsearchParseException("could not parse slack message. unknown field [{}].", currentFieldName);
}

return builder.build();