nsuite - v1.0.1
    Preparing search index...

    Function createLogger

    • Creates a Winston logger with a daily rotating file transport and optional console transport.

      Parameters

      • options: {
            enableConsole?: boolean;
            filename?: string;
            includeCallSite?: boolean;
            inspector?: string;
            level?: string;
            maxLength?: number;
            meta?: Record<string, string>;
            zippedArchive?: boolean;
        }

        Configuration options for the logger.

        • OptionalenableConsole?: boolean

          Whether to enable console logging.

        • Optionalfilename?: string

          The filename pattern for the log files.

        • OptionalincludeCallSite?: boolean

          Whether to include the call site in the log message.

        • Optionalinspector?: string

          The inspector function to use for formatting log messages. Support 'nodeInspect' or 'objectInspect'

        • Optionallevel?: string

          The log level.

        • OptionalmaxLength?: number

          The maximum length of the log message.

        • Optionalmeta?: Record<string, string>

          The name of the server.

        • OptionalzippedArchive?: boolean

          Whether to zip old log files.

      Returns Logger

      • The configured Winston logger instance.
      import { createLogger } from "nsuite";
      export const logger = createLogger({
      level: "info",
      meta: {
      serverName: "your-server-name",
      NODE_ENV: process.env.NODE_ENV,
      MODE: process.env.MODE,
      },
      maxLength: 1000,
      filename: "./logs/application-%DATE%.log",
      zippedArchive: false,
      enableConsole: process.env.NODE_ENV !== "production",
      });