@salesforce/telemetry 7.0.5 → 7.1.0

package/lib/exported.d.ts

@@ -3,3 +3,4 @@ export * from './telemetryReporter';
 export { isEnabled } from './enabledCheck';
 export default TelemetryReporter;
 export type { Attributes, O11ySchema, O11yBatchingConfig, PdpEvent, TelemetryOptions } from './types';
+export type { FalconUploadOptions } from '@salesforce/o11y-reporter';

package/lib/o11yReporter.js

@@ -16,7 +16,6 @@ exports.O11yReporter = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/* eslint-disable no-underscore-dangle */
 /* eslint-disable-next-line @typescript-eslint/triple-slash-reference -- needed so dynamic import('o11y_schema/sf_pdp') is typed when test tsconfig compiles */
 /// <reference path="../types/o11y_schema_sf_pdp.d.ts" />
 const o11y_reporter_1 = require("@salesforce/o11y-reporter");
@@ -39,8 +38,20 @@ class O11yReporter extends baseReporter_1.BaseReporter {
         super(options);
         this.extensionName = options.extensionName ?? options.project;
         this.service = o11y_reporter_1.O11yService.getInstance(this.extensionName);
-        const dynamicO11yUploadEndpointPath = options.dynamicO11yUploadEndpoint ?? undefined;
-        this.initialized = this.service.initialize(this.extensionName, options.o11yUploadEndpoint, options.getConnectionFn, dynamicO11yUploadEndpointPath ? { dynamicO11yUploadEndpointPath } : undefined);
+        // Default the CoreEnvelope appName to extensionName. o11y-reporter does NOT derive appName
+        // from extensionName — when unset it falls back to its generic "o11y-reporter-extensions"
+        // default — so telemetry sets it here to label events with this consumer's name. A consumer
+        // may override via options.appName (e.g. a co-hosted process where appName is shared).
+        const initOptions = { appName: options.appName ?? this.extensionName };
+        if (options.dynamicO11yUploadEndpoint) {
+            initOptions.dynamicO11yUploadEndpointPath = options.dynamicO11yUploadEndpoint;
+        }
+        if (options.falcon) {
+            initOptions.falcon = options.falcon; // opt-in Falcon publishing
+        }
+        // extensionName is passed positionally (already unique per consumer); it becomes the per-event
+        // o11y loggerName. appName (above) is the process-level CoreEnvelope label.
+        this.initialized = this.service.initialize(this.extensionName, options.o11yUploadEndpoint, options.getConnectionFn, initOptions);
         this.commonProperties = this.buildO11yCommonProperties(options.commonProperties);
     }
     async init() {

package/lib/telemetryReporter.js

@@ -107,6 +107,11 @@ class TelemetryReporter extends kit_1.AsyncCreatable {
                 try {
                     this.o11yReporter = new o11yReporter_1.O11yReporter(this.options);
                     await this.o11yReporter.init();
+                    // Opt-in Falcon publishing is gated behind enableO11y. Log that it is configured
+                    // without ever logging the API key or any other secret.
+                    if (this.options.falcon) {
+                        this.logger.debug(`O11y Falcon publishing configured (environment: ${this.options.falcon.environment ?? 'dev'})`);
+                    }
                     // Configure batching - enabled by default unless explicitly disabled
                     const batchingConfig = this.options.o11yBatching;
                     // Batching is enabled by default. Only disable if explicitly set to false

package/lib/types.d.ts

@@ -1,5 +1,5 @@
 import { Env } from '@salesforce/kit';
-import { Connection as O11yConnection } from '@salesforce/o11y-reporter';
+import { Connection as O11yConnection, FalconUploadOptions } from '@salesforce/o11y-reporter';
 export type Properties = {
     [key: string]: string;
 };
@@ -127,10 +127,30 @@ export type TelemetryOptions = {
     enableO11y?: boolean;
     enableAppInsights?: boolean;
     extensionName?: string;
+    /**
+     * Optional PROCESS-level O11y application name (the CoreEnvelope `appName`).
+     *
+     * When omitted, telemetry defaults it to `extensionName`, so events are labeled with this
+     * consumer's name (e.g. "salesforce-cli") instead of o11y-reporter's generic
+     * "o11y-reporter-extensions" default. Supply an explicit value only for a co-hosted process
+     * where several extensions share one o11y client (e.g. the VS Code Extension Pack): `appName`
+     * is process-level first-writer-wins, so it cannot vary per consumer there — per-consumer
+     * identity always rides on `extensionName` (the o11y `loggerName`) regardless.
+     */
+    appName?: string;
     /**
      * Batching configuration for O11y telemetry
      * Batching is enabled by default. Set o11yBatching.enableAutoBatching to false to disable batching
      * and upload events immediately after each event.
      */
     o11yBatching?: O11yBatchingConfig;
+    /**
+     * Opt-in Falcon publishing configuration for O11y telemetry.
+     *
+     * When supplied (and enableO11y is true), Falcon becomes the selected upload destination for this
+     * consumer; otherwise the existing org-connection / static-endpoint path is used unchanged.
+     * Carries the Falcon apiKey, an optional environment ("dev" | "prod", defaults to "dev"), and
+     * consumer-supplied endpoints/endpoint. Never hardcode or log the apiKey.
+     */
+    falcon?: FalconUploadOptions;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/telemetry",
-  "version": "7.0.5",
+  "version": "7.1.0",
   "description": "Library for telemetry reporting to Application Insights and O11y",
   "main": "lib/exported",
   "exports": {
@@ -41,24 +41,24 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/core": "^9.1.0",
+    "@salesforce/core": "^9.1.10",
     "@salesforce/kit": "^4.0.0",
-    "@salesforce/o11y-reporter": "1.8.5",
+    "@salesforce/o11y-reporter": "1.11.0",
     "applicationinsights": "^2.9.8",
     "got": "^11",
     "o11y_schema": "^260.65.0",
     "proxy-agent": "^6.5.0"
   },
   "devDependencies": {
-    "@salesforce/dev-scripts": "^13.0.2",
+    "@salesforce/dev-scripts": "^14.0.0",
     "@types/chai": "^4.3.17",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18",
     "@types/sinon": "^10.0.20",
     "eslint": "^10.4.0",
-    "eslint-config-salesforce-typescript": "^6.0.0",
+    "eslint-config-salesforce-typescript": "^7.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.3"
+    "typescript": "^6.0.0"
   },
   "types": "lib/exported.d.ts",
   "publishConfig": {