@sap-ux/telemetry 1.0.25 → 2.0.0

package/dist/base/client/index.js

@@ -35,9 +35,16 @@ class ClientFactory {
         if (!key) {
             return '';
         }
-        // ApplicationInsights v3+ requires InstrumentationKey=<uuid> format
+        // ApplicationInsights v3+ requires InstrumentationKey=<uuid> format.
+        // The IngestionEndpoint/LiveEndpoint must be set explicitly: the @azure/monitor-opentelemetry-exporter
+        // (>= 1.0.0-beta.44, pulled in by applicationinsights 3.16.0) refuses to follow the global endpoint's
+        // cross-origin 307/308 redirect to the regional endpoint (isSameRegisteredDomain guard), so a bare
+        // InstrumentationKey would silently drop all telemetry. The endpoints default to the westus2 region
+        // and can be overridden by the consumer via initTelemetrySettings.
         const instrumentationKey = key === instrumentationKeyPlaceholder ? '00000000-0000-0000-0000-000000000000' : key;
-        return `InstrumentationKey=${instrumentationKey}`;
+        return (`InstrumentationKey=${instrumentationKey};` +
+            `IngestionEndpoint=${TelemetrySettings.azureIngestionEndpoint};` +
+            `LiveEndpoint=${TelemetrySettings.azureLiveEndpoint};`);
     }
 }
 export { ClientFactory };

package/dist/base/config-state.d.ts

@@ -3,6 +3,8 @@
  */
 export declare const TelemetrySettings: {
     azureInstrumentationKey: string;
+    azureIngestionEndpoint: string;
+    azureLiveEndpoint: string;
     telemetryEnabled: boolean;
     telemetryLibName: string;
     telemetryLibVersion: string;

package/dist/base/config-state.js

@@ -5,6 +5,12 @@ import packageJson from '../../package.json' with { type: 'json' };
 export const TelemetrySettings = {
     // Target Azure apps insight destination
     azureInstrumentationKey: '',
+    // Regional Azure App Insights ingestion endpoint. Must be set explicitly because the
+    // @azure/monitor-opentelemetry-exporter (>= 1.0.0-beta.44) refuses to follow the global
+    // endpoint's cross-origin redirect to the regional endpoint. Consumers may override this default.
+    azureIngestionEndpoint: 'https://westus2-0.in.applicationinsights.azure.com/',
+    // Regional Azure App Insights live-metrics endpoint. Consumers may override this default.
+    azureLiveEndpoint: 'https://westus2.livediagnostics.monitor.azure.com/',
     // Allow user to opt out from telemetry collection
     telemetryEnabled: true,
     // Module name in telemetry/pacakge.json

package/dist/base/utils/azure-client-config.js

@@ -1,4 +1,8 @@
 // import type { TelemetryItem } from 'applicationinsights'; // not exported
+// Mask OTEL resource attributes that become cloud_RoleName / cloud_RoleInstance in Azure Portal.
+// Must be set before the first TelemetryClient.initialize() call (which happens lazily on first trackEvent).
+// applicationinsights v3 reads these via envDetector during initialize(); context.tags has no effect on them.
+process.env.OTEL_RESOURCE_ATTRIBUTES ??= 'service.name=masked,service.instance.id=masked';
 /**
  * Enable local caching of telemetry data when offline.
  * Disable GDPR private data that are collected by Azure AppInsight client.
@@ -14,13 +18,11 @@ export function configAzureTelemetryClient(client) {
             // setUseDiskRetryCaching may throw "Not implemented"
         }
     }
-    client.addTelemetryProcessor((envelope /* TelemetryItem */) => {
-        envelope.tags ??= {};
-        envelope.tags['ai.location.ip'] = '0.0.0.0';
-        envelope.tags['ai.cloud.roleInstance'] = 'masked';
-        envelope.tags['ai.cloud.role'] = 'masked';
-        envelope.tags['ai.device.type'] = 'masked';
-        return true;
-    });
+    client.context.tags ??= {};
+    client.context.tags['ai.location.ip'] = '0.0.0.0';
+    client.context.tags['microsoft.client.ip'] = '0.0.0.0';
+    client.context.tags['ai.cloud.roleInstance'] = 'masked';
+    client.context.tags['ai.cloud.role'] = 'masked';
+    client.context.tags['ai.device.type'] = 'masked';
 }
 //# sourceMappingURL=azure-client-config.js.map

package/dist/tooling-telemetry/telemetry-settings.js

@@ -105,6 +105,12 @@ export const initTelemetrySettings = async (options) => {
         if (options.resourceId) {
             TelemetrySettings.azureInstrumentationKey = options.resourceId;
         }
+        if (options.ingestionEndpoint) {
+            TelemetrySettings.azureIngestionEndpoint = options.ingestionEndpoint;
+        }
+        if (options.liveEndpoint) {
+            TelemetrySettings.azureLiveEndpoint = options.liveEndpoint;
+        }
         const storeService = await getService({
             entityName: 'telemetrySetting'
         });

package/dist/tooling-telemetry/types.d.ts

@@ -11,6 +11,8 @@ export type TelemetryHelperProperties = {
  * - internalFeature: if UX tooling InternalFeature is enabled
  * - watchTelemetrySettingStore: watch changes to telemetry setting in the store and update runtime settings accordingly (recommended for extensions)
  * - resourceId: Id of cloud telemetry resource (e.g. Azure application insights resource is supported).
+ * - ingestionEndpoint: override the default Azure App Insights regional ingestion endpoint.
+ * - liveEndpoint: override the default Azure App Insights regional live-metrics endpoint.
  *
  */
 export type ToolsSuiteTelemetryInitSettings = {
@@ -18,6 +20,8 @@ export type ToolsSuiteTelemetryInitSettings = {
     internalFeature: boolean;
     watchTelemetrySettingStore: boolean;
     resourceId?: string;
+    ingestionEndpoint?: string;
+    liveEndpoint?: string;
 };
 export declare enum ToolsId {
     UNKNOWN = "UNKNOWN",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/telemetry",
-  "version": "1.0.25",
+  "version": "2.0.0",
   "description": "Library for sending usage telemetry data",
   "type": "module",
   "repository": {
@@ -15,7 +15,7 @@
   "private": false,
   "main": "dist/index.js",
   "dependencies": {
-    "applicationinsights": "3.15.1",
+    "applicationinsights": "3.16.0",
     "axios": "1.18.1",
     "performance-now": "2.1.0",
     "yaml": "2.9.0",