Module

std/log/mod.ts>Logger

Deno standard library
Go to Latest
class Logger
import { Logger } from "https://dotland.deno.dev/std@0.170.0/log/mod.ts";

Constructors

new
Logger(
loggerName: string,
levelName: LevelName,
options?: LoggerOptions,
)

Properties

handlers: BaseHandler[]
level: LogLevels
levelName: LevelName
readonly
loggerName: string

Methods

asString(data: unknown): string
critical<T>(msg: () => T, ...args: unknown[]): T | undefined
critical<T>(msg: T extends GenericFunction ? never : T, ...args: unknown[]): T
debug<T>(msg: () => T, ...args: unknown[]): T | undefined
debug<T>(msg: T extends GenericFunction ? never : T, ...args: unknown[]): T
error<T>(msg: () => T, ...args: unknown[]): T | undefined
error<T>(msg: T extends GenericFunction ? never : T, ...args: unknown[]): T
info<T>(msg: () => T, ...args: unknown[]): T | undefined
info<T>(msg: T extends GenericFunction ? never : T, ...args: unknown[]): T
warning<T>(msg: () => T, ...args: unknown[]): T | undefined
warning<T>(msg: T extends GenericFunction ? never : T, ...args: unknown[]): T
import Logger
import { Logger } from "https://dotland.deno.dev/std@0.170.0/log/mod.ts";

Logging library with the support for terminal and file outputs. Also provides interfaces for building custom loggers.

Loggers

Loggers are objects that you interact with. When you use a logger method it constructs a LogRecord and passes it down to its handlers for output. To create custom loggers, specify them in loggers when calling log.setup.

Custom message format

If you want to override default format of message you can define formatter option for handler. It can be either simple string-based format that uses LogRecord fields or more complicated function-based one that takes LogRecord as argument and outputs string.

The default log format is {levelName} {msg}.

Inline Logging

Log functions return the data passed in the msg parameter. Data is returned regardless if the logger actually logs it.

Lazy Log Evaluation

Some log statements are expensive to compute. In these cases, you can use lazy log evaluation to prevent the computation taking place if the logger won't log the message.

NOTE: When using lazy log evaluation, undefined will be returned if the resolver function is not called because the logger won't log it. It is an antipattern use lazy evaluation with inline logging because the return value depends on the current log level.

For module authors

The authors of public modules can let the users display the internal logs of the module by using a custom logger:

import { getLogger } from "https://deno.land/std@0.170.0/log/mod.ts";

function logger() {
  return getLogger("my-awesome-module");
}

export function sum(a: number, b: number) {
  logger().debug(`running ${a} + ${b}`);
  return a + b;
}

export function mult(a: number, b: number) {
  logger().debug(`running ${a} * ${b}`);
  return a * b;
}

The user of the module can then display the internal logs with:

import * as log from "https://deno.land/std@0.170.0/log/mod.ts";
import { sum } from "<the-awesome-module>/mod.ts";

await log.setup({
  handlers: {
    console: new log.handlers.ConsoleHandler("DEBUG"),
  },

  loggers: {
    "my-awesome-module": {
      level: "DEBUG",
      handlers: ["console"],
    },
  },
});

sum(1, 2); // prints "running 1 + 2" to the console

Please note that, due to the order of initialization of the loggers, the following won't work:

import { getLogger } from "https://deno.land/std@0.170.0/log/mod.ts";

const logger = getLogger("my-awesome-module");

export function sum(a: number, b: number) {
  logger.debug(`running ${a} + ${b}`); // no message will be logged, because getLogger() was called before log.setup()
  return a + b;
}