@salesforce/telemetry 6.6.0 → 6.6.2

package/README.md

@@ -107,8 +107,8 @@ const reporter = await TelemetryReporter.create({
 reporter.start();
 // Default events use the default schema
 reporter.sendTelemetryEvent('event-name', { foo: 'bar' });
-// PFT or other schema-specific events: pass schema per call
-reporter.sendTelemetryEventWithSchema('pftEventName', { userId: 'user-1', action: 'view' }, pdpEventSchema);
+// Schema-specific events: pass only attributes (must include all fields required by the schema; no properties added by reporter)
+reporter.sendTelemetryEventWithSchema({ userId: 'user-1', action: 'view', eventName: 'pftEventName' }, pdpEventSchema);
 ```
 
 **Note:** `sendTelemetryEventWithSchema` sends only to O11y (not AppInsights). Use it for events that must conform to a given schema; use `sendTelemetryEvent` for all other events.

package/lib/o11yReporter.d.ts

@@ -40,12 +40,17 @@ export declare class O11yReporter extends BaseReporter {
      * Use this method when you need to send events that conform to a particular schema
      * (e.g. PFT/pdpEventSchema). Only the events you send via this method use the given schema;
      * all other events use the default schema via sendTelemetryEvent.
+     * Only the caller-provided attributes are sent; no properties (e.g. eventName, common.*)
+     * are added by the reporter.
      *
-     * @param eventName - Name of the event
-     * @param attributes - Properties and measurements to publish alongside the event
-     * @param schema - O11y schema object (e.g. from o11y_schema package)
+     * The schema is the O11y encoding schema (e.g. from the o11y_schema package), not JSON Schema,
+     * so this library does not derive or run validation here. Callers should validate attributes
+     * (e.g. with zod) before calling, using the same schema context they use when importing the schema.
+     *
+     * @param attributes - Properties and measurements to publish (only these are sent; no properties added)
+     * @param schema - O11y encoding schema (e.g. from o11y_schema package)
      */
-    sendTelemetryEventWithSchema(eventName: string, attributes: Attributes, schema: O11ySchema): Promise<void>;
+    sendTelemetryEventWithSchema(attributes: Attributes, schema: O11ySchema): Promise<void>;
     /**
      * Sends a PDP event via O11y service.
      *

package/lib/o11yReporter.js

@@ -91,18 +91,19 @@ class O11yReporter extends baseReporter_1.BaseReporter {
      * Use this method when you need to send events that conform to a particular schema
      * (e.g. PFT/pdpEventSchema). Only the events you send via this method use the given schema;
      * all other events use the default schema via sendTelemetryEvent.
+     * Only the caller-provided attributes are sent; no properties (e.g. eventName, common.*)
+     * are added by the reporter.
      *
-     * @param eventName - Name of the event
-     * @param attributes - Properties and measurements to publish alongside the event
-     * @param schema - O11y schema object (e.g. from o11y_schema package)
+     * The schema is the O11y encoding schema (e.g. from the o11y_schema package), not JSON Schema,
+     * so this library does not derive or run validation here. Callers should validate attributes
+     * (e.g. with zod) before calling, using the same schema context they use when importing the schema.
+     *
+     * @param attributes - Properties and measurements to publish (only these are sent; no properties added)
+     * @param schema - O11y encoding schema (e.g. from o11y_schema package)
      */
-    async sendTelemetryEventWithSchema(eventName, attributes, schema) {
+    async sendTelemetryEventWithSchema(attributes, schema) {
         await this.initialized;
-        const merged = { ...this.commonProperties, ...attributes };
-        const eventData = {
-            eventName: `${this.extensionName}/${eventName}`,
-            ...merged,
-        };
+        const eventData = { ...attributes };
         this.service.logEventWithSchema(eventData, schema);
         if (!this._batchingEnabled) {
             await this.service.forceFlush();

package/lib/telemetryReporter.d.ts

@@ -38,12 +38,16 @@ export declare class TelemetryReporter extends AsyncCreatable<TelemetryOptions>
      * Sends a telemetry event to O11y only with a specific schema.
      * Use this for events that must conform to a given schema (e.g. PFT/pdpEventSchema).
      * Does not send to AppInsights. Only sends when O11y is enabled and reporter is initialized.
+     * Only the caller-provided attributes are sent; no properties are added by the reporter.
      *
-     * @param eventName - Name of the event
-     * @param attributes - Properties and measurements to publish alongside the event
-     * @param schema - O11y schema object (e.g. from o11y_schema package)
+     * The schema is the O11y encoding schema (e.g. from the o11y_schema package), not JSON Schema,
+     * so this library does not derive or run validation here. Callers should validate attributes
+     * (e.g. with zod) before calling, using the same schema context they use when importing the schema.
+     *
+     * @param attributes - Properties and measurements to publish (only these are sent)
+     * @param schema - O11y encoding schema (e.g. from o11y_schema package)
      */
-    sendTelemetryEventWithSchema(eventName: string, attributes: Attributes, schema: O11ySchema): void;
+    sendTelemetryEventWithSchema(attributes: Attributes, schema: O11ySchema): void;
     /**
      * Sends a PDP event via O11y.
      *

package/lib/telemetryReporter.js

@@ -191,14 +191,18 @@ class TelemetryReporter extends kit_1.AsyncCreatable {
      * Sends a telemetry event to O11y only with a specific schema.
      * Use this for events that must conform to a given schema (e.g. PFT/pdpEventSchema).
      * Does not send to AppInsights. Only sends when O11y is enabled and reporter is initialized.
+     * Only the caller-provided attributes are sent; no properties are added by the reporter.
      *
-     * @param eventName - Name of the event
-     * @param attributes - Properties and measurements to publish alongside the event
-     * @param schema - O11y schema object (e.g. from o11y_schema package)
+     * The schema is the O11y encoding schema (e.g. from the o11y_schema package), not JSON Schema,
+     * so this library does not derive or run validation here. Callers should validate attributes
+     * (e.g. with zod) before calling, using the same schema context they use when importing the schema.
+     *
+     * @param attributes - Properties and measurements to publish (only these are sent)
+     * @param schema - O11y encoding schema (e.g. from o11y_schema package)
      */
-    sendTelemetryEventWithSchema(eventName, attributes, schema) {
+    sendTelemetryEventWithSchema(attributes, schema) {
         if (this.isSfdxTelemetryEnabled() && this.enableO11y && this.o11yReporter) {
-            void this.o11yReporter.sendTelemetryEventWithSchema(eventName, attributes, schema).catch((error) => {
+            void this.o11yReporter.sendTelemetryEventWithSchema(attributes, schema).catch((error) => {
                 this.logger.debug('Failed to send event with schema to O11y:', error);
             });
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/telemetry",
-  "version": "6.6.0",
+  "version": "6.6.2",
   "description": "Library for telemetry reporting to Application Insights and O11y",
   "main": "lib/exported",
   "exports": {
@@ -41,7 +41,7 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/core": "^8.25.1",
+    "@salesforce/core": "^8.26.0",
     "@salesforce/kit": "^3.2.4",
     "@salesforce/o11y-reporter": "1.7.3",
     "applicationinsights": "^2.9.8",