@salesforce/lds-instrumentation 1.140.0 → 1.141.0

package/dist/ldsInstrumentation.js

@@ -927,6 +927,27 @@ 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;
@@ -986,7 +1007,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) {
@@ -1427,5 +1448,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.140.0-a9e378a04
+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.141.0-f0b9250ae

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 {
@@ -28,6 +30,15 @@ interface AdapterInstrumentationOptions {
     trackL2Hits: 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.140.0",
+    "version": "1.141.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "Instrumentation utils for Lightning Data Service",
     "main": "dist/ldsInstrumentation.js",
@@ -48,7 +48,7 @@
             "path": "./dist/ldsInstrumentation.js",
             "maxSize": {
                 "none": "60 kB",
-                "min": "25 kB",
+                "min": "26 kB",
                 "compressed": "11 kB"
             }
         }