Flutter监控与指标收集插件 prometheus_client_shelf 的使用

prometheus_client_shelf 是一个用于在 Shelf 应用中暴露 Prometheus 指标的 Dart 包。它利用了 prometheus_client 包来实现这一功能，并提供了一个 Shelf 处理器和一些现成的中间件来简化集成过程。

使用方法

下面是一个简单的使用示例，展示了如何注册默认运行时指标、创建自定义计数器以及设置处理请求的路由：

import 'package:prometheus_client/prometheus_client.dart';
import 'package:prometheus_client/runtime_metrics.dart' as runtime_metrics;
import 'package:prometheus_client_shelf/shelf_metrics.dart' as shelf_metrics;
import 'package:prometheus_client_shelf/shelf_handler.dart';
import 'package:shelf/shelf.dart' as shelf;
import 'package:shelf/shelf_io.dart' as io;
import 'package:shelf_router/shelf_router.dart';

void main() async {
  // 注册默认的运行时指标
  runtime_metrics.register();

  // 创建一个名为 'greetings_total' 的计数器
  final greetingCounter = Counter(
    name: 'greetings_total',
    help: 'The total amount of greetings',
  )..register();

  final app = Router();

  // 定义 '/hello' 路由，每次访问时增加计数器
  app.get('/hello', (shelf.Request request) {
    greetingCounter.inc();
    return shelf.Response.ok('hello-world');
  });

  // 设置 '/metrics' 路由以暴露指标
  app.get('/metrics', prometheusHandler());

  var handler = const shelf.Pipeline()
      // 注册一个中间件来追踪请求时间
      .addMiddleware(shelf_metrics.register())
      .addHandler(app.handler);

  var server = await io.serve(handler, 'localhost', 8080);
  
  print('Serving at http://${server.address.host}:${server.port}');
}

更完整的示例

这里有一个更复杂的例子，包括了更多类型的度量（如 Gauge）以及错误处理：

import 'dart:math';
import 'package:prometheus_client/prometheus_client.dart';
import 'package:prometheus_client/runtime_metrics.dart' as runtime_metrics;
import 'package:prometheus_client_shelf/shelf_handler.dart';
import 'package:prometheus_client_shelf/shelf_metrics.dart' as shelf_metrics;
import 'package:shelf/shelf.dart' as shelf;
import 'package:shelf/shelf_io.dart' as io;
import 'package:shelf_router/shelf_router.dart';

void main() async {
  runtime_metrics.register();

  // 创建带有标签的 Gauge 来记录最后访问的时间
  final timeGauge = Gauge(
    name: 'last_accessed_time',
    help: 'The last time the hello endpoint was accessed',
    labelNames: ['endpoint'],
  )..register();

  // 创建不带标签的 Gauge 来存储最后一次掷骰子的结果
  final rollGauge = Gauge(
    name: 'roll_value',
    help: 'The last roll value',
  )..register();

  // 创建一个计数器
  final greetingCounter = Counter(
    name: 'greetings_total',
    help: 'The total amount of greetings',
  )..register();

  final app = Router();

  app.get('/hello', (shelf.Request request) {
    timeGauge.labels(['hello']).setToCurrentTime();
    greetingCounter.inc();
    return shelf.Response.ok('hello-world');
  });

  app.get('/roll', (shelf.Request request) {
    timeGauge.labels(['roll']).setToCurrentTime();
    final value = Random().nextDouble();
    rollGauge.value = value;
    return shelf.Response.ok('rolled $value');
  });

  // 提供 /metrics 路径来获取所有度量数据
  app.get('/metrics', prometheusHandler());

  // 默认处理未匹配到的路径
  app.all('/<ignored|.*>', (shelf.Request request) {
    return shelf.Response.notFound('Not Found');
  });

  var handler = const shelf.Pipeline()
      .addMiddleware(shelf_metrics.register()) // 添加追踪请求时间和状态码的中间件
      .addMiddleware(shelf.logRequests())      // 添加日志中间件
      .addHandler(app);

  var server = await io.serve(handler, 'localhost', 8080);

  print('Serving at http://${server.address.host}:${server.port}');
}

通过上述代码，你可以启动一个服务器并访问 http://localhost:8080/metrics 来查看当前应用的所有 Prometheus 指标。这个包非常适合需要对 Dart/Flutter 后端服务进行性能监控的应用场景。