@microsoft/sp-diagnostics 1.23.1 → 1.24.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/78359e4b-07c2-43c6-8d0b-d060b4d577e8.manifest.json +6 -11
- package/dist/index-internal-beta.d.ts +20 -0
- package/dist/index-internal-public.d.ts +20 -0
- package/dist/index-internal.d.ts +20 -0
- package/dist/sp-diagnostics_none_1b5b73722b91f3231f63.js +1 -0
- package/dist/tsdoc-metadata.json +1 -1
- package/lib-commonjs/Api/Engagement/EngagementLogger.js +91 -96
- package/lib-commonjs/Api/Engagement/IEngagementHandler.js +9 -3
- package/lib-commonjs/Api/ExecutionQueue.js +73 -86
- package/lib-commonjs/Api/ILogData.js +6 -3
- package/lib-commonjs/Api/ILogEntry.js +5 -2
- package/lib-commonjs/Api/ILogErrorData.js +6 -3
- package/lib-commonjs/Api/ILogSource.js +10 -3
- package/lib-commonjs/Api/ILogVerboseData.js +6 -3
- package/lib-commonjs/Api/Log/LogHandler.js +27 -26
- package/lib-commonjs/Api/LogEntry.js +40 -39
- package/lib-commonjs/Api/LogFeature.js +14 -10
- package/lib-commonjs/Api/LogLevel.js +22 -19
- package/lib-commonjs/Api/LogManager/CircularBuffer.js +56 -64
- package/lib-commonjs/Api/LogManager/LogManager.js +61 -78
- package/lib-commonjs/Api/LogSource.js +37 -35
- package/lib-commonjs/Api/LogType.js +20 -15
- package/lib-commonjs/Api/Qos/AutoAlertableQosMonitor.js +68 -82
- package/lib-commonjs/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.js +5 -2
- package/lib-commonjs/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.js +5 -2
- package/lib-commonjs/Api/Qos/IQos.js +5 -2
- package/lib-commonjs/Api/Qos/IQosEndEvent.js +5 -2
- package/lib-commonjs/Api/Qos/IQosExtraData.js +15 -3
- package/lib-commonjs/Api/Qos/IQosStartEvent.js +9 -3
- package/lib-commonjs/Api/Qos/QosLogger.js +54 -60
- package/lib-commonjs/Api/Qos/QosMonitor.js +163 -209
- package/lib-commonjs/Api/Qos/QosMonitorShareFailureWithCP.js +72 -92
- package/lib-commonjs/Api/Qos/QosResultType.js +14 -7
- package/lib-commonjs/Api/Trace/DefaultTraceHandler.js +20 -22
- package/lib-commonjs/Api/Trace/ITraceHandler.js +9 -3
- package/lib-commonjs/Api/Trace/ITraceLogger.js +5 -2
- package/lib-commonjs/Api/Trace/LogEvent.js +86 -125
- package/lib-commonjs/Api/Trace/TraceLogger.js +149 -161
- package/lib-commonjs/Diagnostics.js +57 -72
- package/lib-commonjs/DiagnosticsSettingsManager.js +37 -43
- package/lib-commonjs/IDiagnosticsSettings.js +5 -2
- package/lib-commonjs/common/Killswitches.js +13 -9
- package/lib-commonjs/extraData/DisplayApp.js +13 -5
- package/lib-commonjs/extraData/IDiagnosticContextInfo.js +5 -2
- package/lib-commonjs/extraData/IPageExtraData.js +5 -2
- package/lib-commonjs/extraData/PageType.js +15 -8
- package/lib-commonjs/extraData/PromotedState.js +18 -13
- package/lib-commonjs/extraData/WebTemplateId.js +13 -5
- package/lib-commonjs/extraData/setPageExtraData.js +37 -37
- package/lib-commonjs/index.js +102 -50
- package/{lib → lib-dts}/Api/Engagement/IEngagementHandler.d.ts +2 -0
- package/lib-esm/Api/Engagement/EngagementLogger.js +137 -0
- package/lib-esm/Api/Engagement/IEngagementHandler.js +9 -0
- package/lib-esm/Api/ExecutionQueue.js +114 -0
- package/lib-esm/Api/ILogData.js +4 -0
- package/lib-esm/Api/ILogEntry.js +3 -0
- package/lib-esm/Api/ILogErrorData.js +4 -0
- package/lib-esm/Api/ILogSource.js +8 -0
- package/lib-esm/Api/ILogVerboseData.js +4 -0
- package/lib-esm/Api/Log/LogHandler.js +37 -0
- package/lib-esm/Api/LogEntry.js +44 -0
- package/lib-esm/Api/LogFeature.js +8 -0
- package/lib-esm/Api/LogLevel.js +20 -0
- package/lib-esm/Api/LogManager/CircularBuffer.js +83 -0
- package/lib-esm/Api/LogManager/LogManager.js +103 -0
- package/lib-esm/Api/LogSource.js +32 -0
- package/lib-esm/Api/LogType.js +20 -0
- package/lib-esm/Api/Qos/AutoAlertableQosMonitor.js +74 -0
- package/lib-esm/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.js +6 -0
- package/lib-esm/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.js +6 -0
- package/lib-esm/Api/Qos/IQos.js +6 -0
- package/lib-esm/Api/Qos/IQosEndEvent.js +6 -0
- package/lib-esm/Api/Qos/IQosExtraData.js +12 -0
- package/lib-esm/Api/Qos/IQosStartEvent.js +6 -0
- package/lib-esm/Api/Qos/QosLogger.js +64 -0
- package/lib-esm/Api/Qos/QosMonitor.js +258 -0
- package/lib-esm/Api/Qos/QosMonitorShareFailureWithCP.js +89 -0
- package/lib-esm/Api/Qos/QosResultType.js +11 -0
- package/lib-esm/Api/Trace/DefaultTraceHandler.js +23 -0
- package/lib-esm/Api/Trace/ITraceHandler.js +9 -0
- package/lib-esm/Api/Trace/ITraceLogger.js +3 -0
- package/lib-esm/Api/Trace/LogEvent.js +104 -0
- package/lib-esm/Api/Trace/TraceLogger.js +180 -0
- package/lib-esm/Diagnostics.js +67 -0
- package/lib-esm/DiagnosticsSettingsManager.js +54 -0
- package/lib-esm/IDiagnosticsSettings.js +3 -0
- package/{lib → lib-esm}/common/Killswitches.js +3 -4
- package/{lib → lib-esm}/extraData/DisplayApp.js +3 -2
- package/lib-esm/extraData/IDiagnosticContextInfo.js +7 -0
- package/lib-esm/extraData/IPageExtraData.js +3 -0
- package/{lib → lib-esm}/extraData/PageType.js +4 -4
- package/lib-esm/extraData/PromotedState.js +15 -0
- package/{lib → lib-esm}/extraData/WebTemplateId.js +3 -2
- package/{lib → lib-esm}/extraData/setPageExtraData.js +14 -20
- package/{lib → lib-esm}/index.js +3 -3
- package/package.json +33 -6
- package/dist/sp-diagnostics_none_e7447a590b1864b48fbc.js +0 -1
- package/lib/Api/Engagement/EngagementLogger.d.ts.map +0 -1
- package/lib/Api/Engagement/EngagementLogger.js +0 -143
- package/lib/Api/Engagement/IEngagementHandler.d.ts.map +0 -1
- package/lib/Api/Engagement/IEngagementHandler.js +0 -2
- package/lib/Api/ExecutionQueue.d.ts.map +0 -1
- package/lib/Api/ExecutionQueue.js +0 -131
- package/lib/Api/ILogData.d.ts.map +0 -1
- package/lib/Api/ILogData.js +0 -3
- package/lib/Api/ILogEntry.d.ts.map +0 -1
- package/lib/Api/ILogEntry.js +0 -2
- package/lib/Api/ILogErrorData.d.ts.map +0 -1
- package/lib/Api/ILogErrorData.js +0 -3
- package/lib/Api/ILogSource.d.ts.map +0 -1
- package/lib/Api/ILogSource.js +0 -3
- package/lib/Api/ILogVerboseData.d.ts.map +0 -1
- package/lib/Api/ILogVerboseData.js +0 -3
- package/lib/Api/Log/LogHandler.d.ts.map +0 -1
- package/lib/Api/Log/LogHandler.js +0 -40
- package/lib/Api/LogEntry.d.ts.map +0 -1
- package/lib/Api/LogEntry.js +0 -51
- package/lib/Api/LogFeature.d.ts.map +0 -1
- package/lib/Api/LogFeature.js +0 -11
- package/lib/Api/LogLevel.d.ts.map +0 -1
- package/lib/Api/LogLevel.js +0 -24
- package/lib/Api/LogManager/CircularBuffer.d.ts.map +0 -1
- package/lib/Api/LogManager/CircularBuffer.js +0 -98
- package/lib/Api/LogManager/LogManager.d.ts.map +0 -1
- package/lib/Api/LogManager/LogManager.js +0 -121
- package/lib/Api/LogSource.d.ts.map +0 -1
- package/lib/Api/LogSource.js +0 -40
- package/lib/Api/LogType.d.ts.map +0 -1
- package/lib/Api/LogType.js +0 -23
- package/lib/Api/Qos/AutoAlertableQosMonitor.d.ts.map +0 -1
- package/lib/Api/Qos/AutoAlertableQosMonitor.js +0 -93
- package/lib/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.d.ts.map +0 -1
- package/lib/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.js +0 -2
- package/lib/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.d.ts.map +0 -1
- package/lib/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.js +0 -2
- package/lib/Api/Qos/IQos.d.ts.map +0 -1
- package/lib/Api/Qos/IQos.js +0 -2
- package/lib/Api/Qos/IQosEndEvent.d.ts.map +0 -1
- package/lib/Api/Qos/IQosEndEvent.js +0 -2
- package/lib/Api/Qos/IQosExtraData.d.ts.map +0 -1
- package/lib/Api/Qos/IQosExtraData.js +0 -2
- package/lib/Api/Qos/IQosStartEvent.d.ts.map +0 -1
- package/lib/Api/Qos/IQosStartEvent.js +0 -2
- package/lib/Api/Qos/QosLogger.d.ts.map +0 -1
- package/lib/Api/Qos/QosLogger.js +0 -74
- package/lib/Api/Qos/QosMonitor.d.ts.map +0 -1
- package/lib/Api/Qos/QosMonitor.js +0 -304
- package/lib/Api/Qos/QosMonitorShareFailureWithCP.d.ts.map +0 -1
- package/lib/Api/Qos/QosMonitorShareFailureWithCP.js +0 -114
- package/lib/Api/Qos/QosResultType.d.ts.map +0 -1
- package/lib/Api/Qos/QosResultType.js +0 -11
- package/lib/Api/Trace/DefaultTraceHandler.d.ts.map +0 -1
- package/lib/Api/Trace/DefaultTraceHandler.js +0 -30
- package/lib/Api/Trace/ITraceHandler.d.ts.map +0 -1
- package/lib/Api/Trace/ITraceHandler.js +0 -2
- package/lib/Api/Trace/ITraceLogger.d.ts.map +0 -1
- package/lib/Api/Trace/ITraceLogger.js +0 -2
- package/lib/Api/Trace/LogEvent.d.ts.map +0 -1
- package/lib/Api/Trace/LogEvent.js +0 -147
- package/lib/Api/Trace/TraceLogger.d.ts.map +0 -1
- package/lib/Api/Trace/TraceLogger.js +0 -196
- package/lib/Diagnostics.d.ts.map +0 -1
- package/lib/Diagnostics.js +0 -82
- package/lib/DiagnosticsSettingsManager.d.ts.map +0 -1
- package/lib/DiagnosticsSettingsManager.js +0 -62
- package/lib/IDiagnosticsSettings.d.ts.map +0 -1
- package/lib/IDiagnosticsSettings.js +0 -2
- package/lib/common/Killswitches.d.ts.map +0 -1
- package/lib/extraData/DisplayApp.d.ts.map +0 -1
- package/lib/extraData/IDiagnosticContextInfo.d.ts.map +0 -1
- package/lib/extraData/IDiagnosticContextInfo.js +0 -2
- package/lib/extraData/IPageExtraData.d.ts.map +0 -1
- package/lib/extraData/IPageExtraData.js +0 -2
- package/lib/extraData/PageType.d.ts.map +0 -1
- package/lib/extraData/PromotedState.d.ts.map +0 -1
- package/lib/extraData/PromotedState.js +0 -17
- package/lib/extraData/WebTemplateId.d.ts.map +0 -1
- package/lib/extraData/setPageExtraData.d.ts.map +0 -1
- package/lib/index.d.ts.map +0 -1
- /package/{lib → lib-dts}/Api/Engagement/EngagementLogger.d.ts +0 -0
- /package/{lib → lib-dts}/Api/ExecutionQueue.d.ts +0 -0
- /package/{lib → lib-dts}/Api/ILogData.d.ts +0 -0
- /package/{lib → lib-dts}/Api/ILogEntry.d.ts +0 -0
- /package/{lib → lib-dts}/Api/ILogErrorData.d.ts +0 -0
- /package/{lib → lib-dts}/Api/ILogSource.d.ts +0 -0
- /package/{lib → lib-dts}/Api/ILogVerboseData.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Log/LogHandler.d.ts +0 -0
- /package/{lib → lib-dts}/Api/LogEntry.d.ts +0 -0
- /package/{lib → lib-dts}/Api/LogFeature.d.ts +0 -0
- /package/{lib → lib-dts}/Api/LogLevel.d.ts +0 -0
- /package/{lib → lib-dts}/Api/LogManager/CircularBuffer.d.ts +0 -0
- /package/{lib → lib-dts}/Api/LogManager/LogManager.d.ts +0 -0
- /package/{lib → lib-dts}/Api/LogSource.d.ts +0 -0
- /package/{lib → lib-dts}/Api/LogType.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/AutoAlertableQosMonitor.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/IQos.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/IQosEndEvent.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/IQosExtraData.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/IQosStartEvent.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/QosLogger.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/QosMonitor.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/QosMonitorShareFailureWithCP.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Qos/QosResultType.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Trace/DefaultTraceHandler.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Trace/ITraceHandler.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Trace/ITraceLogger.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Trace/LogEvent.d.ts +0 -0
- /package/{lib → lib-dts}/Api/Trace/TraceLogger.d.ts +0 -0
- /package/{lib → lib-dts}/Diagnostics.d.ts +0 -0
- /package/{lib → lib-dts}/DiagnosticsSettingsManager.d.ts +0 -0
- /package/{lib → lib-dts}/IDiagnosticsSettings.d.ts +0 -0
- /package/{lib → lib-dts}/common/Killswitches.d.ts +0 -0
- /package/{lib → lib-dts}/extraData/DisplayApp.d.ts +0 -0
- /package/{lib → lib-dts}/extraData/IDiagnosticContextInfo.d.ts +0 -0
- /package/{lib → lib-dts}/extraData/IPageExtraData.d.ts +0 -0
- /package/{lib → lib-dts}/extraData/PageType.d.ts +0 -0
- /package/{lib → lib-dts}/extraData/PromotedState.d.ts +0 -0
- /package/{lib → lib-dts}/extraData/WebTemplateId.d.ts +0 -0
- /package/{lib → lib-dts}/extraData/setPageExtraData.d.ts +0 -0
- /package/{lib → lib-dts}/index.d.ts +0 -0
- /package/{lib → lib-esm}/sp-diagnostics.manifest.json +0 -0
|
@@ -1,199 +1,187 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* This is used to log traces of failed operations and debugging information.
|
|
11
|
-
* @internal
|
|
12
|
-
*/
|
|
13
|
-
var TraceLogger = /** @class */ (function () {
|
|
14
|
-
function TraceLogger() {
|
|
2
|
+
Object.defineProperty(exports, "__esModule", {
|
|
3
|
+
value: true
|
|
4
|
+
});
|
|
5
|
+
Object.defineProperty(exports, "default", {
|
|
6
|
+
enumerable: true,
|
|
7
|
+
get: function() {
|
|
8
|
+
return TraceLogger;
|
|
15
9
|
}
|
|
10
|
+
});
|
|
11
|
+
const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
|
|
12
|
+
const _spcorelibrary = require("@microsoft/sp-core-library");
|
|
13
|
+
const _LogEvent = /*#__PURE__*/ _interop_require_default._(require("./LogEvent"));
|
|
14
|
+
const _LogLevel = require("../LogLevel");
|
|
15
|
+
const _DefaultTraceHandler = /*#__PURE__*/ _interop_require_default._(require("./DefaultTraceHandler"));
|
|
16
|
+
const _LogManager = /*#__PURE__*/ _interop_require_default._(require("../LogManager/LogManager"));
|
|
17
|
+
class TraceLogger {
|
|
16
18
|
/**
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
TraceLogger._addHandler = function (logger) {
|
|
19
|
+
* Init function for the passed logger object
|
|
20
|
+
*
|
|
21
|
+
* @internal
|
|
22
|
+
*/ static _addHandler(logger) {
|
|
22
23
|
TraceLogger._logManager.addHandler(logger.log);
|
|
23
24
|
TraceLogger._logManager.processAll(logger.log);
|
|
24
25
|
TraceLogger._verboseLogManager.addHandler(logger.verbose);
|
|
25
26
|
TraceLogger._verboseLogManager.processAll(logger.verbose);
|
|
26
|
-
}
|
|
27
|
+
}
|
|
27
28
|
/**
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
sp_core_library_1.Validate.isNotNullOrUndefined(error, 'error');
|
|
29
|
+
* Exception logging
|
|
30
|
+
* This shoule be used whenever you want to log something that might in future help to debug failures.
|
|
31
|
+
* The error parameter is the only required one and basically will be just converted to string and
|
|
32
|
+
* logged to Debug stream (RealibilityLogs in SLAPI).
|
|
33
|
+
* It will also be uploaded to the server immediately and not wait for next batch log upload.
|
|
34
|
+
* If you don't specify second parameter:eventName
|
|
35
|
+
* the event name for all errors logged that way will be same "CaughtError" with
|
|
36
|
+
* appropriate prefix ("ModernPublish.CaughtError" etc.)
|
|
37
|
+
* These two parameters "eventName and resultCode" are there to be used from Qos.
|
|
38
|
+
* It is not encouraged to use them directly from ErrorHelper but if you do,
|
|
39
|
+
* the log will be written with custom event name of following format:
|
|
40
|
+
* <Workload>.<eventName>.<resultCode>.Failure, Workload is set in Telemetry settings.
|
|
41
|
+
**/ static logError(source, error, eventName, resultCode) {
|
|
42
|
+
_spcorelibrary.Validate.isNotNullOrUndefined(error, 'error');
|
|
43
43
|
this._log(source, error, eventName, true, resultCode);
|
|
44
|
-
}
|
|
44
|
+
}
|
|
45
45
|
/**
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
var errorInfo = data.logEntry ? data.logEntry.toString() : data.error;
|
|
46
|
+
* Exception logging intended to replace to logError.
|
|
47
|
+
*
|
|
48
|
+
* @remarks
|
|
49
|
+
* Uses the `ILogErrorData` interface to prevent excessive undefined parameters
|
|
50
|
+
* when calling this function.
|
|
51
|
+
* This should be used whenever you want to log something that might in future help to
|
|
52
|
+
* debug failures.
|
|
53
|
+
* It will also be uploaded to the server immediately and not wait for next batch log upload.
|
|
54
|
+
*/ static logErrorData(data) {
|
|
55
|
+
_spcorelibrary.Validate.isNotNullOrUndefined(data.error, 'error');
|
|
56
|
+
const errorInfo = data.logEntry ? data.logEntry.toString() : data.error;
|
|
58
57
|
this._log(data.source, errorInfo, data.eventName, true, data.resultCode, data.serviceScope);
|
|
59
|
-
}
|
|
58
|
+
}
|
|
60
59
|
/**
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
sp_core_library_1.Validate.isNonemptyString(message, 'message');
|
|
60
|
+
* Trace logging
|
|
61
|
+
* The idea here is that verbose logs don't get uploaded to the server unless
|
|
62
|
+
* a failure is logged using ErrorHelper.log method.
|
|
63
|
+
* There is a circular buffer that holds last 50 verbose logs from all scenarios and
|
|
64
|
+
* it is only flushed and uploaded in case a failure is logged.
|
|
65
|
+
* That way whenever you get a failure event with message you also have all supportive verbose messages
|
|
66
|
+
* you logged throughout your scenario execution (or other scenarios).
|
|
67
|
+
* And hopefully that would help you get to the bottom of what exactly went wrong.
|
|
68
|
+
* If no failure happens and your scenario succeeds, verbose logs will be just left in the buffer
|
|
69
|
+
* and most likely overriden by next scenario that logs something verbose.
|
|
70
|
+
**/ static logVerbose(source, message, eventName) {
|
|
71
|
+
_spcorelibrary.Validate.isNonemptyString(message, 'message');
|
|
74
72
|
this._log(source, message, eventName, false, undefined);
|
|
75
|
-
}
|
|
73
|
+
}
|
|
76
74
|
/**
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
var message = data.logEntry ? data.logEntry.toString() : data.message;
|
|
75
|
+
* Verbose logging intended to replace to logVerbose.
|
|
76
|
+
* The idea here is that verbose logs don't get uploaded to the server unless
|
|
77
|
+
* a failure is logged using ErrorHelper.log method.
|
|
78
|
+
* There is a circular buffer that holds last 50 verbose logs from all scenarios and
|
|
79
|
+
* it is only flushed and uploaded in case a failure is logged.
|
|
80
|
+
* That way whenever you get a failure event with message you also have all supportive verbose messages
|
|
81
|
+
* you logged throughout your scenario execution (or other scenarios).
|
|
82
|
+
* And hopefully that would help you get to the bottom of what exactly went wrong.
|
|
83
|
+
* If no failure happens and your scenario succeeds, verbose logs will be just left in the buffer
|
|
84
|
+
* and most likely overridden by next scenario that logs something verbose.
|
|
85
|
+
*/ static logVerboseData(data) {
|
|
86
|
+
const message = data.logEntry ? data.logEntry.toString() : data.message;
|
|
90
87
|
this._log(data.source, message, data.eventName, false, undefined, data.serviceScope);
|
|
91
|
-
}
|
|
88
|
+
}
|
|
92
89
|
/**
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
sp_core_library_1.Validate.isNotNullOrUndefined(logEntry, 'logEntry');
|
|
90
|
+
* Exception logging With LogEntry
|
|
91
|
+
* error message should be packed into logProperties
|
|
92
|
+
* LogType should be LogType.Error and LogProperties should have `{error:errorMessage}`
|
|
93
|
+
* Do NOT add PII data!
|
|
94
|
+
**/ static logErrorWithLogEntry(source, logEntry, eventName, resultCode) {
|
|
95
|
+
_spcorelibrary.Validate.isNotNullOrUndefined(source, 'source');
|
|
96
|
+
_spcorelibrary.Validate.isNotNullOrUndefined(logEntry, 'logEntry');
|
|
101
97
|
this._log(source, logEntry.toString(), eventName, true, resultCode);
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
}
|
|
123
|
-
TraceLogger._shouldWriteToConsole = shouldWrite;
|
|
124
|
-
},
|
|
125
|
-
enumerable: false,
|
|
126
|
-
configurable: true
|
|
127
|
-
});
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Indicates if the log entries should be output to the console.
|
|
101
|
+
* This flag is set to true by default.
|
|
102
|
+
*
|
|
103
|
+
* Toggles console output functionality.
|
|
104
|
+
* Property can be changed by remote caller.
|
|
105
|
+
*/ static get shouldWriteToConsole() {
|
|
106
|
+
return TraceLogger._shouldWriteToConsole;
|
|
107
|
+
}
|
|
108
|
+
static set shouldWriteToConsole(shouldWrite) {
|
|
109
|
+
if (TraceLogger._shouldWriteToConsole && !shouldWrite) {
|
|
110
|
+
TraceLogger._logManager.removeHandler(TraceLogger._defaultLogger.log);
|
|
111
|
+
TraceLogger._verboseLogManager.removeHandler(TraceLogger._defaultLogger.verbose);
|
|
112
|
+
} else if (!TraceLogger._shouldWriteToConsole && shouldWrite) {
|
|
113
|
+
TraceLogger._logManager.addHandler(TraceLogger._defaultLogger.log);
|
|
114
|
+
TraceLogger._verboseLogManager.addHandler(TraceLogger._defaultLogger.verbose);
|
|
115
|
+
}
|
|
116
|
+
TraceLogger._shouldWriteToConsole = shouldWrite;
|
|
117
|
+
}
|
|
128
118
|
/*
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
sp_core_library_1.Validate.isNotNullOrUndefined(logEntry, 'LogEntry');
|
|
119
|
+
* Trace logging with `LogEntry`
|
|
120
|
+
* The same with above other than wrapped log into `logEntry`
|
|
121
|
+
* Trace message should be packed into `logProperties`
|
|
122
|
+
* `LogType` should be `LogType.Trace` and LogProperties should have something like `{errors:errorMessage}`
|
|
123
|
+
* Do NOT add PII data!
|
|
124
|
+
**/ static logVerboseWithLogEntry(source, logEntry, eventName) {
|
|
125
|
+
_spcorelibrary.Validate.isNotNullOrUndefined(logEntry, 'LogEntry');
|
|
137
126
|
this._log(source, logEntry.toString(), eventName, false, undefined);
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
127
|
+
}
|
|
128
|
+
static _log(source, data, eventName, isError, resultCode, serviceScope) {
|
|
129
|
+
const enhancedEventName = this._addEventPrefix(source, eventName);
|
|
130
|
+
let logEvent;
|
|
142
131
|
if (isError) {
|
|
143
|
-
logEvent =
|
|
144
|
-
TraceLogger._logManager.log({
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
132
|
+
logEvent = _LogEvent.default.log(enhancedEventName, data, _LogLevel.LogLevel.Error, serviceScope);
|
|
133
|
+
TraceLogger._logManager.log({
|
|
134
|
+
data: data,
|
|
135
|
+
eventName: logEvent.prefix,
|
|
136
|
+
resultCode: resultCode
|
|
137
|
+
});
|
|
138
|
+
} else {
|
|
139
|
+
logEvent = _LogEvent.default.log(enhancedEventName, data.toString(), _LogLevel.LogLevel.Verbose, serviceScope);
|
|
140
|
+
TraceLogger._verboseLogManager.log({
|
|
141
|
+
data: data,
|
|
142
|
+
eventName: logEvent.prefix
|
|
143
|
+
});
|
|
149
144
|
}
|
|
150
|
-
if (TraceLogger.shouldWriteToConsole ||
|
|
145
|
+
if (TraceLogger.shouldWriteToConsole || DEBUG && !DEPRECATED_UNIT_TEST) {
|
|
151
146
|
this._writeToConsole(logEvent, isError, resultCode);
|
|
152
147
|
}
|
|
153
|
-
}
|
|
148
|
+
}
|
|
154
149
|
/*
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
TraceLogger._addEventPrefix = function (source, eventName) {
|
|
150
|
+
* EventName is:
|
|
151
|
+
* sourceId.eventName or sourceId if eventName is not provided.
|
|
152
|
+
*/ static _addEventPrefix(source, eventName) {
|
|
159
153
|
if (!eventName) {
|
|
160
154
|
return source.id;
|
|
155
|
+
} else {
|
|
156
|
+
return `${source.id}.${eventName}`;
|
|
161
157
|
}
|
|
162
|
-
|
|
163
|
-
return "".concat(source.id, ".").concat(eventName);
|
|
164
|
-
}
|
|
165
|
-
};
|
|
158
|
+
}
|
|
166
159
|
/*
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
TraceLogger._writeToConsole = function (logEvent, isError, resultCode) {
|
|
160
|
+
* The log message in console is:
|
|
161
|
+
* `[eventName]: data`.
|
|
162
|
+
*/ static _writeToConsole(logEvent, isError, resultCode) {
|
|
171
163
|
// @todo (SPPPLAT VSO#250083): This date should be a part of the logEvent.
|
|
172
|
-
|
|
164
|
+
let errorString = logEvent.toString();
|
|
173
165
|
if (resultCode) {
|
|
174
|
-
errorString +=
|
|
166
|
+
errorString += `. resultCode: ${resultCode}`;
|
|
175
167
|
}
|
|
176
168
|
// Task 191596: only write to console when a condition is satisfied (e.g., a query parameter provided).
|
|
177
169
|
if (isError) {
|
|
178
170
|
// eslint-disable-next-line no-console
|
|
179
171
|
console.error(errorString);
|
|
180
|
-
}
|
|
181
|
-
else {
|
|
172
|
+
} else {
|
|
182
173
|
// eslint-disable-next-line no-console
|
|
183
174
|
console.log(errorString);
|
|
184
175
|
}
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
}());
|
|
198
|
-
exports.default = TraceLogger;
|
|
199
|
-
//# sourceMappingURL=TraceLogger.js.map
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Allows process trace log events.
|
|
180
|
+
*/ TraceLogger._logManager = new _LogManager.default();
|
|
181
|
+
/**
|
|
182
|
+
* Allows process verbose trace log events.
|
|
183
|
+
*/ TraceLogger._verboseLogManager = new _LogManager.default();
|
|
184
|
+
TraceLogger._defaultLogger = new _DefaultTraceHandler.default();
|
|
185
|
+
TraceLogger._shouldWriteToConsole = false;
|
|
186
|
+
|
|
187
|
+
//# sourceMappingURL=./TraceLogger.js.map
|
|
@@ -1,85 +1,70 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
* Diagnostics contains a set of internal APIs that collects data and reports data via
|
|
10
|
-
* the pipeline. The APIs consist of
|
|
11
|
-
* -- TraceLogger - for logging diagnostic information
|
|
12
|
-
*
|
|
13
|
-
* @internal
|
|
14
|
-
*/
|
|
15
|
-
var Diagnostics = /** @class */ (function () {
|
|
16
|
-
function Diagnostics() {
|
|
2
|
+
Object.defineProperty(exports, "__esModule", {
|
|
3
|
+
value: true
|
|
4
|
+
});
|
|
5
|
+
Object.defineProperty(exports, "default", {
|
|
6
|
+
enumerable: true,
|
|
7
|
+
get: function() {
|
|
8
|
+
return Diagnostics;
|
|
17
9
|
}
|
|
10
|
+
});
|
|
11
|
+
const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
|
|
12
|
+
const _spcorelibrary = require("@microsoft/sp-core-library");
|
|
13
|
+
const _DiagnosticsSettingsManager = /*#__PURE__*/ _interop_require_default._(require("./DiagnosticsSettingsManager"));
|
|
14
|
+
const _TraceLogger = /*#__PURE__*/ _interop_require_default._(require("./Api/Trace/TraceLogger"));
|
|
15
|
+
class Diagnostics {
|
|
18
16
|
/**
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
Diagnostics.initialize = function (settings) {
|
|
17
|
+
* Initializes the diagnostics pipelines
|
|
18
|
+
*/ static initialize(settings) {
|
|
22
19
|
if (!Diagnostics._isInitialized) {
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
log:
|
|
27
|
-
|
|
20
|
+
_DiagnosticsSettingsManager.default.initialize(settings);
|
|
21
|
+
_TraceLogger.default.shouldWriteToConsole = settings.enableConsoleLog;
|
|
22
|
+
_TraceLogger.default._addHandler({
|
|
23
|
+
log: (traceEvent)=>{
|
|
24
|
+
_spcorelibrary.Log.info(traceEvent.eventName, `EventName:${traceEvent.data.toString()}, ResultCode: ${traceEvent.resultCode}`);
|
|
28
25
|
},
|
|
29
|
-
verbose:
|
|
30
|
-
|
|
26
|
+
verbose: (traceEvent)=>{
|
|
27
|
+
_spcorelibrary.Log.verbose(traceEvent.eventName, traceEvent.data.toString());
|
|
31
28
|
}
|
|
32
29
|
});
|
|
33
30
|
Diagnostics._isInitialized = true;
|
|
34
31
|
}
|
|
35
|
-
}
|
|
36
|
-
Object.defineProperty(Diagnostics, "isInitialized", {
|
|
37
|
-
/**
|
|
38
|
-
* Returns true if diagnostics has been already initialized.
|
|
39
|
-
*/
|
|
40
|
-
get: function () {
|
|
41
|
-
return this._isInitialized;
|
|
42
|
-
},
|
|
43
|
-
enumerable: false,
|
|
44
|
-
configurable: true
|
|
45
|
-
});
|
|
32
|
+
}
|
|
46
33
|
/**
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
Diagnostics.updateSettings = function (settings) {
|
|
52
|
-
DiagnosticsSettingsManager_1.default.updateSettings(settings);
|
|
53
|
-
};
|
|
34
|
+
* Returns true if diagnostics has been already initialized.
|
|
35
|
+
*/ static get isInitialized() {
|
|
36
|
+
return this._isInitialized;
|
|
37
|
+
}
|
|
54
38
|
/**
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
return (_b = (_a = DiagnosticsSettingsManager_1.default.settings) === null || _a === void 0 ? void 0 : _a.extraDiagnosticInfo) === null || _b === void 0 ? void 0 : _b.authoringSessionClientCount;
|
|
62
|
-
};
|
|
39
|
+
* Used to refresh the telemetry settings when they change from the application
|
|
40
|
+
* (i.e. when an in-place navigation to a different site happens)
|
|
41
|
+
* @param settings - the subset of the telemetry settings to be updated
|
|
42
|
+
*/ static updateSettings(settings) {
|
|
43
|
+
_DiagnosticsSettingsManager.default.updateSettings(settings);
|
|
44
|
+
}
|
|
63
45
|
/**
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
return (_a = DiagnosticsSettingsManager_1.default.settings) === null || _a === void 0 ? void 0 : _a.extraDiagnosticInfo;
|
|
71
|
-
};
|
|
46
|
+
* Get the authoring session client count info from the extraDiagnosticsInfo from Diagnostics settings
|
|
47
|
+
* @deprecated - Read from @see getExtraDiagnosticInfo
|
|
48
|
+
* @returns the number of clients in the authoring session
|
|
49
|
+
*/ static getAuthoringSessionClientCountInfo() {
|
|
50
|
+
return _DiagnosticsSettingsManager.default.settings?.extraDiagnosticInfo?.authoringSessionClientCount;
|
|
51
|
+
}
|
|
72
52
|
/**
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
53
|
+
* Get the extra diagnostic info for logging purpose.
|
|
54
|
+
* @internal
|
|
55
|
+
* @returns @see IExtraDiagnosticInfo
|
|
56
|
+
*/ static _getExtraDiagnosticInfo() {
|
|
57
|
+
return _DiagnosticsSettingsManager.default.settings?.extraDiagnosticInfo;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Used to delete telemetry settings when they are no longer needed or need to be reset.
|
|
61
|
+
* The current updateSettings implementation does not support un-setting previously
|
|
62
|
+
* set settings values.
|
|
63
|
+
* @param settings - the subset of the telemetry settings to be cleared.
|
|
64
|
+
*/ static clearSettings(settings) {
|
|
65
|
+
_DiagnosticsSettingsManager.default.clearSettings(settings);
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
Diagnostics._isInitialized = false;
|
|
69
|
+
|
|
70
|
+
//# sourceMappingURL=./Diagnostics.js.map
|
|
@@ -1,52 +1,47 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
* @internal
|
|
10
|
-
*/
|
|
11
|
-
var DiagnosticsSettingsManager = /** @class */ (function () {
|
|
12
|
-
function DiagnosticsSettingsManager() {
|
|
2
|
+
Object.defineProperty(exports, "__esModule", {
|
|
3
|
+
value: true
|
|
4
|
+
});
|
|
5
|
+
Object.defineProperty(exports, "default", {
|
|
6
|
+
enumerable: true,
|
|
7
|
+
get: function() {
|
|
8
|
+
return DiagnosticsSettingsManager;
|
|
13
9
|
}
|
|
14
|
-
|
|
15
|
-
|
|
10
|
+
});
|
|
11
|
+
const _spcorelibrary = require("@microsoft/sp-core-library");
|
|
12
|
+
const _splodashsubset = require("@microsoft/sp-lodash-subset");
|
|
13
|
+
class DiagnosticsSettingsManager {
|
|
14
|
+
static initialize(settings) {
|
|
15
|
+
this.settings = (0, _splodashsubset.cloneDeep)(settings);
|
|
16
16
|
this._initialized = true;
|
|
17
17
|
this._normalizeContextIds();
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
this.settings = (0,
|
|
18
|
+
}
|
|
19
|
+
static updateSettings(settings) {
|
|
20
|
+
this.settings = (0, _splodashsubset.merge)(this.settings, settings);
|
|
21
21
|
this._normalizeContextIds();
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
var _this = this;
|
|
22
|
+
}
|
|
23
|
+
static clearSettings(settings) {
|
|
25
24
|
if (settings.diagnosticSettings) {
|
|
26
|
-
settings.diagnosticSettings.forEach(
|
|
27
|
-
delete
|
|
25
|
+
settings.diagnosticSettings.forEach((setting)=>{
|
|
26
|
+
delete this.settings[setting];
|
|
28
27
|
});
|
|
29
28
|
}
|
|
30
29
|
if (settings.extraDiagnosticInfo) {
|
|
31
|
-
settings.extraDiagnosticInfo.forEach(
|
|
32
|
-
if (
|
|
33
|
-
delete
|
|
30
|
+
settings.extraDiagnosticInfo.forEach((info)=>{
|
|
31
|
+
if (this.settings.extraDiagnosticInfo && this.settings.extraDiagnosticInfo[info]) {
|
|
32
|
+
delete this.settings.extraDiagnosticInfo[info];
|
|
34
33
|
}
|
|
35
34
|
});
|
|
36
35
|
}
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
var guid = sp_core_library_1.Guid.tryParse(id);
|
|
47
|
-
return (guid === null || guid === void 0 ? void 0 : guid.toString()) || id;
|
|
48
|
-
};
|
|
49
|
-
DiagnosticsSettingsManager._normalizeContextIds = function () {
|
|
36
|
+
}
|
|
37
|
+
static get isInitialized() {
|
|
38
|
+
return this._initialized;
|
|
39
|
+
}
|
|
40
|
+
static _normalizeId(id) {
|
|
41
|
+
const guid = _spcorelibrary.Guid.tryParse(id);
|
|
42
|
+
return guid?.toString() || id;
|
|
43
|
+
}
|
|
44
|
+
static _normalizeContextIds() {
|
|
50
45
|
this.settings.siteId = this._normalizeId(this.settings.siteId);
|
|
51
46
|
this.settings.webId = this._normalizeId(this.settings.webId);
|
|
52
47
|
this.settings.correlationId = this._normalizeId(this.settings.correlationId);
|
|
@@ -56,9 +51,8 @@ var DiagnosticsSettingsManager = /** @class */ (function () {
|
|
|
56
51
|
this.settings.listItemUniqueId = this._normalizeId(this.settings.listItemUniqueId);
|
|
57
52
|
}
|
|
58
53
|
}
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
//# sourceMappingURL=DiagnosticsSettingsManager.js.map
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
DiagnosticsSettingsManager._initialized = false;
|
|
57
|
+
|
|
58
|
+
//# sourceMappingURL=./DiagnosticsSettingsManager.js.map
|
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
Object.defineProperty(exports, "__esModule", {
|
|
3
|
+
value: true
|
|
4
|
+
});
|
|
5
|
+
Object.defineProperty(exports, "isAppendSuffixIfBrowserIsOfflineAtLoggingTimeKsActive", {
|
|
6
|
+
enumerable: true,
|
|
7
|
+
get: function() {
|
|
8
|
+
return isAppendSuffixIfBrowserIsOfflineAtLoggingTimeKsActive;
|
|
9
|
+
}
|
|
10
|
+
});
|
|
11
|
+
const _spcorelibrary = require("@microsoft/sp-core-library");
|
|
6
12
|
function isAppendSuffixIfBrowserIsOfflineAtLoggingTimeKsActive() {
|
|
7
|
-
return
|
|
8
|
-
/* '06/25/2025', 'atagle -appends the " (offline)" suffix to the ASHA error code name the browser is offline at the time of logging' */
|
|
9
|
-
);
|
|
13
|
+
return _spcorelibrary._SPKillSwitch.isActivated('c125685f-83e7-44c8-b602-5c21f5b748ae');
|
|
10
14
|
}
|
|
11
|
-
|
|
12
|
-
//# sourceMappingURL
|
|
15
|
+
|
|
16
|
+
//# sourceMappingURL=./Killswitches.js.map
|