[#172884826] Automatic download event tracking

UserDataDownloadOrchestrator/handler.ts

@@ -10,6 +10,7 @@ import { ActivityResultSuccess as ExtractUserDataActivityResultSuccess } from ".
 import { ActivityResultSuccess as SendUserDataDownloadMessageActivityResultSuccess } from "../SendUserDataDownloadMessageActivity/handler";
 import { ActivityResultSuccess as SetUserDataProcessingStatusActivityResultSuccess } from "../SetUserDataProcessingStatusActivity/handler";
 import { ProcessableUserDataDownload } from "../UserDataProcessingTrigger";
+import { trackEvent, trackException } from "../utils/appinsights";
 
 const logPrefix = "UserDataDownloadOrchestrator";
 
@@ -142,8 +143,28 @@ export const handler = function*(
         status: UserDataProcessingStatusEnum.CLOSED
       });
     });
+
+    trackEvent({
+      // tslint:disable-next-line: no-duplicate-string
+      name: "user.data.download",
+      properties: {
+        userDataProcessingId: currentUserDataProcessing.userDataProcessingId
+      },
+      tagOverrides: {
+        "ai.operation.id": currentUserDataProcessing.userDataProcessingId,
+        "ai.operation.parentId": currentUserDataProcessing.userDataProcessingId
+      }
+    });
+
     return OrchestratorSuccess.encode({ kind: "SUCCESS" });
   } catch (error) {
+    trackException({
+      exception: new Error(error),
+      properties: {
+        name: "user.data.download",
+        userDataProcessingId: currentUserDataProcessing.userDataProcessingId
+      }
+    });
     context.log.error(
       `${logPrefix}|ERROR|Failed processing user data for download: ${error.message}`
     );
@@ -153,6 +174,14 @@ export const handler = function*(
         nextStatus: UserDataProcessingStatusEnum.FAILED
       })
     ).getOrElseL(err => {
+      trackException({
+        exception: new Error(readableReport(err)),
+        properties: {
+          name: "user.data.download",
+          type: "unhandled exception when trying to set document as FAILED",
+          userDataProcessingId: currentUserDataProcessing.userDataProcessingId
+        }
+      });
       throw new Error(
         `Activity SetUserDataProcessingStatusActivity (status=FAILED) failed: ${readableReport(
           err

__mocks__/applicationinsights.ts

@@ -0,0 +1,4 @@
+export const defaultClient = {
+  trackEvent: jest.fn(),
+  trackException: jest.fn()
+};

utils/appinsights.ts

@@ -0,0 +1,41 @@
+import * as ai from "applicationinsights";
+import {
+  EventTelemetry,
+  ExceptionTelemetry
+} from "applicationinsights/out/Declarations/Contracts";
+import { fromNullable } from "fp-ts/lib/Option";
+import { tryCatch } from "fp-ts/lib/Option";
+import { initAppInsights } from "italia-ts-commons/lib/appinsights";
+import { IntegerFromString } from "italia-ts-commons/lib/numbers";
+import { NonEmptyString } from "italia-ts-commons/lib/strings";
+
+// the internal function runtime has MaxTelemetryItem per second set to 20 by default
+// @see https://github.com/Azure/azure-functions-host/blob/master/src/WebJobs.Script/Config/ApplicationInsightsLoggerOptionsSetup.cs#L29
+const DEFAULT_SAMPLING_PERCENTAGE = 20;
+
+// Avoid to initialize Application Insights more than once
+export const initTelemetryClient = (env = process.env) =>
+  ai.defaultClient
+    ? ai.defaultClient
+    : NonEmptyString.decode(env.APPINSIGHTS_INSTRUMENTATIONKEY).fold(
+        _ => undefined,
+        k =>
+          initAppInsights(k, {
+            disableAppInsights: env.APPINSIGHTS_DISABLE === "true",
+            samplingPercentage: IntegerFromString.decode(
+              env.APPINSIGHTS_SAMPLING_PERCENTAGE
+            ).getOrElse(DEFAULT_SAMPLING_PERCENTAGE)
+          })
+      );
+
+export const trackEvent = (event: EventTelemetry) => {
+  fromNullable(initTelemetryClient()).map(_ =>
+    tryCatch(() => _.trackEvent(event))
+  );
+};
+
+export const trackException = (event: ExceptionTelemetry) => {
+  fromNullable(initTelemetryClient()).map(_ =>
+    tryCatch(() => _.trackException(event))
+  );
+};