f718ab6501
This change adds the ability to perform runtime logging, including debug logging, that wires up to the Pulumi Fabric engine in the usual ways. Most stdout/stderr will automatically go to the right place, but this lets us add some debug tracing in the implementation of the runtime itself (and should come in handy in other places, like perhaps the Pulumi Framework and even low-level end-user code).
56 lines
2 KiB
TypeScript
56 lines
2 KiB
TypeScript
// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
|
|
|
|
import { getEngine } from "./settings";
|
|
let engproto = require("../proto/nodejs/engine_pb");
|
|
|
|
// Log offers the ability to log messages in a way that integrate tightly with the resource engine's interface.
|
|
export class Log {
|
|
// debug logs a debug-level message that is generally hidden from end-users.
|
|
public static debug(msg: string): void {
|
|
let engine: Object | undefined = getEngine();
|
|
if (engine) {
|
|
Log.log(engine, engproto.LogSeverity.DEBUG, msg);
|
|
} else {
|
|
// ignore debug messages when no engine is available.
|
|
}
|
|
}
|
|
|
|
// info logs an informational message that is generally printed to stdout during resource operations.
|
|
public static info(msg: string): void {
|
|
let engine: Object | undefined = getEngine();
|
|
if (engine) {
|
|
Log.log(engine, engproto.LogSeverity.INFO, msg);
|
|
} else {
|
|
console.log(`info: [runtime] ${msg}`);
|
|
}
|
|
}
|
|
|
|
// warn logs a warning to indicate that something went wrong, but not catastrophically so.
|
|
public static warn(msg: string): void {
|
|
let engine: Object | undefined = getEngine();
|
|
if (engine) {
|
|
Log.log(engine, engproto.LogSeverity.WARNING, msg);
|
|
} else {
|
|
console.warn(`warning: [runtime] ${msg}`);
|
|
}
|
|
}
|
|
|
|
// error logs a fatal error to indicate that the tool should stop processing resource operations immediately.
|
|
public static error(msg: string): void {
|
|
let engine: Object | undefined = getEngine();
|
|
if (engine) {
|
|
Log.log(engine, engproto.LogSeverity.ERROR, msg);
|
|
} else {
|
|
console.error(`error: [runtime] ${msg}`);
|
|
}
|
|
}
|
|
|
|
private static log(engine: any, sev: any, msg: string): void {
|
|
let req = new engproto.LogRequest();
|
|
req.setSeverity(sev);
|
|
req.setMessage(msg);
|
|
engine.log(req, () => {/*keep the msg loop alive until it gets delivered*/});
|
|
}
|
|
}
|
|
|