[backend] add more telemetry data for draft & workbenches (#11014)

Author: JeremyCloarec

opencti-platform/opencti-graphql/src/domain/connector.ts

@@ -36,6 +36,7 @@ import { controlUserConfidenceAgainstElement } from '../utils/confidence-level';
 import { extractEntityRepresentativeName } from '../database/entity-representative';
 import type { BasicStoreCommon } from '../types/store';
 import type { Connector } from '../connector/internalConnector';
+import { addWorkbenchDraftConvertionCount, addWorkbenchValidationCount } from '../manager/telemetryManager';
 
 // region connectors
 export const connectorForWork = async (context: AuthContext, user: AuthUser, id: string) => {
@@ -416,6 +417,13 @@ export const askJobImport = async (
     controlUserConfidenceAgainstElement(user, entity);
   }
   const connectorsForFile = await uploadJobImport(context, user, file, entityId, opts);
+  if (file.id.startsWith('import/pending')) {
+    if (args.forceValidation && args.validationMode === 'draft') {
+      await addWorkbenchDraftConvertionCount();
+    } else if (args.bypassValidation) {
+      await addWorkbenchValidationCount();
+    }
+  }
   const entityName = entityId ? extractEntityRepresentativeName(entity) : 'global';
   const entityType = entityId ? entity.entity_type : 'global';
   const baseData: UserImportActionContextData = {

opencti-platform/opencti-graphql/src/domain/file.js

@@ -23,6 +23,7 @@ import { getDraftContext } from '../utils/draftContext';
 import { UnsupportedError } from '../config/errors';
 import { isDraftFile } from '../database/draft-utils';
 import { askJobImport } from './connector';
+import { addWorkbenchUploadCount } from '../manager/telemetryManager';
 
 export const buildOptionsFromFileManager = async (context) => {
   let importPaths = ['import/'];
@@ -129,6 +130,7 @@ export const uploadPending = async (context, user, args) => {
 
   const { upload: up } = await uploadToStorage(context, user, 'import/pending', finalFile, { meta, file_markings, errorOnExisting, entity });
   const contextData = buildContextDataForFile(entity, 'import/pending', up.name, up.metaData.file_markings);
+  await addWorkbenchUploadCount();
   await publishUserAction({
     user,
     event_type: 'file',

opencti-platform/opencti-graphql/src/manager/telemetryManager.ts

@@ -45,17 +45,36 @@ const COMPUTE_SCHEDULE_TIME = DEV_MODE ? ONE_MINUTE / 2 : ONE_HOUR / 2;
 export const TELEMETRY_GAUGE_DISSEMINATION = 'disseminationCount';
 export const TELEMETRY_GAUGE_NLQ = 'nlqQueryCount';
 export const TELEMETRY_GAUGE_REQUEST_ACCESS = 'requestAccessCreationCount';
+export const TELEMETRY_GAUGE_DRAFT_CREATION = 'draftCreationCount';
+export const TELEMETRY_GAUGE_DRAFT_VALIDATION = 'draftValidationCount';
+export const TELEMETRY_GAUGE_WORKBENCH_UPLOAD = 'workbenchUploadCount';
+export const TELEMETRY_GAUGE_WORKBENCH_DRAFT_CONVERTION = 'workbenchDraftConvertionCount';
+export const TELEMETRY_GAUGE_WORKBENCH_VALIDATION = 'workbenchValidationCount';
 
 export const addDisseminationCount = async () => {
   await redisSetTelemetryAdd(TELEMETRY_GAUGE_DISSEMINATION, 1);
 };
 export const addNlqQueryCount = async () => {
   await redisSetTelemetryAdd(TELEMETRY_GAUGE_NLQ, 1);
 };
-
 export const addRequestAccessCreationCount = async () => {
   await redisSetTelemetryAdd(TELEMETRY_GAUGE_REQUEST_ACCESS, 1);
 };
+export const addDraftCreationCount = async () => {
+  await redisSetTelemetryAdd(TELEMETRY_GAUGE_DRAFT_CREATION, 1);
+};
+export const addDraftValidationCount = async () => {
+  await redisSetTelemetryAdd(TELEMETRY_GAUGE_DRAFT_VALIDATION, 1);
+};
+export const addWorkbenchUploadCount = async () => {
+  await redisSetTelemetryAdd(TELEMETRY_GAUGE_WORKBENCH_UPLOAD, 1);
+};
+export const addWorkbenchDraftConvertionCount = async () => {
+  await redisSetTelemetryAdd(TELEMETRY_GAUGE_WORKBENCH_DRAFT_CONVERTION, 1);
+};
+export const addWorkbenchValidationCount = async () => {
+  await redisSetTelemetryAdd(TELEMETRY_GAUGE_WORKBENCH_VALIDATION, 1);
+};
 
 // End Region user event counters
 
@@ -171,6 +190,16 @@ export const fetchTelemetryData = async (manager: TelemetryMeterManager) => {
     manager.setNlqQueryCount(nlqQueryCountInRedis);
     const requestAccessCountInRedis = await redisGetTelemetry(TELEMETRY_GAUGE_REQUEST_ACCESS);
     manager.setRequestAccessCreatedCount(requestAccessCountInRedis);
+    const draftCreationCountInRedis = await redisGetTelemetry(TELEMETRY_GAUGE_DRAFT_CREATION);
+    manager.setDraftCreationCount(draftCreationCountInRedis);
+    const draftValidationCountInRedis = await redisGetTelemetry(TELEMETRY_GAUGE_DRAFT_VALIDATION);
+    manager.setDraftValidationCount(draftValidationCountInRedis);
+    const workbenchUploadCountInRedis = await redisGetTelemetry(TELEMETRY_GAUGE_WORKBENCH_UPLOAD);
+    manager.setWorkbenchUploadCount(workbenchUploadCountInRedis);
+    const workbenchDraftConvertionCountInRedis = await redisGetTelemetry(TELEMETRY_GAUGE_WORKBENCH_DRAFT_CONVERTION);
+    manager.setWorkbenchDraftConvertionCount(workbenchDraftConvertionCountInRedis);
+    const workbenchValidationCountInRedis = await redisGetTelemetry(TELEMETRY_GAUGE_WORKBENCH_VALIDATION);
+    manager.setWorkbenchValidationCount(workbenchValidationCountInRedis);
     // end region Telemetry user events
     logApp.debug('[TELEMETRY] Fetching telemetry data successfully');
   } catch (e) {

opencti-platform/opencti-graphql/src/modules/draftWorkspace/draftWorkspace-domain.ts

@@ -39,6 +39,7 @@ import { STIX_EXT_OCTI } from '../../types/stix-2-1-extensions';
 import { DRAFT_STATUS_OPEN, DRAFT_STATUS_VALIDATED } from './draftStatuses';
 import { notify } from '../../database/redis';
 import { publishUserAction } from '../../listener/UserActionListener';
+import { addDraftCreationCount, addDraftValidationCount } from '../../manager/telemetryManager';
 
 export const findById = (context: AuthContext, user: AuthUser, id: string) => {
   return storeLoadById<BasicStoreEntityDraftWorkspace>(context, user, id, ENTITY_TYPE_DRAFT_WORKSPACE);
@@ -184,6 +185,7 @@ export const addDraftWorkspace = async (context: AuthContext, user: AuthUser, in
   };
   const draftWorkspaceInput = { ...input, ...defaultOps };
   const createdDraftWorkspace = await createEntity(context, user, draftWorkspaceInput, ENTITY_TYPE_DRAFT_WORKSPACE);
+  await addDraftCreationCount();
   await publishUserAction({
     user,
     event_type: 'mutation',
@@ -340,5 +342,7 @@ export const validateDraftWorkspace = async (context: AuthContext, user: AuthUse
   await notify(BUS_TOPICS[ENTITY_TYPE_DRAFT_WORKSPACE].EDIT_TOPIC, element, user);
   await deleteDraftContextFromUsers(context, user, draft_id);
 
+  await addDraftValidationCount();
+
   return work;
 };

opencti-platform/opencti-graphql/src/telemetry/TelemetryMeterManager.ts

@@ -24,9 +24,19 @@ export class TelemetryMeterManager {
   // Number of active drafts
   draftCount = 0;
 
+  draftCreationCount = 0;
+
+  draftValidationCount = 0;
+
   // Number of active workbenches
   workbenchCount = 0;
 
+  workbenchUploadCount = 0;
+
+  workbenchDraftConvertionCount = 0;
+
+  workbenchValidationCount = 0;
+
   // Number of NLQ query call
   nlqQueryCount = 0;
 
@@ -65,10 +75,30 @@ export class TelemetryMeterManager {
     this.draftCount = n;
   }
 
+  setDraftCreationCount(n: number) {
+    this.draftCreationCount = n;
+  }
+
+  setDraftValidationCount(n: number) {
+    this.draftValidationCount = n;
+  }
+
   setWorkbenchCount(n: number) {
     this.workbenchCount = n;
   }
 
+  setWorkbenchUploadCount(n: number) {
+    this.workbenchUploadCount = n;
+  }
+
+  setWorkbenchDraftConvertionCount(n: number) {
+    this.workbenchDraftConvertionCount = n;
+  }
+
+  setWorkbenchValidationCount(n: number) {
+    this.workbenchValidationCount = n;
+  }
+
   setNlqQueryCount(n: number) {
     this.nlqQueryCount = n;
   }
@@ -97,7 +127,12 @@ export class TelemetryMeterManager {
     this.registerGauge('is_enterprise_edition', 'enterprise Edition is activated', 'isEEActivated', { unit: 'boolean' });
     this.registerGauge('call_dissemination', 'dissemination feature usage', 'disseminationCount');
     this.registerGauge('active_drafts_count', 'number of active drafts', 'draftCount');
+    this.registerGauge('draft_creation_count', 'number of draft creation', 'draftCreationCount');
+    this.registerGauge('draft_validation_count', 'number of draft validation', 'draftValidationCount');
     this.registerGauge('active_workbenches_count', 'number of active workbenches', 'workbenchCount');
+    this.registerGauge('workbench_upload_count', 'number of workbench upload - creation and updates', 'workbenchUploadCount');
+    this.registerGauge('workbench_draft_convertion_count', 'number of workbench to draft convertion', 'workbenchDraftConvertionCount');
+    this.registerGauge('workbench_validation_count', 'number of workbench validation', 'workbenchValidationCount');
     this.registerGauge('call_nlq', 'NLQ feature usage', 'nlqQueryCount');
     this.registerGauge('request_access_creation_count', 'Number of RFI of request access type that are created', 'requestAccessCreationCount');
   }