GolangRPC拦截器实现日志与监控示例

答案：Go语言gRPC拦截器可实现日志与监控，通过UnaryServerInterceptor在请求前后记录方法名、耗时、状态码并上报Prometheus，结合server选项注册，输出结构化日志，便于观测与排错。

在Go语言的gRPC开发中，拦截器（Interceptor）是实现横切关注点（如日志记录、监控、认证等）的核心机制。通过拦截器，可以在请求处理前后插入自定义逻辑，而无需修改业务代码。下面以实现日志记录和基础监控为例，展示如何编写一个gRPC服务器端的拦截器。

1. 日志与监控拦截器设计目标

我们希望每个gRPC请求都能自动输出以下信息：

• 请求方法名
• 请求开始时间与耗时
• 请求是否成功（状态码）
• 错误信息（如有）

同时将调用耗时上报到监控系统（例如Prometheus）。

2. 实现日志与监控拦截器

使用grpc.UnaryServerInterceptor类型定义一个通用的一元拦截器函数：

立即学习“go语言免费学习笔记（深入）”；

// logger_and_monitor_interceptor.go

package main

import (

  "context"
  "log"
  "time"
  "google.golang.org/grpc"
  "google.golang.org/grpc/status"
)

// 定义拦截器函数

func LoggerAndMonitorInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {

  start := time.Now()
  log.Printf("接收请求: %s, 时间: %v", info.FullMethod, start)
  // 调用实际的处理函数
  resp, err := handler(ctx, req)
  duration := time.Since(start)
  status, _ := status.FromError(err)
  log.Printf("完成请求: %s, 耗时: %v, 状态: %s", info.FullMethod, duration, status.Code())
  // 模拟上报监控数据（实际可替换为Prometheus客户端）
  reportToMonitor(info.FullMethod, duration, status.Code())
  return resp, err
}

// 上报监控数据（简化示例）

func reportToMonitor(method string, duration time.Duration, code uint32) {

  log.Printf("[监控] 方法=%s 耗时=%vms 成功=%t", method, duration.Milliseconds(), code == 0)
  // 在真实场景中，这里可以发送到 Prometheus 或其他 APM 系统
}

3. 在gRPC服务器中注册拦截器

将自定义拦截器注册到gRPC服务器选项中：

// server.go

func main() {

  lis, err := net.Listen("tcp", ":50051")
  if err != nil {
    log.Fatalf("监听失败: %v", err)
  }
  // 创建gRPC服务器，注入拦截器
  s := grpc.NewServer(
    grpc.UnaryInterceptor(LoggerAndMonitorInterceptor),
  )
  // 注册你的服务（假设为YourService）
  // pb.RegisterYourServiceServer(s, &yourService{})
  log.Println("gRPC服务器启动在 :50051")
  if err := s.Serve(lis); err != nil {
    log.Fatalf("启动失败: %v", err)
  }
}

4. 实际效果示例

当一个gRPC请求到达时，日志输出类似：

2025/04/05 10:00:00 接收请求: /yourpackage.YourService/GetUser, 时间: 2025-04-05 10:00:00.123
2025/04/05 10:00:00 完成请求: /yourpackage.YourService/GetUser, 耗时: 15ms, 状态: OK
2025/04/05 10:00:00 [监控] 方法=/yourpackage.YourService/GetUser 耗时=15 成功=true

如果发生错误，状态码会非零，便于排查问题。

基本上就这些。这个拦截器结构清晰，易于扩展。你可以在此基础上加入追踪ID、用户身份、请求大小等信息，构建更完整的可观测性体系。

以上就是GolangRPC拦截器实现日志与监控示例的详细内容，更多请关注php中文网其它相关文章！