@salesforce/lds-instrumentation 1.130.10 → 1.131.0-dev9

package/dist/ldsInstrumentation.js

@@ -91,7 +91,7 @@ var FragmentReadResultState;
 ({
     state: FragmentReadResultState.Missing,
 });
-// engine version: 0.138.8-480e18f2
+// engine version: 0.138.8-244.1-492a715e
 
 const DurableEnvironmentEventDiscriminator = 'durable';
 function isDurableEnvironmentEvent(event) {
@@ -927,13 +927,36 @@ function logAdapterCacheMissOutOfTtlDuration(name, config, currentCacheMissTimes
         }
     }
 }
+/**
+ * Starts an o11y Activity using the supplied o11y Instrumention and adapterName.
+ * If a requestContext is supplied, we check for the existence of a requestCorrelator containing an ObservabilityContext.
+ * If an ObservabilityContext is defined, we build an object that conforms to the ApiOptions interface required by the startActivity API
+ */
+function startAdapterActivity(instrumentation, adapterName, requestContext) {
+    if (requestContext === undefined ||
+        requestContext.requestCorrelator === undefined ||
+        requestContext.requestCorrelator.observabilityContext === undefined) {
+        return instrumentation.startActivity(adapterName);
+    }
+    const { traceId, ...rest } = requestContext.requestCorrelator
+        .observabilityContext;
+    const apiOptions = {
+        instrumentationContext: rest,
+    };
+    if (traceId !== undefined) {
+        apiOptions.instrumentationContext.parentId = traceId;
+    }
+    return instrumentation.startActivity(adapterName, apiOptions);
+}
 function instrumentAdapter(adapter, metadata, adapterInstrumentationOptions) {
     const { apiFamily, name, ttl } = metadata;
     let trackL1Hits = false;
     let trackL2Hits = false;
+    let trackCacheMisses = false;
     let reportObserver = undefined;
     if (adapterInstrumentationOptions !== undefined) {
-        ({ trackL1Hits, trackL2Hits, reportObserver } = adapterInstrumentationOptions);
+        ({ trackL1Hits, trackL2Hits, trackCacheMisses, reportObserver } =
+            adapterInstrumentationOptions);
     }
     const adapterName = normalizeAdapterName(name, apiFamily);
     /**
@@ -986,7 +1009,7 @@ function instrumentAdapter(adapter, metadata, adapterInstrumentationOptions) {
         // increment cache policy metrics
         incrementAdapterCachePolicyType(requestContext);
         // start collecting
-        const activity = ldsInstrumentation.startActivity(adapterName);
+        const activity = startAdapterActivity(ldsInstrumentation, adapterName, requestContext);
         return runAdapterWithReport(metadata.name, adapter, config, requestContext || {}, (report) => {
             const { executionTime } = report;
             switch (report.result) {
@@ -1021,10 +1044,14 @@ function instrumentAdapter(adapter, metadata, adapterInstrumentationOptions) {
                 case 'cache-miss':
                     {
                         ldsInstrumentation.trackValue(cacheMissDurationByAdapterMetric, executionTime);
-                        // TODO [W-10484306]: Remove typecasting after this type bug is solved
-                        activity.stop('cache-miss');
                         ldsInstrumentation.incrementCounter(ADAPTER_CACHE_MISS_COUNT_METRIC_NAME, 1);
                         ldsInstrumentation.incrementCounter(cacheMissCountByAdapterMetric, 1);
+                        if (trackCacheMisses) {
+                            activity.stop('cache-miss');
+                        }
+                        else {
+                            activity.discard();
+                        }
                         if (ttl !== undefined) {
                             logAdapterCacheMissOutOfTtlDuration(adapterName, config, Date.now(), ttl, cacheMissOutOfTtlCountByAdapterMetric, cacheMissOutOfTtlDurationByAdapterMetric);
                         }
@@ -1039,7 +1066,6 @@ function instrumentAdapter(adapter, metadata, adapterInstrumentationOptions) {
                         if (isAdapterError(error)) {
                             activity.error(error);
                         }
-                        // TODO [W-10484306]: Remove typecasting after this type bug is solved
                         activity.stop('error');
                     }
                     break;
@@ -1360,7 +1386,6 @@ function setupInstrumentation(luvio, store) {
     setupStoreStatsCollection(luvio, instrumentStoreStatsCallback(store));
     setStoreScheduler(store);
     setStoreEventObservers(store);
-    // TODO [W-10061321]: use periodic logger to log aggregated store stats
 }
 function instrumentStoreMethods(luvio, _store) {
     instrumentMethods(luvio, [
@@ -1427,5 +1452,5 @@ function setStoreEventObservers(store) {
 }
 const instrumentation = new Instrumentation();
 
-export { Instrumentation, LRUCache, metricKeys as METRIC_KEYS, handleIngestedNewData, handleOnDataOutOfTtlDurationUpdate, incrementCounterMetric, incrementGetRecordNormalInvokeCount, incrementGetRecordNotifyChangeAllowCount, incrementGetRecordNotifyChangeDropCount, incrementNotifyRecordUpdateAvailableAllowCount, incrementNotifyRecordUpdateAvailableDropCount, instrumentAdapter, instrumentLuvio, instrumentMethods, instrumentStoreMethods, instrumentation, setInstrumentationHooks, setLdsAdaptersUiapiInstrumentation, setLdsNetworkAdapterInstrumentation, setStoreEventObservers, setupInstrumentation, updatePercentileHistogramMetric };
-// version: 1.130.10-0fac4c295
+export { Instrumentation, LRUCache, metricKeys as METRIC_KEYS, handleIngestedNewData, handleOnDataOutOfTtlDurationUpdate, incrementCounterMetric, incrementGetRecordNormalInvokeCount, incrementGetRecordNotifyChangeAllowCount, incrementGetRecordNotifyChangeDropCount, incrementNotifyRecordUpdateAvailableAllowCount, incrementNotifyRecordUpdateAvailableDropCount, instrumentAdapter, instrumentLuvio, instrumentMethods, instrumentStoreMethods, instrumentation, setInstrumentationHooks, setLdsAdaptersUiapiInstrumentation, setLdsNetworkAdapterInstrumentation, setStoreEventObservers, setupInstrumentation, startAdapterActivity, updatePercentileHistogramMetric };
+// version: 1.131.0-dev9-5f88f31bc

package/dist/types/main.d.ts

@@ -1,7 +1,9 @@
-import type { Luvio, InMemoryStore, Adapter, CacheMissOutOfTtlEvent, DataOutOfTtlDurationUpdateEvent } from '@luvio/engine';
+import type { AdapterRequestContext, Luvio, InMemoryStore, Adapter, CacheMissOutOfTtlEvent, DataOutOfTtlDurationUpdateEvent } from '@luvio/engine';
+import type { Activity, Instrumentation as o11yInstrumentation } from 'o11y/dist/modules/o11y/client/interfaces';
 import type { Registration as LdsUiapiRegistration } from '@salesforce/lds-adapters-uiapi';
 import type { Registration as LdsNetworkAdapterRegistration } from '@salesforce/lds-network-adapter';
 import type { AdapterReport } from '@salesforce/lds-utils-adapters';
+import type { ObservabilityContext } from '@salesforce/nimbus-plugin-lds';
 export * as METRIC_KEYS from './metric-keys';
 export { LRUCache } from './utils/lru-cache';
 interface AdapterMetadata {
@@ -26,8 +28,18 @@ export type ReportObserver = (report: AdapterReport) => void;
 interface AdapterInstrumentationOptions {
     trackL1Hits: boolean;
     trackL2Hits: boolean;
+    trackCacheMisses: boolean;
     reportObserver?: ReportObserver;
 }
+export interface RequestCorrelator {
+    observabilityContext?: ObservabilityContext;
+}
+/**
+ * Starts an o11y Activity using the supplied o11y Instrumention and adapterName.
+ * If a requestContext is supplied, we check for the existence of a requestCorrelator containing an ObservabilityContext.
+ * If an ObservabilityContext is defined, we build an object that conforms to the ApiOptions interface required by the startActivity API
+ */
+export declare function startAdapterActivity(instrumentation: o11yInstrumentation, adapterName: string, requestContext?: AdapterRequestContext): Activity;
 export declare function instrumentAdapter<C, D>(adapter: Adapter<C, D>, metadata: AdapterMetadata, adapterInstrumentationOptions?: AdapterInstrumentationOptions): Adapter<C, D>;
 /**
  * Wraps methods to collect runtime performance using o11y's trackValue API

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-instrumentation",
-    "version": "1.130.10",
+    "version": "1.131.0-dev9",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "Instrumentation utils for Lightning Data Service",
     "main": "dist/ldsInstrumentation.js",
@@ -33,22 +33,22 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --name=lds-instrumentation"
     },
     "dependencies": {
-        "@salesforce/lds-bindings": "*",
-        "@salesforce/lds-default-luvio": "*",
-        "@salesforce/lds-utils-adapters": "*",
+        "@salesforce/lds-bindings": "1.131.0-244.8",
+        "@salesforce/lds-default-luvio": "1.131.0-244.8",
+        "@salesforce/lds-utils-adapters": "1.131.0-244.8",
         "o11y": "244.0.0",
         "o11y_schema": "244.0.0"
     },
     "devDependencies": {
-        "@salesforce/lds-adapters-uiapi": "*",
-        "@salesforce/lds-network-adapter": "*"
+        "@salesforce/lds-adapters-uiapi": "1.131.0-244.8",
+        "@salesforce/lds-network-adapter": "1.131.0-244.8"
     },
     "luvioBundlesize": [
         {
             "path": "./dist/ldsInstrumentation.js",
             "maxSize": {
                 "none": "60 kB",
-                "min": "25 kB",
+                "min": "26 kB",
                 "compressed": "11 kB"
             }
         }