SQL Server First Responder Kit中sp_BlitzCache在SSMS 19.3下的XML解析问题分析

问题现象

在使用SQL Server First Responder Kit中的sp_BlitzCache存储过程时，当运行环境为SQL Server Management Studio (SSMS) 19.3版本时，会出现执行失败的情况。具体表现为：

1. 当执行sp_BlitzCache @databasename='db_name'时，过程返回6行数据后停止，并报错：

   Unexpected XML declaration. The XML declaration must be the first node in the document, and no white space characters are allowed to appear before it. Line 9, position 1717.
   

2. 相同操作在SSMS 18.8和17.9.1版本下可以正常返回10行数据。

环境信息

• SQL Server版本：Microsoft SQL Server 2019 (RTM-CU24) (KB5031908) - 15.0.4345.5
• 操作系统：Windows Server 2016 Datacenter
• 问题版本：SSMS 19.3
• 正常版本：SSMS 18.8和17.9.1

问题分析

初步排查

1. XML数据大小设置：尝试在SSMS中调整XML数据大小设置为Unlimited，问题依旧存在。而旧版SSMS中XML数据限制为2MB却能正常工作。

2. 参数测试：

   • 不带@databasename参数执行：可以正常完成
   • 使用@SkipAnalysis = 1参数：可以返回数据（但缺少分析部分）
   • 使用@OnlyQueryHashes参数：出现不同的截断错误
   • 使用@OnlySqlHandles和@debug=1参数：重现原始错误

根本原因

问题出现在处理特定存储过程的执行计划XML时。在SSMS 19.3中，XML解析器对执行计划XML的格式要求更为严格，特别是：

1. XML声明必须位于文档的最开始位置
2. XML声明前不允许有任何空白字符

当sp_BlitzCache尝试解析包含大型存储过程执行计划的XML时，SSMS 19.3的XML解析器会因格式问题而失败。

解决方案

根据测试结果，有以下几种可行的解决方案：

1. 使用SkipAnalysis参数：

   EXEC sp_BlitzCache @databasename='db_name', @SkipAnalysis = 1
   

   这会跳过详细的执行计划分析，仅返回基本查询信息。

2. 降级SSMS版本： 暂时使用SSMS 18.8或17.9.1版本执行sp_BlitzCache。

3. 限制返回结果：

   EXEC sp_BlitzCache @databasename='db_name', @top=5
   

   减少返回结果数量可能避免处理有问题的执行计划。

技术建议

对于长期解决方案，建议：

1. 检查执行计划XML格式：确保从SQL Server获取的执行计划XML格式符合标准，特别是XML声明位置。

2. 错误处理增强：在sp_BlitzCache中添加对XML解析错误的捕获和处理逻辑，避免过程完全失败。

3. SSMS兼容性测试：在多个SSMS版本上进行全面测试，确保存储过程的兼容性。

总结

这个问题展示了不同SSMS版本在XML处理上的差异，特别是在处理大型执行计划时的行为变化。作为DBA，在升级SSMS时需要注意这类兼容性问题，特别是依赖XML解析的工具和脚本。目前可以通过参数调整或版本回退来规避问题，长期则需要考虑代码层面的兼容性改进。