Web開発における使いやすいログ入門

{
    "message": "HogeController.index(). finding hoge...",
    "level": "info"
}
{
    "message": "HogeService.findListById(). finding hoge...",
    "level": "info"
}
{
    "message": "HogeRepository.findListById(). finding hoge...",
    "level": "info"
}
{
    "message": "HogeRepository.findListById(). found Hoge!",
    "level": "info"
}
{
    "message": "HogeService.findListById(). found Hoge!",
    "level": "info"
}
{
    "message": "HogeController.index(). found Hoge!",
    "level": "info"
}

class HogeController {
  async index(request) {
    // 処理が始まる前にログ。
    logger.info('HogeController.index call!');
    
    // TypeScriptの書き方ではないがイメージ。例外があればcatch。
    try {
      const hoges = await HogeService.getAllHoge(request.user);
      
      // 処理が終わったらログ。
      logger.info('HogeController.index called!');
      return hoges;
      
    // geAtAllHogeがエラーを投げたら
    } catch (error) {
      // どのコントローラーかエラーログ書いてた。
      // userIdつけてるときもあれば、つけてないときもあった。
      logger.error(`Error in HogeContoller.index(). userId: ${request.userId}, error: ${error}`);
      
      // もう一度エラー投げて、フレームワークにエラーをハンドリングしてもらう。expressとかだったら next(error)。
      throw error;
    }
  }
}

class HogeService {
  async getAllHoge(requestUser){
    // 処理が始まるよというログ。
    logger.info('HogeService.getAllHoge. finding hoge... ');
    
    // なんかの条件チェック失敗したら例外投げる。
    if(!requestUser.canGetHoge()){
      // 一応エラー発生した場所もエラーログ書いておく。
      logger.error('requestUser.canGetHoge() 権限エラー')
      throw new Error('権限エラー');
    }
    
    const models = await HogeRepository.findAllHoges();
     
    // 処理が成功したよというログ。 
    // 修正の過程でメソッド名が変わったのにログの内容は修正忘れてる。
    logger.info('HogeService.getHoges found hoge!');
    
    return models;
  }
}

{
    "message": "HogeController.findListById(). finding hoge...",
    "level": "info"
}
{
    "message": "HogeService.findListById(). finding hoge...",
    "level": "info"
}
{
    "message": "HogeRepository.findListById(). finding hoge...",
    "level": "info"
}
{
    "message": "HogeRepository.findListById(). found Hoge!",
    "level": "info"
}
{
    "message": "HogeService.findListById(). found Hoge!",
    "level": "info"
}
{
    "message": "HogeRepository.findListById(). found Hoge!",
    "level": "info"
}
{
    "message": "HogeController.index(). found Hoge!",
    "level": "info"
}
...中略...
{
    "message": "HogeRepository.create(). found Hoge!",
    "level": "info"
}
{
    "message": "接続エラー",
    "level": "error"
}
{
    "message": "Error in HogeController.index(). userId: 1,  error: DBエラー",
    "level": "error"
}
{
    "message": "ここにスタックトレース",
    "level": "error"
}

logger.info('message here', {
  userId: 1,
  requestId: 'gjeaijgeiajke'
})

{
  "level": "info",
  "message": "message here",
  "userId": 1,
  "requestId": "gjeaijgeiajke"
}

class HogeController {
  async index(request) {
    // 処理が始まる前にログ。
    logger.debug('HogeController.index call!');
    
    // TypeScriptの書き方ではないがイメージ。例外があればcatch。
    try {
      const hoges = await HogeService.getAllHoge(request.user);
      
      // 処理が終わったらログ。
      logger.debug('HogeController.index called!');
      return hoges;
      
    // geAtAllHogeがエラーを投げたら
    } catch (error) {
　　　 // もう一度投げるならtry-catchで囲む必要ないけど、構造を前セクションと合わせたかった。ログはフレームワークのエラーハンドラーに任せる。
      throw error;
    }
  }
}

class HogeService {
  async getAllHoge(requestUser){
    logger.debug('HogeService.getAllHoge. finding hoge... ');
    
    // なんかの条件チェック失敗したら例外投げる。
    if(!requestUser.canGetHoge()){
      throw ForbiddenError('権限がありません。');
    }
    
    const models = await HogeRepository.findAllHoges();
    
    // アクションしたらinfoログをつける。
    logger.info('activity log', {
      userId: 1,
      eventType: 'view.hoge',
      timestamp: new Date().toISOString(),
    })
     
    logger.debug('HogeService.getHoges found hoge!'); 
    return models;
  }
}

export class LoggingExceptionFilter extends BaseExceptionFilter {
  catch(exception: Error, request) {
    this.logger.error(exception.message, {
      path: request.url,
      requestMethod: request.method,
      requestBody: request.body,
      requestQuery: request.query,
      requestParam: request.params,
      requestHeaders: request.headers,
      userId: (request.user as UserEntity | undefined)?.id ?? null,
      responseStatus: httpStatus,
      timestamp: new Date().toISOString(),
    });
  }
}

{
    "message": "activity log",
    "level": "info",
    "userId": 1,
    "timestamp": "2022-04-20 10:10:10",
    "eventType": "view.hoge"
}
{
    "message": "activity log",
    "level": "info",
    "userId": 2,
    "timestamp": "2022-04-21 10:10:10",
    "eventType": "create.hoge"
}
{
    "message": "DB接続エラー",
    "level": "error",
    "userId": 2,
    "timestamp": "2022-04-22 10:10:10",
    "path": "https://example.com/hoge",
    "requestMethod": "PUT",
    "requestBody": {
      "comment": "hogeよりfugaがいいと思う"
    },
    "requestQuery": "",
    "requestParam": "",
    "requestHeaders": {
      ...省略
    },
    "responseStatus": 500
}