在Next.js项目中集成Pino日志系统的实践指南

前言

在现代Web应用开发中，日志记录系统是必不可少的基础设施。Pino作为Node.js生态中高性能的日志记录器，以其出色的性能和灵活的扩展性受到开发者青睐。本文将详细介绍如何在Next.js框架中集成Pino日志系统，并实现跨客户端和服务端的统一日志管理。

核心需求分析

在Next.js项目中集成Pino需要解决几个关键问题：

1. 环境适配：需要同时支持浏览器环境和服务器环境
2. 请求追踪：需要自动关联请求ID和用户标识
3. 日志传输：需要支持将日志发送到Logflare等日志服务
4. 统一接口：需要提供一致的API供客户端和服务器端使用

基础日志器配置

首先，我们创建一个基础日志器配置，根据环境决定是否启用Logflare集成：

import pino from 'pino';
import { createPinoBrowserSend, createWriteStream } from "pino-logflare"

// 判断是否为预览或生产环境
const isPreviewOrProduction = process.env.VERCEL_ENV === 'preview' || process.env.VERCEL_ENV === 'production';

let baseLogger: pino.Logger;

if (isPreviewOrProduction && process.env.NEXT_PUBLIC_LOGFLARE_KEY && process.env.NEXT_PUBLIC_LOGFLARE_SOURCE) {
    // 生产环境配置Logflare集成
    const stream = createWriteStream({
        apiKey: process.env.NEXT_PUBLIC_LOGFLARE_KEY,
        sourceToken: process.env.NEXT_PUBLIC_LOGFLARE_SOURCE,
    });

    const send = createPinoBrowserSend({
        apiKey: process.env.NEXT_PUBLIC_LOGFLARE_KEY,
        sourceToken: process.env.NEXT_PUBLIC_LOGFLARE_SOURCE,
    });

    baseLogger = pino({
        browser: {
            transmit: {
                level: "info",
                send: send,
            }
        },
        level: "debug",
        base: {
            env: process.env.VERCEL_ENV || process.env.NODE_ENV,
            release: process.env.NEXT_PUBLIC_APP_VERSION,
        },
    }, stream);
} else {
    // 开发环境基础配置
    baseLogger = pino({
        level: "debug",
        base: {
            env: process.env.VERCEL_ENV || process.env.NODE_ENV,
            release: process.env.NEXT_PUBLIC_APP_VERSION,
        },
    });
}

环境感知日志器工厂

为了实现在不同环境下自动适配的日志器，我们创建了一个日志器工厂函数：

const getLogger = (name: string, req?: NextRequest) => {
    if (typeof window !== "undefined") {
        // 浏览器环境处理逻辑
        const cookies = document.cookie;
        const cookieKeyValues = cookies.split(";").map((cookie) => cookie.trim().split("="));
        const posthog = cookieKeyValues.find(([key]) => key === posthogCookieName);
        let correlationId = null;
        
        if (posthog) {
            try {
                const value = JSON.parse(decodeURIComponent(posthog[1]));
                correlationId = value?.distinct_id;
            } catch (error) {
                console.error("Error parsing posthog cookie", error);
            }
        }

        return baseLogger.child({
            name,
            from: "browser",
            correlationId,
            // 添加浏览器环境特有信息
        });
    } else {
        // 服务器环境处理逻辑
        const isEdgeRuntime = typeof EdgeRuntime !== 'undefined';
        
        if (isEdgeRuntime) {
            // Edge Runtime特殊处理
            if (!req) throw new Error('Request object is required in edge runtime');
            
            const requestId = req.headers.get("x-vercel-id");
            const posthog = req.cookies.get(posthogCookieName);
            const value = JSON.parse(posthog?.value || '{}');
            
            return baseLogger.child({
                requestId,
                correlationId: value?.distinct_id,
                // 添加Edge环境特有信息
                from: "edge",
                name,
            });
        } else {
            // 标准Node.js环境处理
            const { cookies, headers } = require("next/headers");
            const posthog = cookies().get(posthogCookieName);
            const value = JSON.parse(posthog?.value || "{}");
            
            return baseLogger.child({
                name,
                from: "server",
                correlationId: value?.distinct_id,
                requestId: headers().get("x-vercel-id"),
            });
        }
    }
}

实际应用示例

在中间件中使用

const logger = getLogger('middleware', request);
logger.info({ path: request.nextUrl.pathname }, 'Middleware processing request');

在页面组件中使用

const logger = getLogger('src/app/page.tsx');
logger.info('Page component rendered');

在客户端组件中使用

"use client";
const logger = getLogger('src/components/Button.tsx');

function Button() {
    const onClick = () => {
        logger.info('Button clicked');
    };
    
    return <button onClick={onClick}>Click me</button>;
}

高级特性实现

1. 请求追踪

通过自动从请求头中提取x-vercel-id作为请求ID，实现了跨服务的请求追踪。同时从PostHog cookie中提取用户标识作为关联ID，便于分析用户行为。

2. 环境区分

日志中自动添加from字段标识日志来源（browser/edge/server），便于后期分析排查问题。

3. 上下文丰富

在浏览器环境中自动记录URL和查询参数，在服务器环境中记录请求方法和headers等信息，为问题诊断提供充分上下文。

性能优化建议

1. 日志级别控制：在生产环境中适当提高日志级别阈值，避免记录过多调试信息
2. 采样率配置：对于高流量应用，可以配置采样率避免日志量过大
3. 批量传输：浏览器环境中可以考虑实现日志批量传输，减少网络请求
4. 敏感信息过滤：确保不会记录敏感信息如密码、token等

错误处理策略

1. cookie解析容错：对cookie解析添加try-catch，避免因格式问题导致日志记录中断
2. 备用日志通道：当Logflare不可用时，应有备用日志存储方案
3. 错误边界处理：在React组件中实现错误边界，确保日志记录错误不会影响UI渲染

总结

本文介绍的Next.js+Pino集成方案实现了以下目标：

1. 统一了客户端和服务端的日志接口
2. 自动关联请求和用户上下文
3. 支持多种运行时环境（浏览器、Edge、Node.js）
4. 实现了生产环境日志服务集成
5. 提供了丰富的日志上下文信息

这种实现方式既保持了Pino的高性能特性，又适应了Next.js的全栈特性，为应用提供了强大的可观测性支持。开发者可以根据实际需求进一步扩展和定制，构建更加完善的日志监控系统。