Gatus自定义告警中的JSON编码问题解析

在监控系统Gatus中，自定义告警功能允许用户通过webhook发送告警信息。然而，近期用户报告了一个关于JSON编码的问题，特别是在告警消息体中使用占位符时会出现格式错误。

问题背景

当用户在Gatus配置文件中定义自定义告警时，通常会使用类似以下的YAML配置：

alerting:
  custom:
    url: "https://webhook.example.com/webhook"
    headers:
      "Content-Type": "application/json"
    method: "POST"
    body: |
      {
        "message": "[ALERT_TRIGGERED_OR_RESOLVED]: [ENDPOINT_GROUP] - [ENDPOINT_NAME] - [ALERT_DESCRIPTION] - [RESULT_ERRORS]"
      }

具体问题

主要问题出现在[RESULT_ERRORS]占位符上。当这个占位符被替换为实际内容时，如果内容中包含双引号(")，会导致生成的JSON格式不正确。例如：

{
  "message": "[ALERT_TRIGGERED]: example-group - example-endpoint - Connection failed - "error: connection refused""
}

可以看到，错误信息中的双引号没有被转义，导致整个JSON结构被破坏，webhook接收端无法正确解析。

技术分析

这个问题本质上是一个JSON编码问题。在构建JSON消息体时，所有字符串值中的特殊字符（如双引号、反斜杠等）都应该被正确转义。Gatus最初版本中直接进行了字符串替换而没有进行适当的编码处理。

解决方案

项目维护者已经通过PR #1095修复了双引号的问题。这个修复确保了[RESULT_ERRORS]占位符中的双引号会被正确转义，生成的JSON格式将保持有效。

然而，从技术角度看，更健壮的解决方案应该是使用Go语言内置的JSON编码器来构建整个消息体，而不是手动拼接JSON字符串。这样可以确保所有特殊字符都被正确处理，而不仅仅是双引号。

最佳实践建议

对于使用Gatus自定义告警功能的用户，建议：

1. 确保使用最新版本的Gatus，以获得对双引号问题的修复
2. 如果需要在告警消息中包含用户提供的内容，考虑使用更结构化的消息格式
3. 对于复杂的告警需求，可以考虑在webhook接收端进行额外的格式验证和错误处理

总结

JSON编码问题是Web开发中常见的问题之一。Gatus通过最近的更新解决了自定义告警中的双引号转义问题，为用户提供了更可靠的告警通知功能。理解这类编码问题的本质有助于开发者在构建类似系统时避免常见陷阱。