@lwrjs/o11y 0.6.5 → 0.7.0-alpha.10

package/LICENSE

@@ -0,0 +1,10 @@
+MIT LICENSE
+
+Copyright (c) 2020, Salesforce.com, Inc.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/build/bundle/prod/lwr/o11yService/o11yService.js

@@ -1 +1 @@
-import{getInstrumentation as t}from"o11y/client";import{registerDecorators as e}from"lwc";import{MODULE_FETCH as r,MAPPINGS_FETCH as s,MODULE_DEFINE as n,MODULE_DEFINE_COUNT as i,BOOTSTRAP_END as a,MODULE_FETCH_DURATION as o,MAPPINGS_FETCH_DURATION as c,BOOTSTRAP_DURATION as m,BOOTSTRAP_AVAILABILITY as h,MODULE_FETCH_COUNT as u,MODULE_AVAILABILITY as l,MAPPINGS_FETCH_COUNT as k,MAPPINGS_AVAILABILITY as f,BOOTSTRAP_ERROR as p,MODULE_ERROR as g,MAPPINGS_ERROR as b}from"lwr/metrics";class d{constructor(t,e){this.marks={},this.config=e||{},this.instrumentation=t}track(){this.trackExistingMarks(),this.setupObserver()}isClearable(t){return!t.startsWith(r)&&!t.startsWith(s)}trackExistingMarks(){const t=performance.getEntriesByType("mark").filter((t=>t.name.startsWith(n)));t.length>0&&this.instrumentation.incrementCounter(i,t.length)}setupObserver(){let t=0,e=0,d=0;new PerformanceObserver((W=>{const T=[];W.getEntries().forEach((r=>{const{name:s,entryType:n,duration:i}=r;"mark"===n&&s.startsWith("lwr.")&&T.push(r),s===a&&(this.marks[s]=r),s===p&&(t+=1),s===g&&(e+=1),s===b&&(d+=1),this.config.enableModuleFetchTracking&&s.startsWith(o)&&this.instrumentation.trackValue(s,i),this.config.enableMappingFetchTracking&&s.startsWith(c)&&this.instrumentation.trackValue(s,i)})),void 0!==this.marks[a]&&(this.instrumentation.trackValue(m,this.marks[a].startTime),this.instrumentation.trackValue(h,1/(1+t)*100),delete this.marks[a]);const y=T.reduce(((t,e)=>e.name.startsWith(n)?t+1:t),0);y>0&&this.instrumentation.incrementCounter(i,y);const C=T.reduce(((t,e)=>e.name.startsWith(r)?t+1:t),0);C>0&&(this.instrumentation.incrementCounter(u,C),this.instrumentation.trackValue(l,C/(C+e)*100));const v=T.reduce(((t,e)=>e.name.startsWith(s)?t+1:t),0);v>0&&(this.instrumentation.incrementCounter(k,v),this.instrumentation.trackValue(f,v/(v+d)*100)),T.forEach((t=>this.isClearable(t.name)&&performance.clearMarks(t.name)))})).observe({entryTypes:["mark","measure"]})}}e(d,{fields:["marks"]});const W=void 0!==globalThis.performance&&"function"==typeof globalThis.performance.mark,T=globalThis.LWR,y={track:()=>{}};function C(e){const r=t("lwrjs"),s=T.metricsConfig||{};(W?new d(r,s):y).track()}export default C;
+import{getInstrumentation as t}from"o11y/client";import{MODULE_DEFINE as e,MODULE_DEFINE_COUNT as r,BOOTSTRAP_END as n,BOOTSTRAP_DURATION as s,MODULE_FETCH_DURATION as i,MAPPINGS_FETCH_DURATION as a,MODULE_FETCH as o,MAPPINGS_FETCH as c,ROUTER_NAV as m,ROUTER_VIEW as h,ROUTER_NAV_DURATION as l,ROUTER_VIEW_DURATION as u,BOOTSTRAP_ERROR as f,BOOTSTRAP_ERROR_COUNT as k,MODULE_FETCH_COUNT as g,MODULE_ERROR as p,MODULE_ERROR_COUNT as b,MAPPINGS_FETCH_COUNT as T,MAPPINGS_ERROR as y,MAPPINGS_ERROR_COUNT as W,ROUTER_NAV_COUNT as d,ROUTER_ERROR as v,ROUTER_ERROR_COUNT as E}from"lwr/metrics";const M=[o,c,m,h],w=[l,u],O={[f]:k,[e]:r,[o]:g,[p]:b,[c]:T,[y]:W,[m]:d,[v]:E},V=Object.keys(O);class x{constructor(t,e){this.config=e||{},this.instrumentation=t}track(){this.trackExistingMarks(),this.setupObserver()}trackExistingMarks(){const t=performance.getEntriesByType("mark").filter((t=>t.name.startsWith(e)));t.length>0&&this.instrumentation.incrementCounter(r,t.length)}setupObserver(){new PerformanceObserver((t=>{t.getEntries().forEach((t=>{const{name:e,duration:r,startTime:o}=t;e===n&&this.instrumentation.trackValue(s,o);const c=V.find((t=>e.startsWith(t)));c&&this.instrumentation.incrementCounter(O[c],1),this.config.enableModuleFetchTracking&&e.startsWith(i)&&this.instrumentation.trackValue(e,r),this.config.enableMappingFetchTracking&&e.startsWith(a)&&this.instrumentation.trackValue(e,r),w.some((t=>e.startsWith(t)))&&this.instrumentation.trackValue(e,r),M.some((t=>e.startsWith(t)))||performance.clearMarks(e)}))})).observe({entryTypes:["mark","measure"]})}}const C=void 0!==globalThis.performance&&"function"==typeof globalThis.performance.mark,j=globalThis.LWR,F={track:()=>{}};function B(e){const r=t("lwrjs"),n=j.metricsConfig||{};(C?new x(r,n):F).track()}export default B;

package/build/modules/lwr/o11yService/performanceApiSink.js

@@ -1,7 +1,18 @@
-import { BOOTSTRAP_AVAILABILITY, BOOTSTRAP_DURATION, BOOTSTRAP_END, BOOTSTRAP_ERROR, MAPPINGS_AVAILABILITY, MAPPINGS_ERROR, MAPPINGS_FETCH, MAPPINGS_FETCH_COUNT, MAPPINGS_FETCH_DURATION, MODULE_AVAILABILITY, MODULE_DEFINE, MODULE_DEFINE_COUNT, MODULE_ERROR, MODULE_FETCH, MODULE_FETCH_COUNT, MODULE_FETCH_DURATION } from 'lwr/metrics';
+import { BOOTSTRAP_DURATION, BOOTSTRAP_END, BOOTSTRAP_ERROR, BOOTSTRAP_ERROR_COUNT, MAPPINGS_ERROR, MAPPINGS_ERROR_COUNT, MAPPINGS_FETCH, MAPPINGS_FETCH_COUNT, MAPPINGS_FETCH_DURATION, MODULE_DEFINE, MODULE_DEFINE_COUNT, MODULE_ERROR, MODULE_ERROR_COUNT, MODULE_FETCH, MODULE_FETCH_COUNT, MODULE_FETCH_DURATION, ROUTER_ERROR, ROUTER_ERROR_COUNT, ROUTER_NAV, ROUTER_NAV_COUNT, ROUTER_NAV_DURATION, ROUTER_VIEW, ROUTER_VIEW_DURATION } from 'lwr/metrics';
+const doNotClear = [MODULE_FETCH, MAPPINGS_FETCH, ROUTER_NAV, ROUTER_VIEW];
+const durationMetrics = [ROUTER_NAV_DURATION, ROUTER_VIEW_DURATION];
+const countMap = {
+  [BOOTSTRAP_ERROR]: BOOTSTRAP_ERROR_COUNT,
+  [MODULE_DEFINE]: MODULE_DEFINE_COUNT,
+  [MODULE_FETCH]: MODULE_FETCH_COUNT,
+  [MODULE_ERROR]: MODULE_ERROR_COUNT,
+  [MAPPINGS_FETCH]: MAPPINGS_FETCH_COUNT,
+  [MAPPINGS_ERROR]: MAPPINGS_ERROR_COUNT,
+  [ROUTER_NAV]: ROUTER_NAV_COUNT,
+  [ROUTER_ERROR]: ROUTER_ERROR_COUNT
+};
+const metricsToCount = Object.keys(countMap);
 export class PerformanceApiSink {
-  marks = {};
-
   constructor(instrumentation, config) {
     this.config = config || {};
     this.instrumentation = instrumentation;
@@ -10,71 +21,43 @@ export class PerformanceApiSink {
   track() {
     this.trackExistingMarks();
     this.setupObserver();
-  } // Return true if the mark is clearable
-  // logOperationEnd clears the marks and measures passed to it, so these are NOT clearable
-  // As of now, only "lwr.loader.*.fetch" metrics have durations (i.e. are not clearable)
-
-
-  isClearable(name) {
-    return !name.startsWith(MODULE_FETCH) && !name.startsWith(MAPPINGS_FETCH);
-  } // Retrieve existing metrics to this point
+  } // Retrieve existing loader define metrics to this point
 
 
   trackExistingMarks() {
-    /**
-     * Loader define marks prior to service bootstrap
-     */
-    const marks = performance.getEntriesByType('mark').filter(e => e.name.startsWith(MODULE_DEFINE)); // initialize the module define count
-    // at this point in time, the count will include modules NOT fetched by the loader:
+    const defineMarks = performance.getEntriesByType('mark').filter(e => e.name.startsWith(MODULE_DEFINE)); // Initialize the module define count
+    // At this point in time, the count will include modules NOT fetched by the loader:
     //      - required modules
     //      - preload modules
     //      - the application bootstrap module
     //      - the loader module itself
 
-    if (marks.length > 0) {
-      this.instrumentation.incrementCounter(MODULE_DEFINE_COUNT, marks.length);
+    if (defineMarks.length > 0) {
+      this.instrumentation.incrementCounter(MODULE_DEFINE_COUNT, defineMarks.length);
     }
   } // Add observer to log future metrics
-  // observe lwr client runtime performance metrics
 
 
   setupObserver() {
-    let bootstrapErrorCount = 0;
-    let loaderModuleErrorCount = 0;
-    let loaderMappingsErrorcount = 0;
     const observer = new PerformanceObserver(list => {
-      // grab the lwr performance marks
-      const marks = [];
-      /**
-       * Bootstrap and Loader marks
-       */
-
       list.getEntries().forEach(entry => {
         const {
           name,
-          entryType,
-          duration
-        } = entry;
-
-        if (entryType === 'mark' && name.startsWith('lwr.')) {
-          marks.push(entry);
-        }
+          duration,
+          startTime
+        } = entry; // Track the bootstrap duration from navigation.start to lwr.bootstrap.end
 
         if (name === BOOTSTRAP_END) {
-          this.marks[name] = entry;
-        }
+          this.instrumentation.trackValue(BOOTSTRAP_DURATION, startTime);
+        } // Increment count metrics
 
-        if (name === BOOTSTRAP_ERROR) {
-          bootstrapErrorCount += 1;
-        }
 
-        if (name === MODULE_ERROR) {
-          loaderModuleErrorCount += 1;
-        }
+        const metricToCount = metricsToCount.find(c => name.startsWith(c));
+
+        if (metricToCount) {
+          this.instrumentation.incrementCounter(countMap[metricToCount], 1);
+        } // Record duration metrics
 
-        if (name === MAPPINGS_ERROR) {
-          loaderMappingsErrorcount += 1;
-        }
 
         if (this.config.enableModuleFetchTracking && name.startsWith(MODULE_FETCH_DURATION)) {
           this.instrumentation.trackValue(name, duration);
@@ -83,46 +66,17 @@ export class PerformanceApiSink {
         if (this.config.enableMappingFetchTracking && name.startsWith(MAPPINGS_FETCH_DURATION)) {
           this.instrumentation.trackValue(name, duration);
         }
-      });
-
-      if (this.marks[BOOTSTRAP_END] !== undefined) {
-        this.instrumentation.trackValue(BOOTSTRAP_DURATION, this.marks[BOOTSTRAP_END].startTime);
-        this.instrumentation.trackValue(BOOTSTRAP_AVAILABILITY, 1 / (1 + bootstrapErrorCount) * 100); // reset to prevent multiple reports
 
-        delete this.marks[BOOTSTRAP_END];
-      } // count how many modules were defined and report the count
-
-
-      const moduleDefineCount = marks.reduce((count, mark) => {
-        return mark.name.startsWith(MODULE_DEFINE) ? count + 1 : count;
-      }, 0);
-
-      if (moduleDefineCount > 0) {
-        this.instrumentation.incrementCounter(MODULE_DEFINE_COUNT, moduleDefineCount);
-      } // count how many modules were loaded and report the count
-
-
-      const moduleLoadCount = marks.reduce((count, mark) => {
-        return mark.name.startsWith(MODULE_FETCH) ? count + 1 : count;
-      }, 0);
-
-      if (moduleLoadCount > 0) {
-        this.instrumentation.incrementCounter(MODULE_FETCH_COUNT, moduleLoadCount);
-        this.instrumentation.trackValue(MODULE_AVAILABILITY, moduleLoadCount / (moduleLoadCount + loaderModuleErrorCount) * 100);
-      } // count how many mapping resources were loaded and report the count
-
-
-      const mappingLoadCount = marks.reduce((count, mark) => {
-        return mark.name.startsWith(MAPPINGS_FETCH) ? count + 1 : count;
-      }, 0);
-
-      if (mappingLoadCount > 0) {
-        this.instrumentation.incrementCounter(MAPPINGS_FETCH_COUNT, mappingLoadCount);
-        this.instrumentation.trackValue(MAPPINGS_AVAILABILITY, mappingLoadCount / (mappingLoadCount + loaderMappingsErrorcount) * 100);
-      } // remove clearable marks
+        if (durationMetrics.some(d => name.startsWith(d))) {
+          this.instrumentation.trackValue(name, duration);
+        } // Remove clearable marks
+        // A mark is clearable if it does not have a corresponding logOperationEnd / measure
 
 
-      marks.forEach(mark => this.isClearable(mark.name) && performance.clearMarks(mark.name));
+        if (!doNotClear.some(m => name.startsWith(m))) {
+          performance.clearMarks(name);
+        }
+      });
     });
     observer.observe({
       entryTypes: ['mark', 'measure']

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.6.5",
+    "version": "0.7.0-alpha.10",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -24,8 +24,8 @@
         "build:bundle": "rollup --config scripts/rollup.moduleBundle.config.cjs"
     },
     "dependencies": {
-        "@lwrjs/shared-utils": "0.6.5",
-        "o11y": "238.1.4"
+        "@lwrjs/shared-utils": "0.7.0-alpha.10",
+        "o11y": "238.9.0"
     },
     "devDependencies": {
         "rollup-plugin-terser": "^7.0.2"
@@ -45,5 +45,6 @@
     },
     "engines": {
         "node": ">=14.15.4 <17"
-    }
+    },
+    "gitHead": "83c1e65e2169094cb55ac2c37e5aef16d3a9aa4a"
 }