Koa 로그 미들웨어 캡슐화 및 개발 방법 소개

이 글에서는 일정한 참고 가치를 지닌 Koa 로그 미들웨어를 캡슐화하고 개발하는 방법을 소개합니다. 참고하실 수 있으니 도움이 되셨으면 좋겠습니다.

서버 애플리케이션의 경우 로그 기록은 필수입니다. 프로젝트 프로그램이 매일 무엇을 하는지, 언제 오류가 발생했는지, 어떤 오류가 발생했는지 등을 기록해야 합니다. 향후 서버의 가동상태를 실시간으로 파악하여 문제시나리오를 복원해 드립니다.

로그의 역할

서버 프로그램의 실행 상태를 기록하여 개발자가 신속하게 오류를 포착하고 결함을 찾아 해결하도록 돕습니다.

로그 미들웨어 개발 도구 log4js

노드에 내장된 로그 모듈이 없으므로 타사 모듈을 사용해야 합니다: log4js 설치: npm i log4js -Slogsjs 공식 문서

로그 카테고리:

액세스 로그: 프로젝트에 대한 클라이언트의 액세스(주로 http 요청)를 기록합니다. 웹 사이트의 성능과 사용자 경험을 개선하고 향상시키는 데 사용됩니다. 애플리케이션 로그: 프로젝트의 실행 상태를 쿼리하고 버그(디버그, 정보 포함)를 쉽게 찾을 수 있도록 비정상적인 상황을 포함하여 프로젝트 표시 및 기록 위치로 인쇄된 로그입니다. , 경고 및 오류 등 수준).

로그 레벨

로그 레벨을 설정하면 설정된 로그 레벨보다 높은 레벨의 로그 정보만 기록할 수 있습니다

#🎜 🎜 #

레벨: 'error'가 구성되면 오류, 파타르, 마크 레벨 로그 정보만 출력됩니다

로그 미들웨어 개발#🎜🎜 #

기록해야 하는 정보 세그먼트 설정(log_info.js)

export default (ctx, message, commonInfo) => {
    const {
      method,  // 请求方法
      url,          // 请求链接
      host,      // 发送请求的客户端的host
      headers      // 请求中的headers
    } = ctx.request;
    const client = {
      method,
      url,
      host,
      message,
      referer: headers['referer'],  // 请求的源地址
      userAgent: headers['user-agent']  // 客户端信息 设备及浏览器信息
    }
    return JSON.stringify(Object.assign(commonInfo, client));
}

범용 획득 구성 log4js 개체 설정(logger.js)

#🎜 🎜 #

const getLog = ({env, appLogLevel, dir}, name) => {
    
    //log4js基本说明配置项，可自定义设置键名，用于categories.appenders自定义选取
    let appenders = {
        // 自定义配置项1
        cheese: {
            type: 'dateFile', //输出日志类型
            filename: `${dir}/task`,  //输出日志路径
            pattern: '-yyyy-MM-dd.log', //日志文件后缀名（task-2019-03-08.log）
            alwaysIncludePattern: true
        }
    }
    // 如果为开发环境配置在控制台上打印信息
    if (env === "dev" || env === "local" || env === "development") {
        // 自定义配置项2
        appenders.out = {
          type: "stdout"
        }
    }
    // log4js配置
    let config = {
        appenders,
        //作为getLogger方法获取log对象的键名，default为默认使用
        categories: {
          default: {
            appenders: Object.keys(appenders), // 取appenders中的说有配置项
            level: appLogLevel
          }
        }
    }
    log4js.configure(config) //使用配置项
    return log4js.getLogger(name)// 这个cheese参数值先会在categories中找，找不到就会默认使用default对应的appenders,信息会输出到yyyyMMdd-out.log
}

1. log 로그 미들웨어 개발(logger.js)

export default (options) => {
    const contextLogger = {}; //后期赋值给ctx.log
    const { env, appLogLevel, dir, serverIp, projectName } = Object.assign({}, baseInfo, options || {});
    // 取出通用配置（项目名，服务器请求IP）
    const commonInfo = { projectName, serverIp };

    const logger = getLog({env, appLogLevel, dir},'cheese');

    return async (ctx, next) => {
        const start = Date.now(); //日志记录开始时间
        // 将日志类型赋值ctx.log，后期中间件特殊位置需要记录日志，可直接使用ctx.log.error(err)记录不同类型日志
        methods.forEach((method, i) => {
            contextLogger[method] = (message) => {
                logger[method](logInfo(ctx, message, commonInfo))
            }
        })
        ctx.log = contextLogger;
        // 执行中间件
        await next()
        // 结束时间
        const responseTime = Date.now() - start;
        // 将执行时间记录logger.info
        logger.info(logInfo(ctx,
            {
                responseTime: `响应时间为${responseTime/1000}s`
            }, commonInfo)
        )
    }
}

1. 미들웨어 사용(app.js)

# 🎜 🎜#

import Log from '../log/logger';
...
app.use(Log({
        env: app.env,  // koa 提供的环境变量
        projectName: 'back-API',
        appLogLevel: 'debug',
        dir: 'logs',
        serverIp: ip.address()
    }))

1. 다른 특수 위치는

ctx.log.error(err.stack); //记录错误日志
ctx.log.info(err.stack); // 记录信息日志
ctx.log.warn(err.stack); // 记录警告日志
...

1. 스크린샷 실행

을 사용하여 기록해야 합니다.

log4js는 기본 구성 및 프로세스 분석을 사용합니다.

구성 항목 설정,

// 配置项形式
{
    appenders:{
        [自定义key]:{}
    },
    categories:{
    }
}
// 配置
config: {
    appenders:{
        // 每一个属性可以看作为一个配置模块
        out: {
            type: 'dateFile', //输出日志类型
            filename: `log/task`,  //输出日志路径
            pattern: '-yyyy-MM-dd.log', //日志文件后缀名（task-2019-03-08.log）
            ...//具体配置看官网
        },
        error: {
            type: 'dateFile',
            filename: 'log/error',
            pattern: '-yyyy-MM-dd.log'',
            "alwaysIncludePattern": true
        },
        stdout: { type: 'stdout' }, //在控制台上打印信息
    },
    // 通过categories来取出给log4js按需配置，返回配置后的log4js对象，每个属性配置相当于一个不同的log4js配置对象入口；default为默认入口（getLogger（）找不到入口时默认使用default）
    categories:{
        // 配置默认入口，使用appenders中的'stdout','out'配置模块，记录trace以上等级日志
        default: { appenders: ['stdout','out'], level: 'trace' },
        // 配置error门入口，使用appenders中的'stdout','err'配置模块，记录error以上等级日志
        error : {appenders: ['err'], level: 'error'}
    }
}

Let 사용 logger_out = log4js.getLogger('app');
1. log4js.getLogger('app') 특정 log4js 객체 찾기 프로세스: 먼저 앱 매개변수 값에 따라 카테고리를 검색하고 거기에 있는 것을 찾습니다. 앱이 없으면 기본적으로 default에 해당하는 어펜더가 구성에 사용됩니다. 즉, 정보는 log/task-yyyy-mm-dd.log 파일에 출력되고 콘솔에 출력됩니다. # 🎜🎜#

let logger_out = log4js.getLogger( 'error');

Error 매개변수 값을 기준으로 카테고리를 살펴보고 오류 구성이 없는지 확인하세요. 오류에 해당하는 정보는 구성에 사용됩니다. 즉, 정보는 log/error-yyyy-에 출력됩니다. mm-dd.log 파일에서는 오류 구성 항목 어펜더에 stdout 모듈이 사용되지 않기 때문에 정보가 콘솔에 출력되지 않습니다

나중에 고려

로그 업데이트 여부 로그 기록을 영원히 저장하는 것이 불가능하다는 점을 고려하여 데이터베이스 저장 및 로그 지속성을 수행합니다. , 한 달 또는 일주일 전의 로그를 저장할 필요가 없을 수도 있습니다. 만료된 로그 파일을 정기적으로 자동 삭제하도록 설정하는 것이 필요합니다(데이터베이스 로그 기록 확보)

#🎜 🎜#

위 내용은 Koa 로그 미들웨어 캡슐화 및 개발 방법 소개의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!