LoggerConfigBuilder | Zowe Node.js SDK

Hierarchy

LoggerConfigBuilder

Properties

Static Readonly DEFAULT

DEFAULT: "default" = "default"

Static Readonly DEFAULT_BACKEND

DEFAULT_BACKEND: "NONE" = "NONE"

Static Readonly DEFAULT_COLOR_LAYOUT

DEFAULT_COLOR_LAYOUT: string = "%[" + LoggerConfigBuilder.DEFAULT_LOG_LAYOUT + "%]"

Static Readonly DEFAULT_LANG

DEFAULT_LANG: "en" = "en"

Static Readonly DEFAULT_LOGS_DIR

DEFAULT_LOGS_DIR: "logs" = "logs"

Static Readonly DEFAULT_LOG_DIR

DEFAULT_LOG_DIR: "\" | "/" = path.posix.sep

deprecated: Use DEFAULT_LOGS_DIR instead.

Static Readonly DEFAULT_LOG_FILE_BACKUPS

DEFAULT_LOG_FILE_BACKUPS: 5 = 5

Static Readonly DEFAULT_LOG_FILE_DIR

DEFAULT_LOG_FILE_DIR: string = "logs" + path.posix.sep

deprecated: Use DEFAULT_LOGS_DIR instead.

Static Readonly DEFAULT_LOG_FILE_EXT

DEFAULT_LOG_FILE_EXT: ".log" = ".log"

Static Readonly DEFAULT_LOG_FILE_MAX_SIZE

DEFAULT_LOG_FILE_MAX_SIZE: 10000000 = 10000000

Static Readonly DEFAULT_LOG_LAYOUT

DEFAULT_LOG_LAYOUT: "[%d{yyyy/MM/dd} %d{hh:mm:ss.SSS}] [%p] %m" = "[%d{yyyy/MM/dd} %d{hh:mm:ss.SSS}] [%p] %m"

Static Readonly DEFAULT_LOG_TYPE_CONSOLE

DEFAULT_LOG_TYPE_CONSOLE: "console" = "console"

Static Readonly DEFAULT_LOG_TYPE_FILE_SYNC

DEFAULT_LOG_TYPE_FILE_SYNC: "fileSync" = "fileSync"

Static Readonly DEFAULT_LOG_TYPE_PAT

DEFAULT_LOG_TYPE_PAT: "pattern" = "pattern"

Methods

Static addConsoleAppender

addConsoleAppender(config: IConfigLogging, key: string, categoryName?: string, logLevel?: string): IConfigLogging

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:70
Returns the constant values defined within the LoggerConfigBuilder for this config object

Parameters
- config: IConfigLogging
- key: string
- Default value categoryName: string = key
- Optional logLevel: string
Returns IConfigLogging
- default object built

Static addFileAppender

addFileAppender(config: IConfigLogging, key: string, categoryName?: string, filename?: string, logLevel?: string): IConfigLogging

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:89
Returns the constant values defined within the LoggerConfigBuilder for this config object

Parameters
- config: IConfigLogging
- key: string
- Default value categoryName: string = key
- Default value filename: string = LoggerConfigBuilder.buildFullLogFile(LoggerConfigBuilder.getDefaultFileName(key))
- Optional logLevel: string
Returns IConfigLogging
- default object built

Static buildFullLogFile

buildFullLogFile(name: string): string

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:46
Build a fully qualified directory to a log file - defaults to the users home directory - Imperative does NOT use this as the home is set by the CLI configuration document.

Parameters
- name: string
  
  name of the file to append to fully qualified directory
Returns string

Static getDefaultFileName

getDefaultFileName(name: string): string

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:113
Returns the log file name that will be used

Parameters
- name: string
Returns string
- the default file name for the log file

Static getDefaultIConfigLogging

getDefaultIConfigLogging(): IConfigLogging

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:54
Returns the constant values defined within the LoggerConfigBuilder for this config object

Returns IConfigLogging
- default object built

Static getDefaultLogLevel

getDefaultLogLevel(): string

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:121
Returns the log level that will be used if not overridden

Returns string
- the default log level

Hierarchy

Index

Properties

Methods

Properties

Static Readonly DEFAULT

Static Readonly DEFAULT_BACKEND

Static Readonly DEFAULT_COLOR_LAYOUT

Static Readonly DEFAULT_LANG

Static Readonly DEFAULT_LOGS_DIR

Static Readonly DEFAULT_LOG_DIR

Static Readonly DEFAULT_LOG_FILE_BACKUPS

Static Readonly DEFAULT_LOG_FILE_DIR

Static Readonly DEFAULT_LOG_FILE_EXT

Static Readonly DEFAULT_LOG_FILE_MAX_SIZE

Static Readonly DEFAULT_LOG_LAYOUT

Static Readonly DEFAULT_LOG_TYPE_CONSOLE

Static Readonly DEFAULT_LOG_TYPE_FILE_SYNC

Static Readonly DEFAULT_LOG_TYPE_PAT

Methods

Static addConsoleAppender

Parameters

config: IConfigLogging

key: string

Default value categoryName: string = key

Optional logLevel: string

Returns IConfigLogging

Static addFileAppender

Parameters

config: IConfigLogging

key: string

Default value categoryName: string = key

Default value filename: string = LoggerConfigBuilder.buildFullLogFile(LoggerConfigBuilder.getDefaultFileName(key))

Optional logLevel: string

Returns IConfigLogging

Static buildFullLogFile

Parameters

name: string

Returns string

Static getDefaultFileName

Parameters

name: string

Returns string

Static getDefaultIConfigLogging

Returns IConfigLogging

Static getDefaultLogLevel

Returns string