@bogeychan/elysia-logger (英语)

用于 艾丽西亚.js 使用 皮诺 图书馆.

移徙指南

安装

bun add @bogeychan/elysia-logger

使用量

import { Elysia } from "elysia";
import { logger } from "@bogeychan/elysia-logger";

const app = new Elysia()
  .use(
    logger({
      level: "error",
    })
  )
  .get("/", (ctx) => {
    ctx.log.error(ctx, "Context");
    ctx.log.info(ctx.request, "Request"); // noop

    return "Hello World";
  })
  .listen(3000);

console.log(`Listening on ${app.server!.url}`);

日志为文件,或

import { fileLogger } from "@bogeychan/elysia-logger";

fileLogger({
  file: "./my.log",
});

将日志条目插入流中

import { logger } from '@bogeychan/elysia-logger';

logger({
  stream: ... // default -> console output
});

包含请求上下文信息

import { logger, type InferContext } from "@bogeychan/elysia-logger";

const myPlugin = () => new Elysia().decorate("myProperty", 42);

// ...

class MyError extends Error {
  constructor(message: string, public myValue: string) {
    super(message);
  }
}

app = app.error("myError", MyError).use(myPlugin());

app
  .use(
    logger({
      /**
       * This function will be invoked for each `log`-method called
       * where you can pass additional properties that need to be logged
       */
      customProps(ctx: InferContext<typeof app>) {
        if (ctx.isError && ctx.code === "myError") {
          return {
            myValue: ctx.error.myValue,
          };
        }

        return {
          params: ctx.params,
          query: ctx.query,
          myProperty: ctx.myProperty,
        };
      },
    })
  )
  .get("/", (ctx) => {
    ctx.log.info(ctx, "Context");

    return "with-context";
  })
  .get("/error", () => {
    throw new MyError("whelp", "yay");
  });

双双使用日志实例 Standalone 内部 Context

import { createPinoLogger } from "@bogeychan/elysia-logger";

const log = createPinoLogger(/* ... */);

app
  .use(log.into(/* ... */))
  .onError((ctx) => {
    log.error(ctx, ctx.error.name);
    return "onError";
  })
  .get("/", (ctx) => {
    ctx.log.info(ctx, "Context");

    throw new Error("whelp");
  });

使用现有的 pino 日志

import { pino } from "pino";
import { wrap } from "@bogeychan/elysia-logger";

const logger = pino(/* ... */);

app
  .use(
    wrap(logger, {
      /* ... */
    })
  )
  .get("/", (ctx) => {
    ctx.log.info(ctx, "Context");

    return "wrapped!";
  });

自动 onAfterResponse 打开 onError 登录方式 default; 基于 皮诺-http

import { logger } from "@bogeychan/elysia-logger";

app
  .use(
    logger({
      autoLogging: true, // default
      autoLogging: false, // disabled
      autoLogging: {
        ignore(ctx) {
          return true; // ignore logging for requests based on condition
        },
      },
    })
  )
  .get("/", (ctx) => "autoLogging");

检查 实例 github 文件夹,供进一步使用,例如整合 皮诺色 可读控制台输出.

许可证

麻省理工学院