Skip to content

The open alternative to Salesforce, designed for AI.

feat(server): add a gauge tracking feature flag rollout across workspaces (#24685)

Charles Bochet7e1dc6fcba0b
diff --git a/packages/twenty-server/src/engine/core-modules/feature-flag/feature-flag.module.ts b/packages/twenty-server/src/engine/core-modules/feature-flag/feature-flag.module.ts
index d636e2919f8..eb2046dd209 100644
--- a/packages/twenty-server/src/engine/core-modules/feature-flag/feature-flag.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/feature-flag/feature-flag.module.ts
@@ -3,7 +3,9 @@ import { TypeOrmModule } from '@nestjs/typeorm';
import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
+import { FeatureFlagGaugeService } from 'src/engine/core-modules/feature-flag/services/feature-flag-gauge.service';
import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
+import { MetricsModule } from 'src/engine/core-modules/metrics/metrics.module';
import { WorkspaceFeatureFlagsMapCacheModule } from 'src/engine/metadata-modules/workspace-feature-flags-map-cache/workspace-feature-flags-map-cache.module';
import { provideWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/provide-workspace-scoped-repository';
import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache.module';
@@ -12,12 +14,14 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
imports: [
TypeORMModule,
TypeOrmModule.forFeature([FeatureFlagEntity]),
+ MetricsModule,
WorkspaceFeatureFlagsMapCacheModule,
WorkspaceCacheModule,
],
exports: [FeatureFlagService],
providers: [
FeatureFlagService,
+ FeatureFlagGaugeService,
provideWorkspaceScopedRepository(FeatureFlagEntity),
],
})
diff --git a/packages/twenty-server/src/engine/core-modules/feature-flag/services/feature-flag-gauge.service.ts b/packages/twenty-server/src/engine/core-modules/feature-flag/services/feature-flag-gauge.service.ts
new file mode 100644
index 00000000000..5573d5a48a6
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/feature-flag/services/feature-flag-gauge.service.ts
@@ -0,0 +1,66 @@
+import { Injectable, OnModuleInit } from '@nestjs/common';
+import { InjectDataSource } from '@nestjs/typeorm';
+
+import { FeatureFlagKey } from 'twenty-shared/types';
+import { DataSource } from 'typeorm';
+
+import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
+import { MetricsService } from 'src/engine/core-modules/metrics/metrics.service';
+
+const ENABLED_WORKSPACES_METRIC_NAME = 'twenty_feature_flag_enabled_workspaces';
+
+// The rollout gauge counts enabled workspaces across every tenant, so it needs
+// the global repository rather than the workspace-scoped one (there is no
+// workspace context during a metrics scrape).
+@Injectable()
+export class FeatureFlagGaugeService implements OnModuleInit {
+ constructor(
+ @InjectDataSource()
+ private readonly dataSource: DataSource,
+ private readonly metricsService: MetricsService,
+ ) {}
+
+ onModuleInit() {
+ this.metricsService.createMultiObservableGauge({
+ metricName: ENABLED_WORKSPACES_METRIC_NAME,
+ options: {
+ description:
+ 'Number of workspaces with a given feature flag enabled, labelled by flag_key. Tracks the progress of a feature flag rollout.',
+ },
+ callback: async () => {
+ const enabledWorkspacesByFlag =
+ await this.getEnabledWorkspaceCountsByFlag();
+
+ // Emit a series for every known flag, defaulting to 0, so a flag with
+ // no enabled workspaces reads as zero rollout rather than missing data.
+ return Object.values(FeatureFlagKey).map((flagKey) => ({
+ value: enabledWorkspacesByFlag.get(flagKey) ?? 0,
+ attributes: { flag_key: flagKey },
+ }));
+ },
+ cacheValue: true,
+ });
+ }
+
+ private async getEnabledWorkspaceCountsByFlag(): Promise<
+ Map<string, number>
+ > {
+ // Join workspace and filter deletedAt: the workspace relation cascades on
+ // hard delete only, and featureFlag has no deletedAt, so a soft-deleted
+ // workspace would otherwise keep counting toward the rollout forever.
+ const rows = await this.dataSource
+ .getRepository(FeatureFlagEntity)
+ .createQueryBuilder('featureFlag')
+ .select('featureFlag.key', 'flagKey')
+ .addSelect('COUNT(*)', 'enabledWorkspaces')
+ .innerJoin('featureFlag.workspace', 'workspace')
+ .where('featureFlag.value = :value', { value: true })
+ .andWhere('workspace.deletedAt IS NULL')
+ .groupBy('featureFlag.key')
+ .getRawMany<{ flagKey: string; enabledWorkspaces: string }>();
+
+ return new Map(
+ rows.map((row) => [row.flagKey, Number(row.enabledWorkspaces)]),
+ );
+ }
+}