.NET 9中HealthChecksUI描述字段文本格式化方法咨询

• 开启HTML描述渲染
  HealthChecksUI默认会转义描述里的HTML内容，要让换行生效，首先得开启HTML支持。在返回健康检查结果时，把每个失败的作业信息用<br>标签分隔，同时在配置中允许HTML渲染。

  示例健康检查实现：

  public class SqlAgentJobHealthCheck : IHealthCheck
  {
      public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
      {
          // 替换为实际获取失败作业的逻辑
          var failedJobs = new List<string> 
          { 
              "作业A: 执行脚本时抛出异常", 
              "作业B: 数据库连接超时" 
          };
          // 用<br>分隔每个失败项
          var formattedDescription = string.Join("<br>", failedJobs);
  
          return HealthCheckResult.Unhealthy(formattedDescription);
      }
  }
  

  在Program.cs中配置HealthChecksUI时开启HTML支持：

  builder.Services.AddHealthChecksUI(options =>
  {
      options.SetEvaluationTimeInSeconds(30);
      options.MaximumHistoryEntriesPerEndpoint(60);
      // 关键配置：允许描述字段渲染HTML
      options.AllowHtmlDescription = true;
      // 若需要自定义样式，可添加自定义CSS
      options.AddCustomStylesheet("wwwroot/css/custom-healthchecks.css");
  })
  .AddInMemoryStorage();
  

• 自定义CSS强化换行效果
  若开启HTML后仍有样式问题，添加自定义CSS文件（如wwwroot/css/custom-healthchecks.css），强制描述区域的换行规则：

  .health-check-description {
      white-space: pre-line !important;
      line-height: 1.5;
  }
  

• 验证生效
  启动项目后，HealthChecksUI的描述区域会自动解析<br>标签，每个失败的作业信息会单独显示在一行。

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