在使用Html / WinJS开发的Metro应用程序中实现日志记录

时间:2013-11-01 12:23:59

标签: javascript windows-8 windows-runtime winjs error-log

我需要在使用Html / WinJS开发的Windows 8 Metro应用程序中提供错误日志记录 这样用户就可以从位于应用程序本地文件夹中的日志文件中了解出了什么问题。

我已经检查过WinJS.log(消息,标签,类型);它会写入控制台,但无法找到任何可以通过本地文件获取的内容。

在WinJS中开发的Metro应用程序中,如果有任何第三方库/ j可用于错误记录,最好的方法是什么?

提前致谢。

1 个答案:

答案 0 :(得分:8)

WinJS.log只是一个占位符。如果没有正确的初始化,它什么都不做(事实上,它根本没有设置)。如果您只是在应用程序启动时调用WinJS.Utilities.startLog(),则默认为控制台连接一个记录器。

如果你想要更完整的东西,你需要建立它。我在下面建了一个小样本。

function startFileLog() {
    // choose where the file will be stored:
    var fileDestination = Windows.Storage.ApplicationData.current.localFolder;

    var logger = new WinJS.Promise(function (complete) {
        var logfilename = new Date().toISOString().replace(/[:-]/g, "");
        logfilename = "log-" + logfilename + ".log";
        fileDestination.createFileAsync(logfilename,
            Windows.Storage.CreationCollisionOption.generateUniqueName)
              .done(function (file) {
                complete(file);
            });
    });

    var actionFn = function (message, tag, type) {
        logger.then(function (file) {
            var m = WinJS.Utilities.formatLog(message, tag, type);
            Windows.Storage.FileIO.appendTextAsync(file, m).done();
        });
    };

    WinJS.Utilities.startLog({ action: actionFn });
}

通过调用上面的startFileLog函数,它会在promise中创建一个新的日志文件(通过使用当前日期/时间作为文件名的一部分)。然后,将一个名为actionFn的函数传递给startLog函数。通过传递名为action的选项的可选属性,将覆盖默认的“写入控制台”行为(如果您不希望它被覆盖,则可以在没有操作的情况下调用startLog,然后复制来自WinJS.log的函数引用,并将其替换为您自己的函数,并将其调用。当调用log函数时,它现在调用actionFn,它使用先前创建的promise来验证日志文件实际上是否可用于写入,然后再继续。如果尚未准备好,它将排队等候。因此,这意味着即使文件可能没有立即就绪,日志最终也会包含您期望的结果。由于WinJS的异步特性,如果应用程序在文件完全打开之前崩溃,将会有一段很短的时间,将丢失记录的项目。如果您愿意,可以通过返回logger承诺来打开文件来延迟应用程序启动:

function startFileLog() {
    /// ... etc..

   return logger;
}

startFileLog().then(function() {
    // the application can now be assured that the log file is ready to accept
    // writes ... (but again, it's all async, so a write may be missed in 
    // extreme cases) 
});

您可能希望在应用程序结束时创建一个函数来清理/关闭日志文件。