feat(api-gateway, server-core): Orchestration API telemetry (#6419)

Author: buntarb

packages/cubejs-api-gateway/src/gateway.ts

@@ -136,6 +136,8 @@ class ApiGateway {
 
   protected readonly playgroundAuthSecret?: string;
 
+  protected readonly event: (name: string, props?: object) => void;
+
   public constructor(
     protected readonly apiSecret: string,
     protected readonly compilerApi: any,
@@ -166,6 +168,8 @@ class ApiGateway {
     this.requestLoggerMiddleware = options.requestLoggerMiddleware || this.requestLogger;
     this.contextRejectionMiddleware = options.contextRejectionMiddleware || (async (req, res, next) => next());
     this.wsContextAcceptor = options.wsContextAcceptor || (() => ({ accepted: true }));
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    this.event = options.event || function () {};
   }
 
   public initApp(app: ExpressApplication) {
@@ -794,6 +798,9 @@ class ApiGateway {
         default:
           throw new Error(`The '${query.action}' action type doesn't supported.`);
       }
+      this.event(`pre_aggregations_jobs_${query.action}`, {
+        source: req.header('source') || 'unknown',
+      });
       response(result, { status: 200 });
     } catch (e) {
       this.handleError({ e, context, query, res: response, started });

packages/cubejs-api-gateway/src/types/gateway.ts

@@ -70,6 +70,7 @@ interface ApiGatewayOptions {
    */
   checkAuthMiddleware?: CheckAuthMiddlewareFn;
   contextToApiScopes?: ContextToApiScopesFn;
+  event?: (name: string, props?: object) => void;
 }
 
 export {

packages/cubejs-server-core/src/core/server.ts

@@ -457,6 +457,7 @@ export class CubejsServerCore {
         scheduledRefreshTimeZones: this.options.scheduledRefreshTimeZones,
         serverCoreVersion: this.coreServerVersion,
         contextToApiScopes: this.options.contextToApiScopes,
+        event: this.event,
       }
     ));
   }