如何为ServiceStack应用配置Prometheus指标？遇CORS及启动错误

问题背景 #

我按照.NET Core应用的配置方法实现了Prometheus指标导出，但把相同逻辑移到ServiceStack应用里时，访问/metrics端点触发CORS错误，启动服务器还抛异常，明显这套配置在ServiceStack里行不通，求正确的配置步骤。

一、适配ServiceStack的Prometheus配置步骤 #

1. 安装必要的NuGet包 #

• 先装Prometheus.Net.AspNetCore（核心的指标导出包）
• 如果需要更贴合ServiceStack的集成，也可以试试ServiceStack.Metrics.Prometheus，没有的话用基础包自己适配也完全没问题

2. 注意中间件注册顺序 #

ServiceStack会接管大部分路由，所以必须在注册ServiceStack中间件之前先注册Prometheus的中间件，不然/metrics端点会被ServiceStack拦截。示例代码（以.NET 6+的Program.cs为例）：

var builder = WebApplication.CreateBuilder(args);

// 第一步：先注册Prometheus相关服务
builder.Services.AddMetricServer();
builder.Services.AddHttpContextAccessor();

// 第二步：再配置ServiceStack
builder.Services.AddServiceStack(typeof(MyAppHost).Assembly);

var app = builder.Build();

// 先启用Prometheus的指标端点
app.UseMetricServer();

// 再启动ServiceStack
app.UseServiceStack(new MyAppHost());

app.Run();

3. 解决CORS问题 #

ServiceStack有自己的CORS处理逻辑，ASP.NET Core的CORS中间件管不了ServiceStack接管的路径，得这么配置：
在你的ServiceStack AppHost类里，把/metrics加入CORS允许的路径列表：

public class MyAppHost : AppHostBase
{
    public MyAppHost() : base("你的ServiceStack应用名", typeof(你的服务类).Assembly) {}

    public override void Configure(Container container)
    {
        // 配置CORS，把/metrics加进去
        Plugins.Add(new CorsFeature(
            allowOriginWhitelist: new[] { "http://你的前端域名.com" },
            allowMethods: "GET,POST,PUT,DELETE,OPTIONS",
            allowHeaders: "Content-Type,Authorization",
            allowCredentials: true,
            allowedPaths: new[] { "/metrics", "/api/*" } // 关键：加入/metrics路径
        ));

        // 其他ServiceStack配置...
    }
}

要是测试环境想简单点，allowedPaths可以直接设成new[] { "*" }，但生产环境别这么搞，不安全。

4. 收集ServiceStack专属指标（可选） #

如果想统计ServiceStack的请求量、响应时间这些指标，可以自己加个过滤器：

public override void Configure(Container container)
{
    // 先创建一个请求计数的指标
    var requestCounter = Metrics.CreateCounter("servicestack_requests_total", "ServiceStack请求总次数", 
        new CounterConfiguration
        {
            LabelNames = new[] { "service", "operation" }
        });

    // 用ServiceStack的全局请求过滤器收集指标
    GlobalRequestFilters.Add((req, res, dto) =>
    {
        var operationName = req.OperationName;
        requestCounter.WithLabels(req.ServiceName, operationName).Inc();
    });
}

二、常见错误排查 #

• 启动报错：大概率是你把Prometheus中间件注册在ServiceStack之后了，ServiceStack会把所有路由都接管，Prometheus的/metrics端点根本注册不进去。
• CORS错误：检查ServiceStack的CorsFeature里有没有包含/metrics路径，ASP.NET Core的CORS中间件对ServiceStack的路径不起作用。

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