console/packages/services/cdn-worker/src/analytics.ts

export interface AnalyticsEngine {
  writeDataPoint(input: { blobs?: string[]; doubles?: number[]; indexes?: string[] }): void;
}

export type Analytics = ReturnType<typeof createAnalytics>;

type Event =
  | {
      type: 'artifact';
      version: 'v0' | 'v1';
      value:
        | 'schema'
        | 'supergraph'
        | 'sdl'
        | 'metadata'
        | 'introspection'
        | 'services'
        | 'sdl.graphql'
        | 'sdl.graphqls';
    }
  | {
      type: 'app-deployment-operation';
      version: 'v1';
    }
  | {
      type: 'key-validation';
      value:
        | {
            type: 'cache-hit';
            version: 'v1' | 'legacy';
            isValid: boolean;
          }
        | {
            type: 'cache-write';
            version: 'v1' | 'legacy';
            isValid: boolean;
          }
        | {
            type: 's3-key-read-failure';
            version: 'v1' | 'legacy';
            status: number | null;
          }
        | {
            type: 's3-key-compare-failure';
            version: 'v1' | 'legacy';
          }
        | {
            type: 's3-key-validation';
            version: 'v1' | 'legacy';
            status: 'success' | 'failure';
          };
    }
  | {
      type: 'error';
      value: [string, string] | [string];
    }
  | {
      type: 'r2' | 's3';
      action:
        | 'GET artifact'
        | 'GET cdn-legacy-keys'
        | 'GET cdn-access-token'
        | 'GET persistedOperation'
        | 'HEAD appDeploymentIsEnabled';
      // Either 3 digit status code or error code e.g. timeout, http error etc.
      statusCodeOrErrCode: number | string;
      /** duration in milliseconds */
      duration: number;
    }
  | {
      type: 'response';
      statusCode: number;
      requestPath: string;
    };

export function createAnalytics(
  engines: {
    usage: AnalyticsEngine;
    error: AnalyticsEngine;
    keyValidation: AnalyticsEngine;
    r2: AnalyticsEngine;
    s3: AnalyticsEngine;
    response: AnalyticsEngine;
  } | null = null,
) {
  return {
    track(event: Event, targetId: string) {
      if (!engines) {
        return;
      }

      try {
        switch (event.type) {
          case 'artifact':
            return engines.usage.writeDataPoint({
              blobs: [event.version, event.value, targetId],
              indexes: [targetId.substring(0, 32)],
            });
          case 'error':
            return engines.error.writeDataPoint({
              blobs: event.value,
            });
          case 'r2':
          case 's3':
            return engines[event.type].writeDataPoint({
              blobs: [event.action, event.statusCodeOrErrCode.toString(), targetId],
              doubles: [event.duration],
              indexes: [targetId.substring(0, 32)],
            });
          case 'response':
            return engines.response.writeDataPoint({
              blobs: [event.statusCode.toString(), event.requestPath, targetId],
              indexes: [targetId.substring(0, 32)],
            });
          case 'key-validation':
            switch (event.value.type) {
              case 'cache-hit':
                return engines.keyValidation.writeDataPoint({
                  blobs: [
                    'cache-hit',
                    event.value.version,
                    event.value.isValid ? 'valid' : 'invalid',
                  ],
                  indexes: [targetId.substring(0, 32)],
                });
              case 'cache-write':
                return engines.keyValidation.writeDataPoint({
                  blobs: [
                    'cache-write',
                    event.value.version,
                    event.value.isValid ? 'valid' : 'invalid',
                  ],
                  indexes: [targetId.substring(0, 32)],
                });
              case 's3-key-validation':
                return engines.keyValidation.writeDataPoint({
                  blobs: ['s3-key-validation', event.value.version, event.value.status],
                  indexes: [targetId.substring(0, 32)],
                });
            }
        }
      } catch (err) {
        console.log(`Analytics.track: Error while trying to write databapoints`);
        console.log(err);
      }
    },
  };
}