@oneuptime/common 11.5.9 → 11.5.10

package/build/dist/Models/AnalyticsModels/MetricItemAggMV1mByK8sCluster.js

@@ -0,0 +1,158 @@
+import AnalyticsBaseModel from "./AnalyticsBaseModel/AnalyticsBaseModel";
+import AnalyticsTableEngine from "../../Types/AnalyticsDatabase/AnalyticsTableEngine";
+import AnalyticsTableName from "../../Types/AnalyticsDatabase/AnalyticsTableName";
+import AnalyticsTableColumn from "../../Types/AnalyticsDatabase/TableColumn";
+import TableColumnType from "../../Types/AnalyticsDatabase/TableColumnType";
+/**
+ * Per-(k8s cluster, minute) pre-aggregated rollup of `MetricItemV3` value
+ * samples — sibling of `MetricItemAggMV1mByHostV2`, keyed by the stable
+ * 16-hex `k8sClusterEntityKey` the ingest pipeline stamps on every row
+ * whose resource carries a Kubernetes cluster identity. Cluster identity
+ * is `k8s.cluster.name` ONLY (see `TelemetryEntity.k8sClusterIdentity`),
+ * so the read side can derive the key directly from the incoming
+ * `resource.k8s.cluster.name` filter via
+ * `EntityKey.keyForKubernetesCluster` — no registry lookup needed.
+ *
+ * Populated by `MetricItemAggMV1mByK8sCluster_mv` (declared below;
+ * created idempotently by boot schema-sync — the service is registered
+ * in AnalyticsServices — and backfilled from `MetricItemV3` by the
+ * AddMetricEntityMinuteAggregateMaterializedViews migration). Rows whose
+ * resource carries no cluster entity (`k8sClusterEntityKey = ''`) are
+ * filtered out so the rollup stays small.
+ *
+ * Read access goes through
+ * `MetricService.tryBuildEntityAggregateMVStatement` — the dominant path
+ * for the Kubernetes cluster detail page's Metrics tab.
+ *
+ * No CRUD API; read-only infrastructure populated entirely by the MV.
+ */
+export default class MetricItemAggMV1mByK8sCluster extends AnalyticsBaseModel {
+    constructor() {
+        const projectIdColumn = new AnalyticsTableColumn({
+            key: "projectId",
+            title: "Project ID",
+            description: "ID of project (tenant key, replicated from MetricItemV3)",
+            required: true,
+            type: TableColumnType.Text,
+            isTenantId: true,
+        });
+        const nameColumn = new AnalyticsTableColumn({
+            key: "name",
+            title: "Metric Name",
+            description: "Metric name (replicated from MetricItemV3)",
+            required: true,
+            type: TableColumnType.Text,
+        });
+        const k8sClusterEntityKeyColumn = new AnalyticsTableColumn({
+            key: "k8sClusterEntityKey",
+            title: "Kubernetes Cluster Entity Key",
+            description: "Stable 16-hex k8s cluster entity key (EntityKey.keyForKubernetesCluster) replicated from MetricItemV3.k8sClusterEntityKey at insert time. Rows without one are filtered out by the MV's WHERE clause so this column is always populated for rows that exist.",
+            required: true,
+            type: TableColumnType.Text,
+        });
+        const bucketTimeColumn = new AnalyticsTableColumn({
+            key: "bucketTime",
+            title: "Bucket Time",
+            description: "Start of the 1-minute bucket this row aggregates. Computed by the MV as toStartOfMinute(time).",
+            required: true,
+            type: TableColumnType.Date,
+        });
+        const valueSumStateColumn = new AnalyticsTableColumn({
+            key: "valueSumState",
+            title: "Sum (state)",
+            description: "AggregateFunction(sum, Float64) state for valueSum. Read via sumMerge(valueSumState).",
+            required: true,
+            type: TableColumnType.AggregateFunction,
+            aggregateFunctionDefinition: "sum, Float64",
+        });
+        const valueCountStateColumn = new AnalyticsTableColumn({
+            key: "valueCountState",
+            title: "Count (state)",
+            description: "AggregateFunction(count, Float64) state for valueCount. Read via countMerge(valueCountState).",
+            required: true,
+            type: TableColumnType.AggregateFunction,
+            aggregateFunctionDefinition: "count, Float64",
+        });
+        const valueMinStateColumn = new AnalyticsTableColumn({
+            key: "valueMinState",
+            title: "Min (state)",
+            description: "AggregateFunction(min, Float64) state. Read via minMerge(valueMinState).",
+            required: true,
+            type: TableColumnType.AggregateFunction,
+            aggregateFunctionDefinition: "min, Float64",
+        });
+        const valueMaxStateColumn = new AnalyticsTableColumn({
+            key: "valueMaxState",
+            title: "Max (state)",
+            description: "AggregateFunction(max, Float64) state. Read via maxMerge(valueMaxState).",
+            required: true,
+            type: TableColumnType.AggregateFunction,
+            aggregateFunctionDefinition: "max, Float64",
+        });
+        const retentionDateColumn = new AnalyticsTableColumn({
+            key: "retentionDate",
+            title: "Retention Date",
+            description: "Date after which this row is eligible for TTL deletion. Computed by the MV as max(retentionDate) per bucket — inherits from the source MetricItemV3 rows.",
+            required: true,
+            type: TableColumnType.Date,
+        });
+        super({
+            tableName: AnalyticsTableName.MetricItemAggMV1mByK8sCluster,
+            tableEngine: AnalyticsTableEngine.AggregatingMergeTree,
+            singularName: "Metric 1-Minute Aggregate (By Kubernetes Cluster Entity Key)",
+            pluralName: "Metric 1-Minute Aggregates (By Kubernetes Cluster Entity Key)",
+            tableColumns: [
+                projectIdColumn,
+                nameColumn,
+                k8sClusterEntityKeyColumn,
+                bucketTimeColumn,
+                valueSumStateColumn,
+                valueCountStateColumn,
+                valueMinStateColumn,
+                valueMaxStateColumn,
+                retentionDateColumn,
+            ],
+            projections: [],
+            /*
+             * Per-cluster materialized view, reading the ingest-stamped
+             * `k8sClusterEntityKey` scalar column (contract C3) rather than the
+             * raw attributes map. Canonical definition; created idempotently by
+             * the analytics schema-sync on boot
+             * (MetricItemAggMV1mByK8sClusterService is registered in
+             * AnalyticsServices, so a wiped ClickHouse volume self-heals) and
+             * backfilled by the AddMetricEntityMinuteAggregateMaterializedViews
+             * migration. Rows without a cluster entity are filtered out so the
+             * per-cluster MV stays small.
+             */
+            materializedViews: [
+                {
+                    name: "MetricItemAggMV1mByK8sCluster_mv",
+                    query: `CREATE MATERIALIZED VIEW IF NOT EXISTS MetricItemAggMV1mByK8sCluster_mv
+TO MetricItemAggMV1mByK8sCluster
+AS
+SELECT
+  projectId,
+  name,
+  k8sClusterEntityKey,
+  toStartOfMinute(time) AS bucketTime,
+  sumState(toFloat64(coalesce(value, sum, 0))) AS valueSumState,
+  countState(toFloat64(coalesce(value, sum, 0))) AS valueCountState,
+  minState(toFloat64(coalesce(value, sum, 0))) AS valueMinState,
+  maxState(toFloat64(coalesce(value, sum, 0))) AS valueMaxState,
+  max(retentionDate) AS retentionDate
+FROM MetricItemV3
+WHERE k8sClusterEntityKey != ''
+GROUP BY projectId, name, k8sClusterEntityKey, bucketTime`,
+                },
+            ],
+            sortKeys: ["projectId", "name", "k8sClusterEntityKey", "bucketTime"],
+            primaryKeys: ["projectId", "name", "k8sClusterEntityKey", "bucketTime"],
+            partitionKey: "toYYYYMM(bucketTime)",
+            // Align with this MV's GROUP BY (projectId, name, k8sClusterEntityKey).
+            shardingKey: "cityHash64(projectId, name, k8sClusterEntityKey)",
+            tableSettings: "ttl_only_drop_parts = 1, non_replicated_deduplication_window = 10000",
+            ttlExpression: "retentionDate DELETE",
+        });
+    }
+}
+//# sourceMappingURL=MetricItemAggMV1mByK8sCluster.js.map

package/build/dist/Models/AnalyticsModels/MetricItemAggMV1mByK8sCluster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetricItemAggMV1mByK8sCluster.js","sourceRoot":"","sources":["../../../../Models/AnalyticsModels/MetricItemAggMV1mByK8sCluster.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,yCAAyC,CAAC;AACzE,OAAO,oBAAoB,MAAM,oDAAoD,CAAC;AACtF,OAAO,kBAAkB,MAAM,kDAAkD,CAAC;AAClF,OAAO,oBAAoB,MAAM,2CAA2C,CAAC;AAC7E,OAAO,eAAe,MAAM,+CAA+C,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,OAAO,OAAO,6BAA8B,SAAQ,kBAAkB;IAC3E;QACE,MAAM,eAAe,GAAyB,IAAI,oBAAoB,CAAC;YACrE,GAAG,EAAE,WAAW;YAChB,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,0DAA0D;YACvE,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,MAAM,UAAU,GAAyB,IAAI,oBAAoB,CAAC;YAChE,GAAG,EAAE,MAAM;YACX,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,4CAA4C;YACzD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEH,MAAM,yBAAyB,GAC7B,IAAI,oBAAoB,CAAC;YACvB,GAAG,EAAE,qBAAqB;YAC1B,KAAK,EAAE,+BAA+B;YACtC,WAAW,EACT,8PAA8P;YAChQ,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEL,MAAM,gBAAgB,GAAyB,IAAI,oBAAoB,CAAC;YACtE,GAAG,EAAE,YAAY;YACjB,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,gGAAgG;YAClG,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAyB,IAAI,oBAAoB,CAAC;YACzE,GAAG,EAAE,eAAe;YACpB,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,uFAAuF;YACzF,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,iBAAiB;YACvC,2BAA2B,EAAE,cAAc;SAC5C,CAAC,CAAC;QAEH,MAAM,qBAAqB,GACzB,IAAI,oBAAoB,CAAC;YACvB,GAAG,EAAE,iBAAiB;YACtB,KAAK,EAAE,eAAe;YACtB,WAAW,EACT,+FAA+F;YACjG,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,iBAAiB;YACvC,2BAA2B,EAAE,gBAAgB;SAC9C,CAAC,CAAC;QAEL,MAAM,mBAAmB,GAAyB,IAAI,oBAAoB,CAAC;YACzE,GAAG,EAAE,eAAe;YACpB,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,0EAA0E;YAC5E,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,iBAAiB;YACvC,2BAA2B,EAAE,cAAc;SAC5C,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAyB,IAAI,oBAAoB,CAAC;YACzE,GAAG,EAAE,eAAe;YACpB,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,0EAA0E;YAC5E,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,iBAAiB;YACvC,2BAA2B,EAAE,cAAc;SAC5C,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAyB,IAAI,oBAAoB,CAAC;YACzE,GAAG,EAAE,eAAe;YACpB,KAAK,EAAE,gBAAgB;YACvB,WAAW,EACT,2JAA2J;YAC7J,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEH,KAAK,CAAC;YACJ,SAAS,EAAE,kBAAkB,CAAC,6BAA6B;YAC3D,WAAW,EAAE,oBAAoB,CAAC,oBAAoB;YACtD,YAAY,EACV,8DAA8D;YAChE,UAAU,EACR,+DAA+D;YACjE,YAAY,EAAE;gBACZ,eAAe;gBACf,UAAU;gBACV,yBAAyB;gBACzB,gBAAgB;gBAChB,mBAAmB;gBACnB,qBAAqB;gBACrB,mBAAmB;gBACnB,mBAAmB;gBACnB,mBAAmB;aACpB;YACD,WAAW,EAAE,EAAE;YACf;;;;;;;;;;eAUG;YACH,iBAAiB,EAAE;gBACjB;oBACE,IAAI,EAAE,kCAAkC;oBACxC,KAAK,EAAE;;;;;;;;;;;;;;;0DAeyC;iBACjD;aACF;YACD,QAAQ,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,qBAAqB,EAAE,YAAY,CAAC;YACpE,WAAW,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,qBAAqB,EAAE,YAAY,CAAC;YACvE,YAAY,EAAE,sBAAsB;YACpC,wEAAwE;YACxE,WAAW,EAAE,kDAAkD;YAC/D,aAAa,EACX,sEAAsE;YACxE,aAAa,EAAE,sBAAsB;SACtC,CAAC,CAAC;IACL,CAAC;CACF"}

package/build/dist/Models/AnalyticsModels/MetricItemAggMV1mByService.js

@@ -0,0 +1,160 @@
+import AnalyticsBaseModel from "./AnalyticsBaseModel/AnalyticsBaseModel";
+import AnalyticsTableEngine from "../../Types/AnalyticsDatabase/AnalyticsTableEngine";
+import AnalyticsTableName from "../../Types/AnalyticsDatabase/AnalyticsTableName";
+import AnalyticsTableColumn from "../../Types/AnalyticsDatabase/TableColumn";
+import TableColumnType from "../../Types/AnalyticsDatabase/TableColumnType";
+/**
+ * Per-(service, minute) pre-aggregated rollup of `MetricItemV3` value
+ * samples — sibling of `MetricItemAggMV1mByHostV2`, keyed by the stable
+ * 16-hex `serviceEntityKey` the ingest pipeline stamps on every row whose
+ * resource carries a service identity (service.name, plus
+ * service.namespace when present — see the service resolver in
+ * Common/Server/Utils/Telemetry/TelemetryEntity).
+ *
+ * Because the namespace is folded into the key at ingest, ONE
+ * `service.name` can map to SEVERAL serviceEntityKeys (one per
+ * namespace variant). The read side therefore never derives a single
+ * key from the name: `MetricService.tryBuildEntityAggregateMVStatement`
+ * resolves the full key set from the Postgres TelemetryEntity registry
+ * and compiles `serviceEntityKey IN (<keys>)`, falling back to the raw
+ * table when the registry has no rows for the name.
+ *
+ * Populated by `MetricItemAggMV1mByService_mv` (declared below; created
+ * idempotently by boot schema-sync — the service is registered in
+ * AnalyticsServices — and backfilled from `MetricItemV3` by the
+ * AddMetricEntityMinuteAggregateMaterializedViews migration). Rows whose
+ * resource carries no service entity (`serviceEntityKey = ''`) are
+ * filtered out.
+ *
+ * No CRUD API; read-only infrastructure populated entirely by the MV.
+ */
+export default class MetricItemAggMV1mByService extends AnalyticsBaseModel {
+    constructor() {
+        const projectIdColumn = new AnalyticsTableColumn({
+            key: "projectId",
+            title: "Project ID",
+            description: "ID of project (tenant key, replicated from MetricItemV3)",
+            required: true,
+            type: TableColumnType.Text,
+            isTenantId: true,
+        });
+        const nameColumn = new AnalyticsTableColumn({
+            key: "name",
+            title: "Metric Name",
+            description: "Metric name (replicated from MetricItemV3)",
+            required: true,
+            type: TableColumnType.Text,
+        });
+        const serviceEntityKeyColumn = new AnalyticsTableColumn({
+            key: "serviceEntityKey",
+            title: "Service Entity Key",
+            description: "Stable 16-hex service entity key (EntityKey.keyForService — service.name + optional service.namespace) replicated from MetricItemV3.serviceEntityKey at insert time. Rows without one are filtered out by the MV's WHERE clause so this column is always populated for rows that exist.",
+            required: true,
+            type: TableColumnType.Text,
+        });
+        const bucketTimeColumn = new AnalyticsTableColumn({
+            key: "bucketTime",
+            title: "Bucket Time",
+            description: "Start of the 1-minute bucket this row aggregates. Computed by the MV as toStartOfMinute(time).",
+            required: true,
+            type: TableColumnType.Date,
+        });
+        const valueSumStateColumn = new AnalyticsTableColumn({
+            key: "valueSumState",
+            title: "Sum (state)",
+            description: "AggregateFunction(sum, Float64) state for valueSum. Read via sumMerge(valueSumState).",
+            required: true,
+            type: TableColumnType.AggregateFunction,
+            aggregateFunctionDefinition: "sum, Float64",
+        });
+        const valueCountStateColumn = new AnalyticsTableColumn({
+            key: "valueCountState",
+            title: "Count (state)",
+            description: "AggregateFunction(count, Float64) state for valueCount. Read via countMerge(valueCountState).",
+            required: true,
+            type: TableColumnType.AggregateFunction,
+            aggregateFunctionDefinition: "count, Float64",
+        });
+        const valueMinStateColumn = new AnalyticsTableColumn({
+            key: "valueMinState",
+            title: "Min (state)",
+            description: "AggregateFunction(min, Float64) state. Read via minMerge(valueMinState).",
+            required: true,
+            type: TableColumnType.AggregateFunction,
+            aggregateFunctionDefinition: "min, Float64",
+        });
+        const valueMaxStateColumn = new AnalyticsTableColumn({
+            key: "valueMaxState",
+            title: "Max (state)",
+            description: "AggregateFunction(max, Float64) state. Read via maxMerge(valueMaxState).",
+            required: true,
+            type: TableColumnType.AggregateFunction,
+            aggregateFunctionDefinition: "max, Float64",
+        });
+        const retentionDateColumn = new AnalyticsTableColumn({
+            key: "retentionDate",
+            title: "Retention Date",
+            description: "Date after which this row is eligible for TTL deletion. Computed by the MV as max(retentionDate) per bucket — inherits from the source MetricItemV3 rows.",
+            required: true,
+            type: TableColumnType.Date,
+        });
+        super({
+            tableName: AnalyticsTableName.MetricItemAggMV1mByService,
+            tableEngine: AnalyticsTableEngine.AggregatingMergeTree,
+            singularName: "Metric 1-Minute Aggregate (By Service Entity Key)",
+            pluralName: "Metric 1-Minute Aggregates (By Service Entity Key)",
+            tableColumns: [
+                projectIdColumn,
+                nameColumn,
+                serviceEntityKeyColumn,
+                bucketTimeColumn,
+                valueSumStateColumn,
+                valueCountStateColumn,
+                valueMinStateColumn,
+                valueMaxStateColumn,
+                retentionDateColumn,
+            ],
+            projections: [],
+            /*
+             * Per-service materialized view, reading the ingest-stamped
+             * `serviceEntityKey` scalar column (contract C3) rather than the
+             * raw attributes map. Canonical definition; created idempotently by
+             * the analytics schema-sync on boot (MetricItemAggMV1mByServiceService
+             * is registered in AnalyticsServices, so a wiped ClickHouse volume
+             * self-heals) and backfilled by the
+             * AddMetricEntityMinuteAggregateMaterializedViews migration. Rows
+             * without a service entity are filtered out so the per-service MV
+             * stays smaller than the raw table.
+             */
+            materializedViews: [
+                {
+                    name: "MetricItemAggMV1mByService_mv",
+                    query: `CREATE MATERIALIZED VIEW IF NOT EXISTS MetricItemAggMV1mByService_mv
+TO MetricItemAggMV1mByService
+AS
+SELECT
+  projectId,
+  name,
+  serviceEntityKey,
+  toStartOfMinute(time) AS bucketTime,
+  sumState(toFloat64(coalesce(value, sum, 0))) AS valueSumState,
+  countState(toFloat64(coalesce(value, sum, 0))) AS valueCountState,
+  minState(toFloat64(coalesce(value, sum, 0))) AS valueMinState,
+  maxState(toFloat64(coalesce(value, sum, 0))) AS valueMaxState,
+  max(retentionDate) AS retentionDate
+FROM MetricItemV3
+WHERE serviceEntityKey != ''
+GROUP BY projectId, name, serviceEntityKey, bucketTime`,
+                },
+            ],
+            sortKeys: ["projectId", "name", "serviceEntityKey", "bucketTime"],
+            primaryKeys: ["projectId", "name", "serviceEntityKey", "bucketTime"],
+            partitionKey: "toYYYYMM(bucketTime)",
+            // Align with this MV's GROUP BY (projectId, name, serviceEntityKey).
+            shardingKey: "cityHash64(projectId, name, serviceEntityKey)",
+            tableSettings: "ttl_only_drop_parts = 1, non_replicated_deduplication_window = 10000",
+            ttlExpression: "retentionDate DELETE",
+        });
+    }
+}
+//# sourceMappingURL=MetricItemAggMV1mByService.js.map

package/build/dist/Models/AnalyticsModels/MetricItemAggMV1mByService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetricItemAggMV1mByService.js","sourceRoot":"","sources":["../../../../Models/AnalyticsModels/MetricItemAggMV1mByService.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,yCAAyC,CAAC;AACzE,OAAO,oBAAoB,MAAM,oDAAoD,CAAC;AACtF,OAAO,kBAAkB,MAAM,kDAAkD,CAAC;AAClF,OAAO,oBAAoB,MAAM,2CAA2C,CAAC;AAC7E,OAAO,eAAe,MAAM,+CAA+C,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,kBAAkB;IACxE;QACE,MAAM,eAAe,GAAyB,IAAI,oBAAoB,CAAC;YACrE,GAAG,EAAE,WAAW;YAChB,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,0DAA0D;YACvE,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,MAAM,UAAU,GAAyB,IAAI,oBAAoB,CAAC;YAChE,GAAG,EAAE,MAAM;YACX,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,4CAA4C;YACzD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEH,MAAM,sBAAsB,GAC1B,IAAI,oBAAoB,CAAC;YACvB,GAAG,EAAE,kBAAkB;YACvB,KAAK,EAAE,oBAAoB;YAC3B,WAAW,EACT,yRAAyR;YAC3R,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEL,MAAM,gBAAgB,GAAyB,IAAI,oBAAoB,CAAC;YACtE,GAAG,EAAE,YAAY;YACjB,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,gGAAgG;YAClG,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAyB,IAAI,oBAAoB,CAAC;YACzE,GAAG,EAAE,eAAe;YACpB,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,uFAAuF;YACzF,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,iBAAiB;YACvC,2BAA2B,EAAE,cAAc;SAC5C,CAAC,CAAC;QAEH,MAAM,qBAAqB,GACzB,IAAI,oBAAoB,CAAC;YACvB,GAAG,EAAE,iBAAiB;YACtB,KAAK,EAAE,eAAe;YACtB,WAAW,EACT,+FAA+F;YACjG,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,iBAAiB;YACvC,2BAA2B,EAAE,gBAAgB;SAC9C,CAAC,CAAC;QAEL,MAAM,mBAAmB,GAAyB,IAAI,oBAAoB,CAAC;YACzE,GAAG,EAAE,eAAe;YACpB,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,0EAA0E;YAC5E,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,iBAAiB;YACvC,2BAA2B,EAAE,cAAc;SAC5C,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAyB,IAAI,oBAAoB,CAAC;YACzE,GAAG,EAAE,eAAe;YACpB,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,0EAA0E;YAC5E,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,iBAAiB;YACvC,2BAA2B,EAAE,cAAc;SAC5C,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAyB,IAAI,oBAAoB,CAAC;YACzE,GAAG,EAAE,eAAe;YACpB,KAAK,EAAE,gBAAgB;YACvB,WAAW,EACT,2JAA2J;YAC7J,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,eAAe,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEH,KAAK,CAAC;YACJ,SAAS,EAAE,kBAAkB,CAAC,0BAA0B;YACxD,WAAW,EAAE,oBAAoB,CAAC,oBAAoB;YACtD,YAAY,EAAE,mDAAmD;YACjE,UAAU,EAAE,oDAAoD;YAChE,YAAY,EAAE;gBACZ,eAAe;gBACf,UAAU;gBACV,sBAAsB;gBACtB,gBAAgB;gBAChB,mBAAmB;gBACnB,qBAAqB;gBACrB,mBAAmB;gBACnB,mBAAmB;gBACnB,mBAAmB;aACpB;YACD,WAAW,EAAE,EAAE;YACf;;;;;;;;;;eAUG;YACH,iBAAiB,EAAE;gBACjB;oBACE,IAAI,EAAE,+BAA+B;oBACrC,KAAK,EAAE;;;;;;;;;;;;;;;uDAesC;iBAC9C;aACF;YACD,QAAQ,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,YAAY,CAAC;YACjE,WAAW,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,YAAY,CAAC;YACpE,YAAY,EAAE,sBAAsB;YACpC,qEAAqE;YACrE,WAAW,EAAE,+CAA+C;YAC5D,aAAa,EACX,sEAAsE;YACxE,aAAa,EAAE,sBAAsB;SACtC,CAAC,CAAC;IACL,CAAC;CACF"}

package/build/dist/Models/AnalyticsModels/NetworkFlow.js

@@ -0,0 +1,351 @@
+import AnalyticsBaseModel from "./AnalyticsBaseModel/AnalyticsBaseModel";
+import Route from "../../Types/API/Route";
+import AnalyticsTableEngine from "../../Types/AnalyticsDatabase/AnalyticsTableEngine";
+import AnalyticsTableName from "../../Types/AnalyticsDatabase/AnalyticsTableName";
+import AnalyticsTableColumn from "../../Types/AnalyticsDatabase/TableColumn";
+import TableColumnType from "../../Types/AnalyticsDatabase/TableColumnType";
+import Permission from "../../Types/Permission";
+/*
+ * One NetFlow v5 flow record exported by a network device, received by a
+ * probe's NetFlow receiver and correlated to a NetworkDevice on ingest.
+ * Powers top-talker / bandwidth-attribution queries: who talked to whom,
+ * over which protocol/port, and how many bytes/packets, per device.
+ *
+ * Access control mirrors the NetworkDevice database model — flows are an
+ * attribute of the device that exported them.
+ */
+const readPermissions = [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.Viewer,
+    Permission.SettingsAdmin,
+    Permission.SettingsMember,
+    Permission.SettingsViewer,
+    Permission.ReadNetworkDevice,
+];
+const createPermissions = [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.SettingsAdmin,
+    Permission.SettingsMember,
+    Permission.CreateNetworkDevice,
+];
+export default class NetworkFlow extends AnalyticsBaseModel {
+    constructor() {
+        const projectIdColumn = new AnalyticsTableColumn({
+            key: "projectId",
+            title: "Project ID",
+            description: "ID of project",
+            required: true,
+            type: TableColumnType.ObjectID,
+            isTenantId: true,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        /*
+         * Required (not Nullable) even though a flow could in principle lack a
+         * device: the ingest path DROPS flows whose exporter matches no
+         * NetworkDevice (there is no project to attribute them to), so every
+         * stored row has one — and the column sits in the sort key, where
+         * ClickHouse rejects Nullable columns.
+         */
+        const networkDeviceIdColumn = new AnalyticsTableColumn({
+            key: "networkDeviceId",
+            title: "Network Device ID",
+            description: "ID of the NetworkDevice that exported this flow (correlated from the exporter IP on ingest)",
+            required: true,
+            type: TableColumnType.ObjectID,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const exporterIpColumn = new AnalyticsTableColumn({
+            key: "exporterIp",
+            isLowCardinality: true,
+            title: "Exporter IP",
+            description: "Source IP of the NetFlow export datagram — the router/switch that observed the flow",
+            required: true,
+            type: TableColumnType.Text,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const srcIpColumn = new AnalyticsTableColumn({
+            key: "srcIp",
+            codec: { codec: "ZSTD", level: 1 },
+            title: "Source IP",
+            description: "Source IP address of the flow's traffic",
+            required: true,
+            type: TableColumnType.Text,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const dstIpColumn = new AnalyticsTableColumn({
+            key: "dstIp",
+            codec: { codec: "ZSTD", level: 1 },
+            title: "Destination IP",
+            description: "Destination IP address of the flow's traffic",
+            required: true,
+            type: TableColumnType.Text,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const srcPortColumn = new AnalyticsTableColumn({
+            key: "srcPort",
+            title: "Source Port",
+            description: "TCP/UDP source port (0 when not applicable)",
+            required: true,
+            type: TableColumnType.Number,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const dstPortColumn = new AnalyticsTableColumn({
+            key: "dstPort",
+            title: "Destination Port",
+            description: "TCP/UDP destination port (0 when not applicable)",
+            required: true,
+            type: TableColumnType.Number,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const protocolColumn = new AnalyticsTableColumn({
+            key: "protocol",
+            title: "Protocol",
+            description: "IP protocol number (6 = TCP, 17 = UDP, 1 = ICMP, ...)",
+            required: true,
+            type: TableColumnType.Number,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const octetsColumn = new AnalyticsTableColumn({
+            key: "octets",
+            title: "Octets",
+            description: "Total bytes in the flow",
+            required: true,
+            type: TableColumnType.UInt64,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const packetsColumn = new AnalyticsTableColumn({
+            key: "packets",
+            title: "Packets",
+            description: "Total packets in the flow",
+            required: true,
+            type: TableColumnType.UInt64,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const flowStartAtColumn = new AnalyticsTableColumn({
+            key: "flowStartAt",
+            codec: [{ codec: "DoubleDelta" }, { codec: "ZSTD", level: 1 }],
+            title: "Flow Start",
+            description: "Wall-clock time the flow started",
+            required: true,
+            type: TableColumnType.DateTime64,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const flowEndAtColumn = new AnalyticsTableColumn({
+            key: "flowEndAt",
+            codec: [{ codec: "DoubleDelta" }, { codec: "ZSTD", level: 1 }],
+            title: "Flow End",
+            description: "Wall-clock time the flow ended",
+            required: true,
+            type: TableColumnType.DateTime64,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        const ingestedAtColumn = new AnalyticsTableColumn({
+            key: "ingestedAt",
+            codec: [{ codec: "DoubleDelta" }, { codec: "ZSTD", level: 1 }],
+            title: "Ingested At",
+            description: "When the server ingested this flow record",
+            required: true,
+            type: TableColumnType.DateTime64,
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [],
+            },
+        });
+        super({
+            tableName: AnalyticsTableName.NetworkFlow,
+            tableEngine: AnalyticsTableEngine.MergeTree,
+            singularName: "Network Flow",
+            accessControl: {
+                read: readPermissions,
+                create: createPermissions,
+                update: [
+                    Permission.ProjectOwner,
+                    Permission.ProjectAdmin,
+                    Permission.ProjectMember,
+                    Permission.SettingsAdmin,
+                    Permission.SettingsMember,
+                    Permission.EditNetworkDevice,
+                ],
+                delete: [
+                    Permission.ProjectOwner,
+                    Permission.ProjectAdmin,
+                    Permission.ProjectMember,
+                    Permission.SettingsAdmin,
+                    Permission.SettingsMember,
+                    Permission.DeleteNetworkDevice,
+                ],
+            },
+            pluralName: "Network Flows",
+            crudApiPath: new Route("/network-flow"),
+            tableColumns: [
+                projectIdColumn,
+                networkDeviceIdColumn,
+                exporterIpColumn,
+                srcIpColumn,
+                dstIpColumn,
+                srcPortColumn,
+                dstPortColumn,
+                protocolColumn,
+                octetsColumn,
+                packetsColumn,
+                flowStartAtColumn,
+                flowEndAtColumn,
+                ingestedAtColumn,
+            ],
+            projections: [],
+            sortKeys: ["projectId", "networkDeviceId", "flowStartAt"],
+            primaryKeys: ["projectId", "networkDeviceId", "flowStartAt"],
+            partitionKey: "toYYYYMMDD(flowStartAt)",
+            /*
+             * Shard by (projectId, networkDeviceId, flowStartAt) — mirrors how
+             * Log shards on its always-present sort-key columns: the
+             * high-entropy time component spreads even a single very busy
+             * exporter across all shards.
+             */
+            shardingKey: "cityHash64(projectId, networkDeviceId, flowStartAt)",
+            tableSettings: "non_replicated_deduplication_window = 10000",
+            /*
+             * Flows are the highest-volume rows in the product (a single busy
+             * router can export thousands per second), so the table must never
+             * grow unboundedly. Fixed-window TTL for now; per-project retention
+             * (a retentionDate column computed at ingest, like Log/Metric) is
+             * the phase-2 follow-up. Keyed on server-assigned ingestedAt so a
+             * device with a wrong clock cannot make rows expire early.
+             */
+            ttlExpression: "ingestedAt + INTERVAL 30 DAY DELETE",
+            defaultSortColumn: "flowStartAt",
+        });
+    }
+    get projectId() {
+        return this.getColumnValue("projectId");
+    }
+    set projectId(v) {
+        this.setColumnValue("projectId", v);
+    }
+    get networkDeviceId() {
+        return this.getColumnValue("networkDeviceId");
+    }
+    set networkDeviceId(v) {
+        this.setColumnValue("networkDeviceId", v);
+    }
+    get exporterIp() {
+        return this.getColumnValue("exporterIp");
+    }
+    set exporterIp(v) {
+        this.setColumnValue("exporterIp", v);
+    }
+    get srcIp() {
+        return this.getColumnValue("srcIp");
+    }
+    set srcIp(v) {
+        this.setColumnValue("srcIp", v);
+    }
+    get dstIp() {
+        return this.getColumnValue("dstIp");
+    }
+    set dstIp(v) {
+        this.setColumnValue("dstIp", v);
+    }
+    get srcPort() {
+        return this.getColumnValue("srcPort");
+    }
+    set srcPort(v) {
+        this.setColumnValue("srcPort", v);
+    }
+    get dstPort() {
+        return this.getColumnValue("dstPort");
+    }
+    set dstPort(v) {
+        this.setColumnValue("dstPort", v);
+    }
+    get protocol() {
+        return this.getColumnValue("protocol");
+    }
+    set protocol(v) {
+        this.setColumnValue("protocol", v);
+    }
+    get octets() {
+        return this.getColumnValue("octets");
+    }
+    set octets(v) {
+        this.setColumnValue("octets", v);
+    }
+    get packets() {
+        return this.getColumnValue("packets");
+    }
+    set packets(v) {
+        this.setColumnValue("packets", v);
+    }
+    get flowStartAt() {
+        return this.getColumnValue("flowStartAt");
+    }
+    set flowStartAt(v) {
+        this.setColumnValue("flowStartAt", v);
+    }
+    get flowEndAt() {
+        return this.getColumnValue("flowEndAt");
+    }
+    set flowEndAt(v) {
+        this.setColumnValue("flowEndAt", v);
+    }
+    get ingestedAt() {
+        return this.getColumnValue("ingestedAt");
+    }
+    set ingestedAt(v) {
+        this.setColumnValue("ingestedAt", v);
+    }
+}
+//# sourceMappingURL=NetworkFlow.js.map