@ms-cloudpack/external-telemetry 0.0.1

package/README.md

@@ -0,0 +1,18 @@
+# @ms-cloudpack/external-telemetry
+
+A library for report external telemetry data important to Cloudpack workflows. Data will be reported to Application Insights using Open Telemetry standards and show up on our internal dashboards for monitoring the changes in timings and usage of existing scenarios as we migrate to new Cloudpack-powered workflows.
+
+## Example usage
+
+1. Create a client:
+
+```ts
+import { reportExternalTelemetryEvent } from '@ms-cloudpack/external-telemetry';
+
+await reportExternalTelemetryEvent({
+  eventName: 'LEGACY-START',
+  attributes: {
+    'my-attribute': 'value',
+  },
+});
+```

package/lib/getAppName.d.ts

@@ -0,0 +1 @@
+export declare function getAppName(): Promise<string | undefined>;

package/lib/getAppName.js

@@ -0,0 +1,10 @@
+import { PackageDefinitions } from '@ms-cloudpack/package-utilities';
+export async function getAppName() {
+    const appPath = process.cwd();
+    const definition = await PackageDefinitions.getInstance().get(appPath);
+    if (!definition) {
+        throw new Error(`There was no package.json located at "${appPath}".`);
+    }
+    return definition.name;
+}
+//# sourceMappingURL=getAppName.js.map

package/lib/getAppName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAppName.js","sourceRoot":"","sources":["../src/getAppName.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,CAAC,KAAK,UAAU,UAAU;IAC9B,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC9B,MAAM,UAAU,GAAG,MAAM,kBAAkB,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAEvE,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,yCAAyC,OAAO,IAAI,CAAC,CAAC;KACvE;IAED,OAAO,UAAU,CAAC,IAAI,CAAC;AACzB,CAAC","sourcesContent":["import { PackageDefinitions } from '@ms-cloudpack/package-utilities';\n\nexport async function getAppName() {\n  const appPath = process.cwd();\n  const definition = await PackageDefinitions.getInstance().get(appPath);\n\n  if (!definition) {\n    throw new Error(`There was no package.json located at \"${appPath}\".`);\n  }\n\n  return definition.name;\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { reportExternalTelemetryEvent } from './reportExternalTelemetryEvent.js';
+export type { ReportTelemetryOptions } from './types.js';

package/lib/index.js

@@ -0,0 +1,2 @@
+export { reportExternalTelemetryEvent } from './reportExternalTelemetryEvent.js';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC","sourcesContent":["export { reportExternalTelemetryEvent } from './reportExternalTelemetryEvent.js';\nexport type { ReportTelemetryOptions } from './types.js';\n"]}

package/lib/reportExternalTelemetryEvent.d.ts

@@ -0,0 +1,6 @@
+import type { ReportTelemetryOptions } from './types.js';
+/**
+ * Report an external telemetry event to the CloudPack telemetry service.
+ * @param options - The options for reporting the event.
+ */
+export declare function reportExternalTelemetryEvent(options: ReportTelemetryOptions): Promise<void>;

package/lib/reportExternalTelemetryEvent.js

@@ -0,0 +1,26 @@
+import { readConfig } from '@ms-cloudpack/config';
+import { createTelemetryClient } from '@ms-cloudpack/telemetry';
+import { getVersion } from '@ms-cloudpack/package-utilities';
+import { getAppName } from './getAppName.js';
+const external = 'EXTERNAL';
+/**
+ * Report an external telemetry event to the CloudPack telemetry service.
+ * @param options - The options for reporting the event.
+ */
+export async function reportExternalTelemetryEvent(options) {
+    const { telemetry } = await readConfig();
+    const instrumentationKey = telemetry?.instrumentationKey || process.env.CLOUDPACK_TELEMETRY_INSTRUMENTATION_KEY;
+    const telemetryClient = await createTelemetryClient({
+        productVersion: getVersion(import.meta.url),
+        serviceName: 'external-telemetry',
+        serviceNamespace: 'cloudpack',
+        instrumentationKey: instrumentationKey,
+        logLevel: options.logLevel,
+    });
+    telemetryClient.setSharedSpanAttribute('appName', options.appName || (await getAppName()) || '<unknown>');
+    const externalTelemetrySpan = telemetryClient.getTracer().startSpan(external);
+    externalTelemetrySpan.addEvent(`${external}-${options.eventName}`, options.attributes);
+    externalTelemetrySpan.end();
+    await telemetryClient.shutdown();
+}
+//# sourceMappingURL=reportExternalTelemetryEvent.js.map

package/lib/reportExternalTelemetryEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportExternalTelemetryEvent.js","sourceRoot":"","sources":["../src/reportExternalTelemetryEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,MAAM,QAAQ,GAAG,UAAU,CAAC;AAE5B;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,OAA+B;IAChF,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,UAAU,EAAE,CAAC;IACzC,MAAM,kBAAkB,GAAG,SAAS,EAAE,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC;IAEhH,MAAM,eAAe,GAAG,MAAM,qBAAqB,CAAC;QAClD,cAAc,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QAC3C,WAAW,EAAE,oBAAoB;QACjC,gBAAgB,EAAE,WAAW;QAC7B,kBAAkB,EAAE,kBAAkB;QACtC,QAAQ,EAAE,OAAO,CAAC,QAAQ;KAC3B,CAAC,CAAC;IAEH,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,IAAI,CAAC,MAAM,UAAU,EAAE,CAAC,IAAI,WAAW,CAAC,CAAC;IAE1G,MAAM,qBAAqB,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAE9E,qBAAqB,CAAC,QAAQ,CAAC,GAAG,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvF,qBAAqB,CAAC,GAAG,EAAE,CAAC;IAE5B,MAAM,eAAe,CAAC,QAAQ,EAAE,CAAC;AACnC,CAAC","sourcesContent":["import { readConfig } from '@ms-cloudpack/config';\nimport { createTelemetryClient } from '@ms-cloudpack/telemetry';\nimport { getVersion } from '@ms-cloudpack/package-utilities';\nimport { getAppName } from './getAppName.js';\nimport type { ReportTelemetryOptions } from './types.js';\n\nconst external = 'EXTERNAL';\n\n/**\n * Report an external telemetry event to the CloudPack telemetry service.\n * @param options - The options for reporting the event.\n */\nexport async function reportExternalTelemetryEvent(options: ReportTelemetryOptions) {\n  const { telemetry } = await readConfig();\n  const instrumentationKey = telemetry?.instrumentationKey || process.env.CLOUDPACK_TELEMETRY_INSTRUMENTATION_KEY;\n\n  const telemetryClient = await createTelemetryClient({\n    productVersion: getVersion(import.meta.url),\n    serviceName: 'external-telemetry',\n    serviceNamespace: 'cloudpack',\n    instrumentationKey: instrumentationKey,\n    logLevel: options.logLevel,\n  });\n\n  telemetryClient.setSharedSpanAttribute('appName', options.appName || (await getAppName()) || '<unknown>');\n\n  const externalTelemetrySpan = telemetryClient.getTracer().startSpan(external);\n\n  externalTelemetrySpan.addEvent(`${external}-${options.eventName}`, options.attributes);\n\n  externalTelemetrySpan.end();\n\n  await telemetryClient.shutdown();\n}\n"]}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.4"
+    }
+  ]
+}

package/lib/types.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Options for external telemetry.
+ */
+export interface ReportTelemetryOptions {
+    /**
+     * Event name to be reported into application insights.
+     * "EXTERNAL-" prefix will be added by cloudpack.
+     */
+    eventName: string;
+    /**
+     * Application name to be reported into application insights.
+     */
+    appName?: string;
+    /**
+     * Additional attributes to be reported into application insights.
+     */
+    attributes?: Record<string, string>;
+    /**
+     * Log level to be used by application insights.
+     */
+    logLevel?: 'debug' | 'verbose';
+}

package/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Options for external telemetry.\n */\nexport interface ReportTelemetryOptions {\n  /**\n   * Event name to be reported into application insights.\n   * \"EXTERNAL-\" prefix will be added by cloudpack.\n   */\n  eventName: string;\n\n  /**\n   * Application name to be reported into application insights.\n   */\n  appName?: string;\n\n  /**\n   * Additional attributes to be reported into application insights.\n   */\n  attributes?: Record<string, string>;\n\n  /**\n   * Log level to be used by application insights.\n   */\n  logLevel?: 'debug' | 'verbose';\n}\n"]}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@ms-cloudpack/external-telemetry",
+  "version": "0.0.1",
+  "description": "Reporting external telemetry which is not about of cloudpack internals.",
+  "license": "MIT",
+  "type": "module",
+  "types": "./lib/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
+  },
+  "dependencies": {
+    "@ms-cloudpack/telemetry": "^0.2.2",
+    "@ms-cloudpack/config": "^0.4.0",
+    "@ms-cloudpack/package-utilities": "^2.4.0",
+    "@ms-cloudpack/path-utilities": "^2.2.1",
+    "@ms-cloudpack/json-utilities": "^0.0.6",
+    "@ms-cloudpack/bundler-types": "^0.12.0"
+  },
+  "devDependencies": {
+    "@ms-cloudpack/eslint-config-base": "*",
+    "@ms-cloudpack/scripts": "*"
+  },
+  "scripts": {
+    "api:update": "cloudpack-scripts api-update",
+    "api": "cloudpack-scripts api",
+    "build:watch": "cloudpack-scripts build-watch",
+    "build": "cloudpack-scripts build",
+    "lint:update": "cloudpack-scripts lint-update",
+    "lint": "cloudpack-scripts lint"
+  },
+  "files": [
+    "lib/**/!(*.test.*)"
+  ]
+}