@microsoft/applicationinsights-common 2.8.4-nightly.2205-09 → 2.8.5-nightly.2206-02

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.
Files changed (103) hide show
  1. package/browser/applicationinsights-common.integrity.json +9 -9
  2. package/browser/applicationinsights-common.js +174 -127
  3. package/browser/applicationinsights-common.js.map +1 -1
  4. package/browser/applicationinsights-common.min.js +2 -2
  5. package/browser/applicationinsights-common.min.js.map +1 -1
  6. package/dist/applicationinsights-common.api.json +81 -501
  7. package/dist/applicationinsights-common.api.md +24 -23
  8. package/dist/applicationinsights-common.d.ts +33 -91
  9. package/dist/applicationinsights-common.js +174 -127
  10. package/dist/applicationinsights-common.js.map +1 -1
  11. package/dist/applicationinsights-common.min.js +2 -2
  12. package/dist/applicationinsights-common.min.js.map +1 -1
  13. package/dist/applicationinsights-common.rollup.d.ts +33 -91
  14. package/dist-esm/ConnectionStringParser.js +1 -1
  15. package/dist-esm/Constants.js +1 -1
  16. package/dist-esm/DomHelperFuncs.js +1 -1
  17. package/dist-esm/Enums.js +1 -1
  18. package/dist-esm/HelperFuncs.js +1 -1
  19. package/dist-esm/Interfaces/ConnectionString.js +1 -1
  20. package/dist-esm/Interfaces/Context/IApplication.js +1 -1
  21. package/dist-esm/Interfaces/Context/IDevice.js +1 -1
  22. package/dist-esm/Interfaces/Context/IInternal.js +1 -1
  23. package/dist-esm/Interfaces/Context/ILocation.js +1 -1
  24. package/dist-esm/Interfaces/Context/IOperatingSystem.js +1 -1
  25. package/dist-esm/Interfaces/Context/ISample.js +1 -1
  26. package/dist-esm/Interfaces/Context/ISession.js +1 -1
  27. package/dist-esm/Interfaces/Context/ITelemetryTrace.js +1 -1
  28. package/dist-esm/Interfaces/Context/IUser.js +1 -1
  29. package/dist-esm/Interfaces/Context/IWeb.js +1 -1
  30. package/dist-esm/Interfaces/Contracts/AvailabilityData.js +1 -1
  31. package/dist-esm/Interfaces/Contracts/ContextTagKeys.js +1 -1
  32. package/dist-esm/Interfaces/Contracts/DataPointType.js +1 -1
  33. package/dist-esm/Interfaces/Contracts/DependencyKind.js +1 -1
  34. package/dist-esm/Interfaces/Contracts/DependencySourceType.js +1 -1
  35. package/dist-esm/Interfaces/Contracts/IBase.js +1 -1
  36. package/dist-esm/Interfaces/Contracts/IData.js +1 -1
  37. package/dist-esm/Interfaces/Contracts/IDataPoint.js +1 -1
  38. package/dist-esm/Interfaces/Contracts/IDomain.js +1 -1
  39. package/dist-esm/Interfaces/Contracts/IEnvelope.js +1 -1
  40. package/dist-esm/Interfaces/Contracts/IEventData.js +1 -1
  41. package/dist-esm/Interfaces/Contracts/IExceptionData.js +1 -1
  42. package/dist-esm/Interfaces/Contracts/IExceptionDetails.js +1 -1
  43. package/dist-esm/Interfaces/Contracts/IMessageData.js +1 -1
  44. package/dist-esm/Interfaces/Contracts/IMetricData.js +1 -1
  45. package/dist-esm/Interfaces/Contracts/IPageViewData.js +1 -1
  46. package/dist-esm/Interfaces/Contracts/IPageViewPerfData.js +1 -1
  47. package/dist-esm/Interfaces/Contracts/IRemoteDependencyData.js +1 -1
  48. package/dist-esm/Interfaces/Contracts/IStackFrame.js +1 -1
  49. package/dist-esm/Interfaces/Contracts/RequestData.js +1 -1
  50. package/dist-esm/Interfaces/Contracts/SeverityLevel.js +1 -1
  51. package/dist-esm/Interfaces/IAppInsights.js +1 -1
  52. package/dist-esm/Interfaces/IChannelControlsAI.js +1 -1
  53. package/dist-esm/Interfaces/IConfig.js +1 -1
  54. package/dist-esm/Interfaces/ICorrelationConfig.js +1 -1
  55. package/dist-esm/Interfaces/IDependencyTelemetry.js +1 -1
  56. package/dist-esm/Interfaces/IEventTelemetry.js +1 -1
  57. package/dist-esm/Interfaces/IExceptionTelemetry.js +1 -1
  58. package/dist-esm/Interfaces/IMetricTelemetry.js +1 -1
  59. package/dist-esm/Interfaces/IPageViewPerformanceTelemetry.js +1 -1
  60. package/dist-esm/Interfaces/IPageViewTelemetry.js +1 -1
  61. package/dist-esm/Interfaces/IPartC.js +1 -1
  62. package/dist-esm/Interfaces/IPropertiesPlugin.js +1 -1
  63. package/dist-esm/Interfaces/IRequestContext.js +1 -1
  64. package/dist-esm/Interfaces/ITelemetryContext.js +1 -1
  65. package/dist-esm/Interfaces/ITraceTelemetry.js +1 -1
  66. package/dist-esm/Interfaces/PartAExtensions.js +1 -1
  67. package/dist-esm/Interfaces/Telemetry/IEnvelope.js +1 -1
  68. package/dist-esm/Interfaces/Telemetry/ISerializable.js +1 -1
  69. package/dist-esm/RequestResponseHeaders.js +1 -1
  70. package/dist-esm/StorageHelperFuncs.js +1 -1
  71. package/dist-esm/Telemetry/Common/Data.js +1 -1
  72. package/dist-esm/Telemetry/Common/DataPoint.js +1 -1
  73. package/dist-esm/Telemetry/Common/DataSanitizer.js +1 -1
  74. package/dist-esm/Telemetry/Common/Envelope.js +1 -1
  75. package/dist-esm/Telemetry/Event.js +1 -1
  76. package/dist-esm/Telemetry/Exception.js +1 -1
  77. package/dist-esm/Telemetry/Metric.js +1 -1
  78. package/dist-esm/Telemetry/PageView.js +1 -1
  79. package/dist-esm/Telemetry/PageViewPerformance.js +1 -1
  80. package/dist-esm/Telemetry/RemoteDependencyData.js +1 -1
  81. package/dist-esm/Telemetry/Trace.js +1 -1
  82. package/dist-esm/TelemetryItemCreator.js +1 -1
  83. package/dist-esm/UrlHelperFuncs.js +1 -1
  84. package/dist-esm/Util.js +45 -2
  85. package/dist-esm/Util.js.map +1 -1
  86. package/dist-esm/applicationinsights-common.js +3 -4
  87. package/dist-esm/applicationinsights-common.js.map +1 -1
  88. package/package.json +2 -2
  89. package/src/Interfaces/Context/ITelemetryTrace.ts +6 -0
  90. package/src/Util.ts +49 -2
  91. package/src/applicationinsights-common.ts +6 -6
  92. package/types/Interfaces/Context/ITelemetryTrace.d.ts +5 -0
  93. package/types/Util.d.ts +9 -1
  94. package/types/applicationinsights-common.d.ts +2 -4
  95. package/types/tsdoc-metadata.json +1 -1
  96. package/dist-esm/Interfaces/ITraceParent.js +0 -8
  97. package/dist-esm/Interfaces/ITraceParent.js.map +0 -1
  98. package/dist-esm/W3cTraceParent.js +0 -192
  99. package/dist-esm/W3cTraceParent.js.map +0 -1
  100. package/src/Interfaces/ITraceParent.ts +0 -38
  101. package/src/W3cTraceParent.ts +0 -219
  102. package/types/Interfaces/ITraceParent.d.ts +0 -32
  103. package/types/W3cTraceParent.d.ts +0 -59
@@ -1,192 +0,0 @@
1
- /*
2
- * Application Insights JavaScript SDK - Common, 2.8.4-nightly.2205-09
3
- * Copyright (c) Microsoft and contributors. All rights reserved.
4
- */
5
- import { generateW3CId, getDocument, getPerformance, isArray, isString, strTrim } from "@microsoft/applicationinsights-core-js";
6
- // using {0,16} for leading and trailing whitespace just to constrain the possible runtime of a random string
7
- var TRACE_PARENT_REGEX = /^([\da-f]{2})-([\da-f]{32})-([\da-f]{16})-([\da-f]{2})(-[^\s]*)?$/;
8
- var DEFAULT_VERSION = "00";
9
- var INVALID_VERSION = "ff";
10
- var INVALID_TRACE_ID = "00000000000000000000000000000000";
11
- var INVALID_SPAN_ID = "0000000000000000";
12
- var SAMPLED_FLAG = 0x01;
13
- function _isValid(value, len, invalidValue) {
14
- if (value && value.length === len && value !== invalidValue) {
15
- return !!value.match(/^[\da-f]*$/);
16
- }
17
- return false;
18
- }
19
- function _formatValue(value, len, defValue) {
20
- if (_isValid(value, len)) {
21
- return value;
22
- }
23
- return defValue;
24
- }
25
- function _formatFlags(value) {
26
- if (isNaN(value) || value < 0 || value > 255) {
27
- value = 0x01;
28
- }
29
- var result = value.toString(16);
30
- while (result.length < 2) {
31
- result = "0" + result;
32
- }
33
- return result;
34
- }
35
- function _getTraceParentValue(values) {
36
- if (values) {
37
- for (var i = 0; i < values.length; i++) {
38
- var value = values[i];
39
- if (value.name) {
40
- if (value.name === "traceparent") {
41
- return value;
42
- }
43
- }
44
- }
45
- }
46
- return {};
47
- }
48
- /**
49
- * Create a new ITraceParent instance using the provided values.
50
- * @param traceId - The traceId to use, when invalid a new random W3C id will be generated.
51
- * @param spanId - The parent/span id to use, a new random value will be generated if it is invalid.
52
- * @param flags - The traceFlags to use, defaults to zero (0) if not supplied or invalid
53
- * @param version - The version to used, defaults to version "01" if not supplied or invalid.
54
- * @returns
55
- */
56
- export function createTraceParent(traceId, spanId, flags, version) {
57
- return {
58
- version: _isValid(version, 2, INVALID_VERSION) ? version : DEFAULT_VERSION,
59
- traceId: isValidTraceId(traceId) ? traceId : generateW3CId(),
60
- spanId: isValidSpanId(spanId) ? spanId : generateW3CId().substr(0, 16),
61
- traceFlags: flags >= 0 && flags <= 0xFF ? flags : 1
62
- };
63
- }
64
- /**
65
- * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)
66
- *
67
- * @param value
68
- * @returns
69
- */
70
- export function parseTraceParent(value) {
71
- if (!value) {
72
- // Don't pass a null/undefined or empty string
73
- return null;
74
- }
75
- if (isArray(value)) {
76
- // The value may have been encoded on the page into an array so handle this automatically
77
- value = value[0] || "";
78
- }
79
- if (!value || !isString(value) || value.length > 8192) {
80
- // limit potential processing based on total length
81
- return null;
82
- }
83
- // See https://www.w3.org/TR/trace-context/#versioning-of-traceparent
84
- var match = TRACE_PARENT_REGEX.exec(strTrim(value));
85
- if (!match || // No match
86
- match[1] === INVALID_VERSION || // version ff is forbidden
87
- match[2] === INVALID_TRACE_ID || // All zeros is considered to be invalid
88
- match[3] === INVALID_SPAN_ID) { // All zeros is considered to be invalid
89
- return null;
90
- }
91
- return {
92
- version: match[1],
93
- traceId: match[2],
94
- spanId: match[3],
95
- traceFlags: parseInt(match[4], 16)
96
- };
97
- }
98
- /**
99
- * Is the provided W3c Trace Id a valid string representation, it must be a 32-character string
100
- * of lowercase hexadecimal characters for example, 4bf92f3577b34da6a3ce929d0e0e4736.
101
- * If all characters as zero (00000000000000000000000000000000) it will be considered an invalid value.
102
- * @param value - The W3c trace Id to be validated
103
- * @returns true if valid otherwise false
104
- */
105
- export function isValidTraceId(value) {
106
- return _isValid(value, 32, INVALID_TRACE_ID);
107
- }
108
- /**
109
- * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character
110
- * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
111
- * If all characters are zero (0000000000000000) this is considered an invalid value.
112
- * @param value - The W3c span id to be validated
113
- * @returns true if valid otherwise false
114
- */
115
- export function isValidSpanId(value) {
116
- return _isValid(value, 16, INVALID_SPAN_ID);
117
- }
118
- /**
119
- * Validates that the provided ITraceParent instance conforms to the currently supported specifications
120
- * @param value
121
- * @returns
122
- */
123
- export function isValidTraceParent(value) {
124
- if (!value ||
125
- !_isValid(value.version, 2, INVALID_VERSION) ||
126
- !_isValid(value.traceId, 32, INVALID_TRACE_ID) ||
127
- !_isValid(value.spanId, 16, INVALID_SPAN_ID) ||
128
- !_isValid(_formatFlags(value.traceFlags), 2)) {
129
- // Each known field must contain a valid value
130
- return false;
131
- }
132
- return true;
133
- }
134
- /**
135
- * Is the parsed traceParent indicating that the trace is currently sampled.
136
- * @param value - The parsed traceParent value
137
- * @returns
138
- */
139
- export function isSampledFlag(value) {
140
- if (isValidTraceParent(value)) {
141
- return (value.traceFlags & SAMPLED_FLAG) === SAMPLED_FLAG;
142
- }
143
- return false;
144
- }
145
- /**
146
- * Format the ITraceParent value as a string using the supported and know version formats.
147
- * So even if the passed traceParent is a later version the string value returned from this
148
- * function will convert it to only the known version formats.
149
- * This currently only supports version "00" and invalid "ff"
150
- * @param value - The parsed traceParent value
151
- * @returns
152
- */
153
- export function formatTraceParent(value) {
154
- if (value) {
155
- // Special Note: This only supports formatting as version 00, future versions should encode any known supported version
156
- // So parsing a future version will populate the correct version value but reformatting will reduce it to version 00.
157
- var flags = _formatFlags(value.traceFlags);
158
- if (!_isValid(flags, 2)) {
159
- flags = "01";
160
- }
161
- var version = value.version || DEFAULT_VERSION;
162
- if (version !== "00" && version !== "ff") {
163
- // Reduce version to "00"
164
- version = DEFAULT_VERSION;
165
- }
166
- // Format as version 00
167
- return "".concat(version, "-").concat(_formatValue(value.traceId, 32, INVALID_TRACE_ID), "-").concat(_formatValue(value.spanId, 16, INVALID_SPAN_ID), "-").concat(flags);
168
- }
169
- return "";
170
- }
171
- /**
172
- * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.
173
- * @returns
174
- */
175
- export function findW3cTraceParent() {
176
- var traceParent;
177
- var doc = getDocument();
178
- if (doc) {
179
- // Look for a meta-tag called "traceparent"
180
- traceParent = parseTraceParent(_getTraceParentValue(doc.querySelectorAll("meta")).content);
181
- }
182
- if (!traceParent) {
183
- var perf = getPerformance();
184
- if (perf) {
185
- // Try looking for a server-timing header
186
- var navPerf = perf.getEntriesByType("navigation") || [];
187
- traceParent = parseTraceParent(_getTraceParentValue((navPerf.length > 0 ? navPerf[0] : {}).serverTiming).description);
188
- }
189
- }
190
- return traceParent;
191
- }
192
- //# sourceMappingURL=W3cTraceParent.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"W3cTraceParent.js.map","sources":["W3cTraceParent.js"],"sourcesContent":["import { generateW3CId, getDocument, getPerformance, isArray, isString, strTrim } from \"@microsoft/applicationinsights-core-js\";\r\n// using {0,16} for leading and trailing whitespace just to constrain the possible runtime of a random string\r\nvar TRACE_PARENT_REGEX = /^([\\da-f]{2})-([\\da-f]{32})-([\\da-f]{16})-([\\da-f]{2})(-[^\\s]*)?$/;\r\nvar DEFAULT_VERSION = \"00\";\r\nvar INVALID_VERSION = \"ff\";\r\nvar INVALID_TRACE_ID = \"00000000000000000000000000000000\";\r\nvar INVALID_SPAN_ID = \"0000000000000000\";\r\nvar SAMPLED_FLAG = 0x01;\r\nfunction _isValid(value, len, invalidValue) {\r\n if (value && value.length === len && value !== invalidValue) {\r\n return !!value.match(/^[\\da-f]*$/);\r\n }\r\n return false;\r\n}\r\nfunction _formatValue(value, len, defValue) {\r\n if (_isValid(value, len)) {\r\n return value;\r\n }\r\n return defValue;\r\n}\r\nfunction _formatFlags(value) {\r\n if (isNaN(value) || value < 0 || value > 255) {\r\n value = 0x01;\r\n }\r\n var result = value.toString(16);\r\n while (result.length < 2) {\r\n result = \"0\" + result;\r\n }\r\n return result;\r\n}\r\nfunction _getTraceParentValue(values) {\r\n if (values) {\r\n for (var i = 0; i < values.length; i++) {\r\n var value = values[i];\r\n if (value.name) {\r\n if (value.name === \"traceparent\") {\r\n return value;\r\n }\r\n }\r\n }\r\n }\r\n return {};\r\n}\r\n/**\r\n * Create a new ITraceParent instance using the provided values.\r\n * @param traceId - The traceId to use, when invalid a new random W3C id will be generated.\r\n * @param spanId - The parent/span id to use, a new random value will be generated if it is invalid.\r\n * @param flags - The traceFlags to use, defaults to zero (0) if not supplied or invalid\r\n * @param version - The version to used, defaults to version \"01\" if not supplied or invalid.\r\n * @returns\r\n */\r\nexport function createTraceParent(traceId, spanId, flags, version) {\r\n return {\r\n version: _isValid(version, 2, INVALID_VERSION) ? version : DEFAULT_VERSION,\r\n traceId: isValidTraceId(traceId) ? traceId : generateW3CId(),\r\n spanId: isValidSpanId(spanId) ? spanId : generateW3CId().substr(0, 16),\r\n traceFlags: flags >= 0 && flags <= 0xFF ? flags : 1\r\n };\r\n}\r\n/**\r\n * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)\r\n *\r\n * @param value\r\n * @returns\r\n */\r\nexport function parseTraceParent(value) {\r\n if (!value) {\r\n // Don't pass a null/undefined or empty string\r\n return null;\r\n }\r\n if (isArray(value)) {\r\n // The value may have been encoded on the page into an array so handle this automatically\r\n value = value[0] || \"\";\r\n }\r\n if (!value || !isString(value) || value.length > 8192) {\r\n // limit potential processing based on total length\r\n return null;\r\n }\r\n // See https://www.w3.org/TR/trace-context/#versioning-of-traceparent\r\n var match = TRACE_PARENT_REGEX.exec(strTrim(value));\r\n if (!match || // No match\r\n match[1] === INVALID_VERSION || // version ff is forbidden\r\n match[2] === INVALID_TRACE_ID || // All zeros is considered to be invalid\r\n match[3] === INVALID_SPAN_ID) { // All zeros is considered to be invalid\r\n return null;\r\n }\r\n return {\r\n version: match[1],\r\n traceId: match[2],\r\n spanId: match[3],\r\n traceFlags: parseInt(match[4], 16)\r\n };\r\n}\r\n/**\r\n * Is the provided W3c Trace Id a valid string representation, it must be a 32-character string\r\n * of lowercase hexadecimal characters for example, 4bf92f3577b34da6a3ce929d0e0e4736.\r\n * If all characters as zero (00000000000000000000000000000000) it will be considered an invalid value.\r\n * @param value - The W3c trace Id to be validated\r\n * @returns true if valid otherwise false\r\n */\r\nexport function isValidTraceId(value) {\r\n return _isValid(value, 32, INVALID_TRACE_ID);\r\n}\r\n/**\r\n * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character\r\n * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.\r\n * If all characters are zero (0000000000000000) this is considered an invalid value.\r\n * @param value - The W3c span id to be validated\r\n * @returns true if valid otherwise false\r\n */\r\nexport function isValidSpanId(value) {\r\n return _isValid(value, 16, INVALID_SPAN_ID);\r\n}\r\n/**\r\n * Validates that the provided ITraceParent instance conforms to the currently supported specifications\r\n * @param value\r\n * @returns\r\n */\r\nexport function isValidTraceParent(value) {\r\n if (!value ||\r\n !_isValid(value.version, 2, INVALID_VERSION) ||\r\n !_isValid(value.traceId, 32, INVALID_TRACE_ID) ||\r\n !_isValid(value.spanId, 16, INVALID_SPAN_ID) ||\r\n !_isValid(_formatFlags(value.traceFlags), 2)) {\r\n // Each known field must contain a valid value\r\n return false;\r\n }\r\n return true;\r\n}\r\n/**\r\n * Is the parsed traceParent indicating that the trace is currently sampled.\r\n * @param value - The parsed traceParent value\r\n * @returns\r\n */\r\nexport function isSampledFlag(value) {\r\n if (isValidTraceParent(value)) {\r\n return (value.traceFlags & SAMPLED_FLAG) === SAMPLED_FLAG;\r\n }\r\n return false;\r\n}\r\n/**\r\n * Format the ITraceParent value as a string using the supported and know version formats.\r\n * So even if the passed traceParent is a later version the string value returned from this\r\n * function will convert it to only the known version formats.\r\n * This currently only supports version \"00\" and invalid \"ff\"\r\n * @param value - The parsed traceParent value\r\n * @returns\r\n */\r\nexport function formatTraceParent(value) {\r\n if (value) {\r\n // Special Note: This only supports formatting as version 00, future versions should encode any known supported version\r\n // So parsing a future version will populate the correct version value but reformatting will reduce it to version 00.\r\n var flags = _formatFlags(value.traceFlags);\r\n if (!_isValid(flags, 2)) {\r\n flags = \"01\";\r\n }\r\n var version = value.version || DEFAULT_VERSION;\r\n if (version !== \"00\" && version !== \"ff\") {\r\n // Reduce version to \"00\"\r\n version = DEFAULT_VERSION;\r\n }\r\n // Format as version 00\r\n return \"\".concat(version, \"-\").concat(_formatValue(value.traceId, 32, INVALID_TRACE_ID), \"-\").concat(_formatValue(value.spanId, 16, INVALID_SPAN_ID), \"-\").concat(flags);\r\n }\r\n return \"\";\r\n}\r\n/**\r\n * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.\r\n * @returns\r\n */\r\nexport function findW3cTraceParent() {\r\n var traceParent;\r\n var doc = getDocument();\r\n if (doc) {\r\n // Look for a meta-tag called \"traceparent\"\r\n traceParent = parseTraceParent(_getTraceParentValue(doc.querySelectorAll(\"meta\")).content);\r\n }\r\n if (!traceParent) {\r\n var perf = getPerformance();\r\n if (perf) {\r\n // Try looking for a server-timing header\r\n var navPerf = perf.getEntriesByType(\"navigation\") || [];\r\n traceParent = parseTraceParent(_getTraceParentValue((navPerf.length > 0 ? navPerf[0] : {}).serverTiming).description);\r\n }\r\n }\r\n return traceParent;\r\n}\r\n//# sourceMappingURL=W3cTraceParent.js.map"],"names":[],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA"}
@@ -1,38 +0,0 @@
1
- // Copyright (c) Microsoft Corporation. All rights reserved.
2
- // Licensed under the MIT License.
3
-
4
- /**
5
- * This interface represents the components of a W3C traceparent header
6
- */
7
- export interface ITraceParent {
8
- /**
9
- * The version of the definition, this MUST be a string with a length of 2 and only contain lowercase
10
- * hexadecimal characters. A value of 'ff' is considered to be an invalid version.
11
- */
12
- version: string;
13
-
14
- /**
15
- * This is the ID of the whole trace forest and is used to uniquely identify a distributed trace
16
- * through a system. It is represented as a 32-character string of lowercase hexadecimal characters,
17
- * for example, 4bf92f3577b34da6a3ce929d0e0e4736.
18
- * All characters as zero (00000000000000000000000000000000) is considered an invalid value.
19
- */
20
- traceId: string;
21
-
22
- /**
23
- * This is the ID of the current request as known by the caller (in some tracing systems, this is also
24
- * known as the parent-id, where a span is the execution of a client request). It is represented as an
25
- * 16-character string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
26
- * All bytes as zero (0000000000000000) is considered an invalid value.
27
- */
28
- spanId: string;
29
-
30
- /**
31
- * An 8-bit value of flags that controls tracing such as sampling, trace level, etc. These flags are
32
- * recommendations given by the caller rather than strict rules to follow.
33
- * As this is a bit field, you cannot interpret flags by decoding the hex value and looking at the resulting
34
- * number. For example, a flag 00000001 could be encoded as 01 in hex, or 09 in hex if present with the flag
35
- * 00001000. A common mistake in bit fields is forgetting to mask when interpreting flags.
36
- */
37
- traceFlags: number;
38
- }
@@ -1,219 +0,0 @@
1
- import { generateW3CId, getDocument, getPerformance, isArray, isString, strTrim } from "@microsoft/applicationinsights-core-js";
2
- import { ITraceParent } from "./Interfaces/ITraceParent";
3
-
4
- // using {0,16} for leading and trailing whitespace just to constrain the possible runtime of a random string
5
- const TRACE_PARENT_REGEX = /^([\da-f]{2})-([\da-f]{32})-([\da-f]{16})-([\da-f]{2})(-[^\s]*)?$/;
6
- const DEFAULT_VERSION = "00";
7
- const INVALID_VERSION = "ff";
8
- const INVALID_TRACE_ID = "00000000000000000000000000000000";
9
- const INVALID_SPAN_ID = "0000000000000000";
10
- const SAMPLED_FLAG = 0x01;
11
-
12
- function _isValid(value: string, len: number, invalidValue?: string): boolean {
13
- if (value && value.length === len && value !== invalidValue) {
14
- return !!value.match(/^[\da-f]*$/);
15
- }
16
-
17
- return false;
18
- }
19
-
20
- function _formatValue(value: string, len: number, defValue: string): string {
21
- if (_isValid(value, len)) {
22
- return value;
23
- }
24
-
25
- return defValue;
26
- }
27
-
28
- function _formatFlags(value: number): string {
29
- if (isNaN(value) || value < 0 || value > 255) {
30
- value = 0x01;
31
- }
32
-
33
- let result = value.toString(16);
34
- while (result.length < 2) {
35
- result = "0" + result;
36
- }
37
-
38
- return result;
39
- }
40
-
41
- function _getTraceParentValue(values: any) {
42
- if (values) {
43
- for (var i = 0; i < values.length; i++) {
44
- var value = values[i] as any;
45
- if (value.name) {
46
- if(value.name === "traceparent") {
47
- return value;
48
- }
49
- }
50
- }
51
- }
52
-
53
- return {};
54
- }
55
-
56
- /**
57
- * Create a new ITraceParent instance using the provided values.
58
- * @param traceId - The traceId to use, when invalid a new random W3C id will be generated.
59
- * @param spanId - The parent/span id to use, a new random value will be generated if it is invalid.
60
- * @param flags - The traceFlags to use, defaults to zero (0) if not supplied or invalid
61
- * @param version - The version to used, defaults to version "01" if not supplied or invalid.
62
- * @returns
63
- */
64
- export function createTraceParent(traceId?: string, spanId?: string, flags?: number, version?: string): ITraceParent {
65
-
66
- return {
67
- version: _isValid(version, 2, INVALID_VERSION) ? version : DEFAULT_VERSION,
68
- traceId: isValidTraceId(traceId) ? traceId : generateW3CId(),
69
- spanId: isValidSpanId(spanId) ? spanId : generateW3CId().substr(0, 16),
70
- traceFlags: flags >= 0 && flags <= 0xFF ? flags : 1
71
- };
72
- }
73
-
74
- /**
75
- * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)
76
- *
77
- * @param value
78
- * @returns
79
- */
80
- export function parseTraceParent(value: string): ITraceParent {
81
- if (!value) {
82
- // Don't pass a null/undefined or empty string
83
- return null;
84
- }
85
-
86
- if (isArray(value)) {
87
- // The value may have been encoded on the page into an array so handle this automatically
88
- value = value[0] || "";
89
- }
90
-
91
- if (!value || !isString(value) || value.length > 8192) {
92
- // limit potential processing based on total length
93
- return null;
94
- }
95
-
96
- // See https://www.w3.org/TR/trace-context/#versioning-of-traceparent
97
- const match = TRACE_PARENT_REGEX.exec(strTrim(value));
98
- if (!match || // No match
99
- match[1] === INVALID_VERSION || // version ff is forbidden
100
- match[2] === INVALID_TRACE_ID || // All zeros is considered to be invalid
101
- match[3] === INVALID_SPAN_ID) { // All zeros is considered to be invalid
102
- return null;
103
- }
104
-
105
- return {
106
- version: match[1],
107
- traceId: match[2],
108
- spanId: match[3],
109
- traceFlags: parseInt(match[4], 16)
110
- }
111
- }
112
-
113
- /**
114
- * Is the provided W3c Trace Id a valid string representation, it must be a 32-character string
115
- * of lowercase hexadecimal characters for example, 4bf92f3577b34da6a3ce929d0e0e4736.
116
- * If all characters as zero (00000000000000000000000000000000) it will be considered an invalid value.
117
- * @param value - The W3c trace Id to be validated
118
- * @returns true if valid otherwise false
119
- */
120
- export function isValidTraceId(value: string): boolean {
121
- return _isValid(value, 32, INVALID_TRACE_ID);
122
- }
123
-
124
- /**
125
- * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character
126
- * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
127
- * If all characters are zero (0000000000000000) this is considered an invalid value.
128
- * @param value - The W3c span id to be validated
129
- * @returns true if valid otherwise false
130
- */
131
- export function isValidSpanId(value: string): boolean {
132
- return _isValid(value, 16, INVALID_SPAN_ID);
133
- }
134
-
135
- /**
136
- * Validates that the provided ITraceParent instance conforms to the currently supported specifications
137
- * @param value
138
- * @returns
139
- */
140
- export function isValidTraceParent(value: ITraceParent) {
141
- if (!value ||
142
- !_isValid(value.version, 2, INVALID_VERSION) ||
143
- !_isValid(value.traceId, 32, INVALID_TRACE_ID) ||
144
- !_isValid(value.spanId, 16, INVALID_SPAN_ID) ||
145
- !_isValid(_formatFlags(value.traceFlags), 2)) {
146
-
147
- // Each known field must contain a valid value
148
- return false;
149
- }
150
-
151
- return true;
152
- }
153
-
154
- /**
155
- * Is the parsed traceParent indicating that the trace is currently sampled.
156
- * @param value - The parsed traceParent value
157
- * @returns
158
- */
159
- export function isSampledFlag(value: ITraceParent) {
160
- if (isValidTraceParent(value)) {
161
- return (value.traceFlags & SAMPLED_FLAG) === SAMPLED_FLAG;
162
- }
163
-
164
- return false;
165
- }
166
-
167
- /**
168
- * Format the ITraceParent value as a string using the supported and know version formats.
169
- * So even if the passed traceParent is a later version the string value returned from this
170
- * function will convert it to only the known version formats.
171
- * This currently only supports version "00" and invalid "ff"
172
- * @param value - The parsed traceParent value
173
- * @returns
174
- */
175
- export function formatTraceParent(value: ITraceParent) {
176
- if (value) {
177
- // Special Note: This only supports formatting as version 00, future versions should encode any known supported version
178
- // So parsing a future version will populate the correct version value but reformatting will reduce it to version 00.
179
- let flags = _formatFlags(value.traceFlags);
180
- if (!_isValid(flags, 2)) {
181
- flags = "01";
182
- }
183
-
184
- let version = value.version || DEFAULT_VERSION;
185
- if (version !== "00" && version !== "ff") {
186
- // Reduce version to "00"
187
- version = DEFAULT_VERSION;
188
- }
189
-
190
- // Format as version 00
191
- return `${version}-${_formatValue(value.traceId, 32, INVALID_TRACE_ID)}-${_formatValue(value.spanId, 16, INVALID_SPAN_ID)}-${flags}`;
192
- }
193
-
194
- return "";
195
- }
196
-
197
- /**
198
- * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.
199
- * @returns
200
- */
201
- export function findW3cTraceParent(): ITraceParent {
202
- let traceParent: ITraceParent;
203
- let doc = getDocument();
204
- if (doc) {
205
- // Look for a meta-tag called "traceparent"
206
- traceParent = parseTraceParent(_getTraceParentValue(doc.querySelectorAll("meta")).content);
207
- }
208
-
209
- if (!traceParent) {
210
- let perf = getPerformance();
211
- if (perf) {
212
- // Try looking for a server-timing header
213
- let navPerf = perf.getEntriesByType("navigation") || [];
214
- traceParent = parseTraceParent(_getTraceParentValue((navPerf.length > 0 ? navPerf[0] : {} as any).serverTiming).description);
215
- }
216
- }
217
-
218
- return traceParent;
219
- }
@@ -1,32 +0,0 @@
1
- /**
2
- * This interface represents the components of a W3C traceparent header
3
- */
4
- export interface ITraceParent {
5
- /**
6
- * The version of the definition, this MUST be a string with a length of 2 and only contain lowercase
7
- * hexadecimal characters. A value of 'ff' is considered to be an invalid version.
8
- */
9
- version: string;
10
- /**
11
- * This is the ID of the whole trace forest and is used to uniquely identify a distributed trace
12
- * through a system. It is represented as a 32-character string of lowercase hexadecimal characters,
13
- * for example, 4bf92f3577b34da6a3ce929d0e0e4736.
14
- * All characters as zero (00000000000000000000000000000000) is considered an invalid value.
15
- */
16
- traceId: string;
17
- /**
18
- * This is the ID of the current request as known by the caller (in some tracing systems, this is also
19
- * known as the parent-id, where a span is the execution of a client request). It is represented as an
20
- * 16-character string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
21
- * All bytes as zero (0000000000000000) is considered an invalid value.
22
- */
23
- spanId: string;
24
- /**
25
- * An 8-bit value of flags that controls tracing such as sampling, trace level, etc. These flags are
26
- * recommendations given by the caller rather than strict rules to follow.
27
- * As this is a bit field, you cannot interpret flags by decoding the hex value and looking at the resulting
28
- * number. For example, a flag 00000001 could be encoded as 01 in hex, or 09 in hex if present with the flag
29
- * 00001000. A common mistake in bit fields is forgetting to mask when interpreting flags.
30
- */
31
- traceFlags: number;
32
- }
@@ -1,59 +0,0 @@
1
- import { ITraceParent } from "./Interfaces/ITraceParent";
2
- /**
3
- * Create a new ITraceParent instance using the provided values.
4
- * @param traceId - The traceId to use, when invalid a new random W3C id will be generated.
5
- * @param spanId - The parent/span id to use, a new random value will be generated if it is invalid.
6
- * @param flags - The traceFlags to use, defaults to zero (0) if not supplied or invalid
7
- * @param version - The version to used, defaults to version "01" if not supplied or invalid.
8
- * @returns
9
- */
10
- export declare function createTraceParent(traceId?: string, spanId?: string, flags?: number, version?: string): ITraceParent;
11
- /**
12
- * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)
13
- *
14
- * @param value
15
- * @returns
16
- */
17
- export declare function parseTraceParent(value: string): ITraceParent;
18
- /**
19
- * Is the provided W3c Trace Id a valid string representation, it must be a 32-character string
20
- * of lowercase hexadecimal characters for example, 4bf92f3577b34da6a3ce929d0e0e4736.
21
- * If all characters as zero (00000000000000000000000000000000) it will be considered an invalid value.
22
- * @param value - The W3c trace Id to be validated
23
- * @returns true if valid otherwise false
24
- */
25
- export declare function isValidTraceId(value: string): boolean;
26
- /**
27
- * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character
28
- * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
29
- * If all characters are zero (0000000000000000) this is considered an invalid value.
30
- * @param value - The W3c span id to be validated
31
- * @returns true if valid otherwise false
32
- */
33
- export declare function isValidSpanId(value: string): boolean;
34
- /**
35
- * Validates that the provided ITraceParent instance conforms to the currently supported specifications
36
- * @param value
37
- * @returns
38
- */
39
- export declare function isValidTraceParent(value: ITraceParent): boolean;
40
- /**
41
- * Is the parsed traceParent indicating that the trace is currently sampled.
42
- * @param value - The parsed traceParent value
43
- * @returns
44
- */
45
- export declare function isSampledFlag(value: ITraceParent): boolean;
46
- /**
47
- * Format the ITraceParent value as a string using the supported and know version formats.
48
- * So even if the passed traceParent is a later version the string value returned from this
49
- * function will convert it to only the known version formats.
50
- * This currently only supports version "00" and invalid "ff"
51
- * @param value - The parsed traceParent value
52
- * @returns
53
- */
54
- export declare function formatTraceParent(value: ITraceParent): string;
55
- /**
56
- * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.
57
- * @returns
58
- */
59
- export declare function findW3cTraceParent(): ITraceParent;