A plugin for Elysia.js for logging using the pino library.
bun add @bogeychan/elysia-loggerimport { 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(8080);
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");
});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");
});Automatic onAfterResponse & onError logging by default; based on pino-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");Checkout the examples folder on github for further use cases such as the integration of pino-pretty for readable console outputs.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent