105 lines
2.9 KiB
TypeScript
105 lines
2.9 KiB
TypeScript
|
/**
|
||
|
|
* An AzureClientLogger is a function that can log to an appropriate severity level.
|
||
|
|
*/
|
||
|
|
export declare type AzureClientLogger = Debugger;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The AzureLogger provides a mechanism for overriding where logs are output to.
|
||
|
|
* By default, logs are sent to stderr.
|
||
|
|
* Override the `log` method to redirect logs to another location.
|
||
|
|
*/
|
||
|
|
export declare const AzureLogger: AzureClientLogger;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Defines the methods available on the SDK-facing logger.
|
||
|
|
*/
|
||
|
|
export declare interface AzureLogger {
|
||
|
|
/**
|
||
|
|
* Used for failures the program is unlikely to recover from,
|
||
|
|
* such as Out of Memory.
|
||
|
|
*/
|
||
|
|
error: Debugger;
|
||
|
|
/**
|
||
|
|
* Used when a function fails to perform its intended task.
|
||
|
|
* Usually this means the function will throw an exception.
|
||
|
|
* Not used for self-healing events (e.g. automatic retry)
|
||
|
|
*/
|
||
|
|
warning: Debugger;
|
||
|
|
/**
|
||
|
|
* Used when a function operates normally.
|
||
|
|
*/
|
||
|
|
info: Debugger;
|
||
|
|
/**
|
||
|
|
* Used for detailed troubleshooting scenarios. This is
|
||
|
|
* intended for use by developers / system administrators
|
||
|
|
* for diagnosing specific failures.
|
||
|
|
*/
|
||
|
|
verbose: Debugger;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The log levels supported by the logger.
|
||
|
|
* The log levels in order of most verbose to least verbose are:
|
||
|
|
* - verbose
|
||
|
|
* - info
|
||
|
|
* - warning
|
||
|
|
* - error
|
||
|
|
*/
|
||
|
|
export declare type AzureLogLevel = "verbose" | "info" | "warning" | "error";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a logger for use by the Azure SDKs that inherits from `AzureLogger`.
|
||
|
|
* @param namespace - The name of the SDK package.
|
||
|
|
* @hidden
|
||
|
|
*/
|
||
|
|
export declare function createClientLogger(namespace: string): AzureLogger;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A log function that can be dynamically enabled and redirected.
|
||
|
|
*/
|
||
|
|
export declare interface Debugger {
|
||
|
|
/**
|
||
|
|
* Logs the given arguments to the `log` method.
|
||
|
|
*/
|
||
|
|
(...args: any[]): void;
|
||
|
|
/**
|
||
|
|
* True if this logger is active and logging.
|
||
|
|
*/
|
||
|
|
enabled: boolean;
|
||
|
|
/**
|
||
|
|
* Used to cleanup/remove this logger.
|
||
|
|
*/
|
||
|
|
destroy: () => boolean;
|
||
|
|
/**
|
||
|
|
* The current log method. Can be overridden to redirect output.
|
||
|
|
*/
|
||
|
|
log: (...args: any[]) => void;
|
||
|
|
/**
|
||
|
|
* The namespace of this logger.
|
||
|
|
*/
|
||
|
|
namespace: string;
|
||
|
|
/**
|
||
|
|
* Extends this logger with a child namespace.
|
||
|
|
* Namespaces are separated with a ':' character.
|
||
|
|
*/
|
||
|
|
extend: (namespace: string) => Debugger;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieves the currently specified log level.
|
||
|
|
*/
|
||
|
|
export declare function getLogLevel(): AzureLogLevel | undefined;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Immediately enables logging at the specified log level. If no level is specified, logging is disabled.
|
||
|
|
* @param level - The log level to enable for logging.
|
||
|
|
* Options from most verbose to least verbose are:
|
||
|
|
* - verbose
|
||
|
|
* - info
|
||
|
|
* - warning
|
||
|
|
* - error
|
||
|
|
*/
|
||
|
|
export declare function setLogLevel(level?: AzureLogLevel): void;
|
||
|
|
|
||
|
|
export { }
|