@marinoscar/platform-api 0.0.0-stage → 0.1.0-next.3

package/dist/telemetry/telemetry-explorer.controller.js

@@ -0,0 +1,193 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTelemetryExplorerController = createTelemetryExplorerController;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const index_1 = require("../core/index");
+const telemetry_query_dto_1 = require("./dto/telemetry-query.dto");
+const telemetry_export_service_1 = require("./export/telemetry-export.service");
+const telemetry_query_service_1 = require("./query/telemetry-query.service");
+const telemetry_schema_service_1 = require("./query/telemetry-schema.service");
+const telemetry_permissions_1 = require("./telemetry.permissions");
+// =============================================================================
+// TelemetryExplorerController (issue #535, epic #528)
+// =============================================================================
+//
+//   POST /api/admin/telemetry/query    telemetry:query
+//   GET  /api/admin/telemetry/schema   telemetry:query
+//   POST /api/admin/telemetry/export   telemetry:query   (binary attachment)
+//
+// All three on `telemetry:query` — the permission that means "may read the
+// telemetry DATA", distinct from `telemetry:read` (may see the store's
+// configuration and status). The schema is on it too: table and column names
+// are derived from the data (every span attribute becomes a column).
+//
+// Failures carry `details.reason` (see query/telemetry-query.errors.ts).
+// =============================================================================
+const ERROR_REASONS_DOC = 'Failures carry `details.reason`: `TELEMETRY_NOT_CONFIGURED` (503, no telemetry store in this ' +
+    'deployment), `TELEMETRY_UNREACHABLE` (503), `TELEMETRY_DISABLED` (409, `telemetry.enabled` ' +
+    'is off)';
+const QUERY_REASONS_DOC = ', `TELEMETRY_QUERY_REJECTED` (400, not exactly one read-only statement), ' +
+    '`TELEMETRY_QUERY_FAILED` (400, the telemetry store refused the statement — the message is its ' +
+    'own) and `TELEMETRY_QUERY_TIMEOUT` (504, the statement outran `telemetry.query.timeoutSeconds`).';
+/**
+ * Creates the `TelemetryExplorerController` class for one set of module options: its routes
+ * guarded by the app's access decorators (`options.host.access`), the caller
+ * resolved by `options.actorId`. `TelemetryModule.forRoot()` calls it.
+ *
+ * @param options - the resolved module options.
+ * @returns the controller class.
+ *
+ * @stability experimental
+ */
+function createTelemetryExplorerController(options) {
+    const access = options.host.access;
+    const ActorId = options.actorIdParam;
+    let TelemetryExplorerController = class TelemetryExplorerController {
+        queries;
+        schema;
+        exports;
+        constructor(queries, schema, exports) {
+            this.queries = queries;
+            this.schema = schema;
+            this.exports = exports;
+        }
+        async query(dto, userId) {
+            return this.queries.run(userId, dto.sql, { maxRows: dto.maxRows, source: 'explorer' });
+        }
+        async getSchema() {
+            return this.schema.getSchema();
+        }
+        async export(dto, userId, reply) {
+            const file = await this.exports.export(userId, dto.sql, dto.format);
+            return reply
+                .status(200)
+                .header('Content-Type', file.contentType)
+                .header('Content-Disposition', `attachment; filename="${file.filename}"`)
+                .header('Content-Length', String(file.buffer.length))
+                .header('Cache-Control', 'no-store')
+                .header('X-Content-Type-Options', 'nosniff')
+                .header('X-Telemetry-Row-Count', String(file.rowCount))
+                .header('X-Telemetry-Truncated', String(file.truncated))
+                .send(file.buffer);
+        }
+    };
+    __decorate([
+        (0, common_1.Post)('query'),
+        (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+        (access.requirePermissions([telemetry_permissions_1.TELEMETRY_PERMISSIONS.QUERY])),
+        (0, swagger_1.ApiOperation)({
+            summary: 'Run a read-only SQL query against the telemetry store (Admin only)',
+            description: 'Runs ONE read-only statement (SELECT, WITH, SHOW, DESCRIBE, EXPLAIN) as the telemetry ' +
+                'store\'s read-only user. At most `maxRows` rows are returned (default and ceiling: the ' +
+                '`telemetry.query.maxRows` setting); `truncated` says whether more matched. Rows are ' +
+                'positional arrays matching `columns`; `int8`/`numeric` values are strings so no precision ' +
+                'is lost, and timestamps are the store\'s own text. That text carries microseconds (the ' +
+                'PostgreSQL protocol\'s precision); select `CAST(ts AS STRING) AS ts_ns` for nanoseconds. Every call, ' +
+                'refused ones included, is written to the audit log as `telemetry:query`.\n\n' +
+                ERROR_REASONS_DOC +
+                QUERY_REASONS_DOC,
+        }),
+        (0, swagger_1.ApiResponse)({ status: 200, description: 'The query result', type: telemetry_query_dto_1.TelemetryQueryResultDto }),
+        (0, swagger_1.ApiResponse)({ status: 400, description: 'Validation error, refused or failed statement', type: index_1.ErrorDto }),
+        (0, swagger_1.ApiResponse)({ status: 409, description: 'Telemetry is disabled', type: index_1.ErrorDto }),
+        (0, swagger_1.ApiResponse)({ status: 503, description: 'No telemetry store, or it did not answer', type: index_1.ErrorDto }),
+        (0, swagger_1.ApiResponse)({ status: 504, description: 'The statement timed out', type: index_1.ErrorDto }),
+        __param(0, (0, common_1.Body)()),
+        __param(1, ActorId()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [telemetry_query_dto_1.TelemetryQueryRequestDto, String]),
+        __metadata("design:returntype", Promise)
+    ], TelemetryExplorerController.prototype, "query", null);
+    __decorate([
+        (0, common_1.Get)('schema'),
+        (access.requirePermissions([telemetry_permissions_1.TELEMETRY_PERMISSIONS.QUERY])),
+        (0, swagger_1.ApiOperation)({
+            summary: 'List the telemetry tables and their columns (Admin only)',
+            description: 'Every table of the telemetry database with its row estimate and columns (name, SQL type, ' +
+                'and GreptimeDB\'s semantic type: `TAG`, `FIELD` or `TIMESTAMP`), sorted by table name and ' +
+                'column position. Cached for up to 30 seconds: tables appear on first write and attribute ' +
+                'columns as new attributes arrive.\n\n' +
+                ERROR_REASONS_DOC +
+                ' and `TELEMETRY_QUERY_TIMEOUT` (504).',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 200, description: 'The telemetry schema', type: telemetry_query_dto_1.TelemetrySchemaDto }),
+        (0, swagger_1.ApiResponse)({ status: 409, description: 'Telemetry is disabled', type: index_1.ErrorDto }),
+        (0, swagger_1.ApiResponse)({ status: 503, description: 'No telemetry store, or it did not answer', type: index_1.ErrorDto }),
+        (0, swagger_1.ApiResponse)({ status: 504, description: 'The schema read timed out', type: index_1.ErrorDto }),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", []),
+        __metadata("design:returntype", Promise)
+    ], TelemetryExplorerController.prototype, "getSchema", null);
+    __decorate([
+        (0, common_1.Post)('export'),
+        (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+        (access.requirePermissions([telemetry_permissions_1.TELEMETRY_PERMISSIONS.QUERY])),
+        (0, swagger_1.ApiOperation)({
+            summary: 'Export a telemetry query result as a file (Admin only)',
+            description: 'Runs the statement exactly as `POST /api/admin/telemetry/query` does (same guard, same ' +
+                'timeout, row cap = `telemetry.query.maxRows`) and returns the result as an attachment: ' +
+                '`csv` (RFC 4180, UTF-8 with BOM; text cells that a spreadsheet would read as a formula ' +
+                'are prefixed with `\'`), `ndjson` (one object per row; a repeated column name gets `_2`, ' +
+                '`_3`), `xlsx` (one sheet, `results`) or `parquet`. `X-Telemetry-Row-Count` and ' +
+                '`X-Telemetry-Truncated` report the row count and whether the cap cut the result short. ' +
+                'Audited as `telemetry:export`.\n\n' +
+                ERROR_REASONS_DOC +
+                QUERY_REASONS_DOC,
+        }),
+        (0, swagger_1.ApiProduces)(...Object.values(telemetry_export_service_1.TELEMETRY_EXPORT_CONTENT_TYPES).map((type) => type.split(';')[0])),
+        (0, swagger_1.ApiResponse)({
+            status: 200,
+            description: 'The exported file',
+            headers: {
+                'Content-Disposition': {
+                    description: '`attachment; filename="telemetry-<yyyyMMdd-HHmmss>.<format>"`',
+                    schema: { type: 'string' },
+                },
+                'X-Telemetry-Row-Count': { description: 'Rows in the file.', schema: { type: 'integer' } },
+                'X-Telemetry-Truncated': {
+                    description: '`true` when more rows matched than the row cap allowed.',
+                    schema: { type: 'string', enum: ['true', 'false'] },
+                },
+            },
+            content: Object.fromEntries(Object.values(telemetry_export_service_1.TELEMETRY_EXPORT_CONTENT_TYPES).map((type) => [
+                type.split(';')[0],
+                { schema: { type: 'string', format: 'binary' } },
+            ])),
+        }),
+        (0, swagger_1.ApiResponse)({ status: 400, description: 'Validation error, refused or failed statement', type: index_1.ErrorDto }),
+        (0, swagger_1.ApiResponse)({ status: 409, description: 'Telemetry is disabled', type: index_1.ErrorDto }),
+        (0, swagger_1.ApiResponse)({ status: 503, description: 'No telemetry store, or it did not answer', type: index_1.ErrorDto }),
+        (0, swagger_1.ApiResponse)({ status: 504, description: 'The statement timed out', type: index_1.ErrorDto }),
+        __param(0, (0, common_1.Body)()),
+        __param(1, ActorId()),
+        __param(2, (0, common_1.Res)()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [telemetry_query_dto_1.TelemetryExportRequestDto, String, Object]),
+        __metadata("design:returntype", Promise)
+    ], TelemetryExplorerController.prototype, "export", null);
+    TelemetryExplorerController = __decorate([
+        (0, swagger_1.ApiTags)('Telemetry'),
+        (0, common_1.Controller)('admin/telemetry'),
+        __param(0, (0, common_1.Inject)(telemetry_query_service_1.TelemetryQueryService)),
+        __param(1, (0, common_1.Inject)(telemetry_schema_service_1.TelemetrySchemaService)),
+        __param(2, (0, common_1.Inject)(telemetry_export_service_1.TelemetryExportService)),
+        __metadata("design:paramtypes", [telemetry_query_service_1.TelemetryQueryService,
+            telemetry_schema_service_1.TelemetrySchemaService,
+            telemetry_export_service_1.TelemetryExportService])
+    ], TelemetryExplorerController);
+    return TelemetryExplorerController;
+}
+//# sourceMappingURL=telemetry-explorer.controller.js.map

package/dist/telemetry/telemetry-explorer.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry-explorer.controller.js","sourceRoot":"","sources":["../../src/telemetry/telemetry-explorer.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAqDA,8EAyHC;AA9KD,2CAAsG;AACtG,6CAAkF;AAGlF,yCAAyC;AACzC,mEAKmC;AACnC,gFAA2G;AAC3G,6EAAwE;AACxE,+EAA0E;AAE1E,mEAAgE;AAEhE,gFAAgF;AAChF,sDAAsD;AACtD,gFAAgF;AAChF,EAAE;AACF,uDAAuD;AACvD,uDAAuD;AACvD,6EAA6E;AAC7E,EAAE;AACF,2EAA2E;AAC3E,uEAAuE;AACvE,6EAA6E;AAC7E,qEAAqE;AACrE,EAAE;AACF,yEAAyE;AACzE,gFAAgF;AAEhF,MAAM,iBAAiB,GACrB,+FAA+F;IAC/F,6FAA6F;IAC7F,SAAS,CAAC;AAEZ,MAAM,iBAAiB,GACrB,2EAA2E;IAC3E,gGAAgG;IAChG,kGAAkG,CAAC;AAErG;;;;;;;;;GASG;AACH,SAAgB,iCAAiC,CAAC,OAAuC;IACvF,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;IACnC,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC;IAErC,IAEM,2BAA2B,GAFjC,MAEM,2BAA2B;QAEmB;QACC;QACA;QAHnD,YACkD,OAA8B,EAC7B,MAA8B,EAC9B,OAA+B;YAFhC,YAAO,GAAP,OAAO,CAAuB;YAC7B,WAAM,GAAN,MAAM,CAAwB;YAC9B,YAAO,GAAP,OAAO,CAAwB;QAC/E,CAAC;QAuBE,AAAN,KAAK,CAAC,KAAK,CAAS,GAA6B,EAAa,MAAc;YAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;QACzF,CAAC;QAkBK,AAAN,KAAK,CAAC,SAAS;YACb,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACjC,CAAC;QA4CK,AAAN,KAAK,CAAC,MAAM,CACF,GAA8B,EAC3B,MAAc,EAClB,KAAmB;YAE1B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YAEpE,OAAO,KAAK;iBACT,MAAM,CAAC,GAAG,CAAC;iBACX,MAAM,CAAC,cAAc,EAAE,IAAI,CAAC,WAAW,CAAC;iBACxC,MAAM,CAAC,qBAAqB,EAAE,yBAAyB,IAAI,CAAC,QAAQ,GAAG,CAAC;iBACxE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;iBACpD,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC;iBACnC,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;iBAC3C,MAAM,CAAC,uBAAuB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;iBACtD,MAAM,CAAC,uBAAuB,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;iBACvD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC;KACF,CAAA;IApFO;QArBL,IAAA,aAAI,EAAC,OAAO,CAAC;QACb,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;QACvB,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,6CAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1D,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,oEAAoE;YAC7E,WAAW,EACT,wFAAwF;gBACxF,yFAAyF;gBACzF,sFAAsF;gBACtF,4FAA4F;gBAC5F,yFAAyF;gBACzF,uGAAuG;gBACvG,8EAA8E;gBAC9E,iBAAiB;gBACjB,iBAAiB;SACpB,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE,IAAI,EAAE,6CAAuB,EAAE,CAAC;QAC5F,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,+CAA+C,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QAC1G,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,uBAAuB,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QAClF,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,0CAA0C,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QACrG,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,yBAAyB,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QACxE,WAAA,IAAA,aAAI,GAAE,CAAA;QAAiC,WAAA,OAAO,EAAE,CAAA;;yCAApC,8CAAwB;;4DAEhD;IAkBK;QAhBL,IAAA,YAAG,EAAC,QAAQ,CAAC;QACb,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,6CAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1D,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,0DAA0D;YACnE,WAAW,EACT,2FAA2F;gBAC3F,4FAA4F;gBAC5F,2FAA2F;gBAC3F,uCAAuC;gBACvC,iBAAiB;gBACjB,uCAAuC;SAC1C,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,sBAAsB,EAAE,IAAI,EAAE,wCAAkB,EAAE,CAAC;QAC3F,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,uBAAuB,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QAClF,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,0CAA0C,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QACrG,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,2BAA2B,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;;;;gEAGtF;IA4CK;QA1CL,IAAA,aAAI,EAAC,QAAQ,CAAC;QACd,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;QACvB,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,6CAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1D,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,wDAAwD;YACjE,WAAW,EACT,yFAAyF;gBACzF,yFAAyF;gBACzF,yFAAyF;gBACzF,2FAA2F;gBAC3F,iFAAiF;gBACjF,yFAAyF;gBACzF,oCAAoC;gBACpC,iBAAiB;gBACjB,iBAAiB;SACpB,CAAC;QACD,IAAA,qBAAW,EAAC,GAAG,MAAM,CAAC,MAAM,CAAC,yDAA8B,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/F,IAAA,qBAAW,EAAC;YACX,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,mBAAmB;YAChC,OAAO,EAAE;gBACP,qBAAqB,EAAE;oBACrB,WAAW,EAAE,+DAA+D;oBAC5E,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC3B;gBACD,uBAAuB,EAAE,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;gBAC1F,uBAAuB,EAAE;oBACvB,WAAW,EAAE,yDAAyD;oBACtE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;iBACpD;aACF;YACD,OAAO,EAAE,MAAM,CAAC,WAAW,CACzB,MAAM,CAAC,MAAM,CAAC,yDAA8B,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC1D,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBAClB,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE;aACjD,CAAC,CACH;SACF,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,+CAA+C,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QAC1G,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,uBAAuB,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QAClF,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,0CAA0C,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QACrG,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,yBAAyB,EAAE,IAAI,EAAE,gBAAQ,EAAE,CAAC;QAElF,WAAA,IAAA,aAAI,GAAE,CAAA;QACN,WAAA,OAAO,EAAE,CAAA;QACT,WAAA,IAAA,YAAG,GAAE,CAAA;;yCAFO,+CAAyB;;6DAgBvC;IA/GG,2BAA2B;QAFhC,IAAA,iBAAO,EAAC,WAAW,CAAC;QACpB,IAAA,mBAAU,EAAC,iBAAiB,CAAC;QAGzB,WAAA,IAAA,eAAM,EAAC,+CAAqB,CAAC,CAAA;QAC7B,WAAA,IAAA,eAAM,EAAC,iDAAsB,CAAC,CAAA;QAC9B,WAAA,IAAA,eAAM,EAAC,iDAAsB,CAAC,CAAA;yCAF0B,+CAAqB;YACrB,iDAAsB;YACrB,iDAAsB;OAJ9E,2BAA2B,CAgHhC;IAED,OAAO,2BAA2B,CAAC;AACrC,CAAC"}

package/dist/telemetry/telemetry-settings.service.d.ts

@@ -0,0 +1,85 @@
+import { OnModuleDestroy, OnModuleInit } from '@nestjs/common';
+import type { TelemetrySettings as SystemTelemetryValue } from '@marinoscar/platform-contract/telemetry';
+import type { TelemetryConfigResponse, TelemetryPublicConfig, UpdateTelemetryConfigInput } from './dto/telemetry-config.dto';
+import { GreptimeClient } from './greptime/greptime.client';
+import { type TelemetryAppInfo, type TelemetryAuditSink, type TelemetryJobsPort, type TelemetrySettingsStore } from './ports';
+/** How long a `getPolicy()` answer may be reused. */
+export declare const TELEMETRY_POLICY_CACHE_MS = 5000;
+/** How often every instance re-reads the policy and re-applies the gate. */
+export declare const TELEMETRY_GATE_REFRESH_MS = 5000;
+/** Audit `action` for a successful admin save. */
+export declare const TELEMETRY_CONFIG_AUDIT_ACTION = "telemetry:config_update";
+/**
+ * The `telemetry` namespace (one cached read, the admin replace) and the
+ * runtime export gate it drives. Exported by `TelemetryModule`.
+ *
+ * @stability experimental
+ */
+export declare class TelemetrySettingsService implements OnModuleInit, OnModuleDestroy {
+    private readonly audit;
+    private readonly systemSettings;
+    private readonly greptime;
+    private readonly jobs;
+    private readonly appInfo;
+    private readonly logger;
+    private cache;
+    private refreshTimer;
+    /** Whether the previous background refresh failed — so a long outage logs once, not every 5s. */
+    private refreshFailing;
+    constructor(audit: TelemetryAuditSink, systemSettings: TelemetrySettingsStore, greptime: GreptimeClient, jobs: TelemetryJobsPort, appInfo: TelemetryAppInfo);
+    /**
+     * Applies the gate once, then keeps it fresh. Detached and swallowed: boot
+     * must never wait on, or fail because of, a settings read.
+     */
+    onModuleInit(): void;
+    /** Stops the gate refresh. */
+    onModuleDestroy(): void;
+    /**
+     * The current `telemetry` policy. `fresh: true` bypasses the cache — for a
+     * caller SHOWING the configuration, never for a hot path.
+     */
+    getPolicy(opts?: {
+        fresh?: boolean;
+    }): Promise<SystemTelemetryValue>;
+    /** Drop the cached policy so the next read consults the row. */
+    invalidateCache(): void;
+    /**
+     * Re-reads the policy and sets the export gate to
+     * `telemetry.enabled && GreptimeDB configured`, and the gate's instance id
+     * to `telemetry.instanceId ??` the app's slug. Never throws: on a failed read the
+     * gate keeps its last values (see the header).
+     *
+     * @returns the gate's state after the call.
+     */
+    refreshGate(): Promise<boolean>;
+    /** `GET /api/admin/telemetry/config`. Read fresh, and never creates the settings row. */
+    describeForAdmin(): Promise<TelemetryConfigResponse>;
+    /** `GET /api/telemetry/config` — the web feature flag. Cached; no provenance, no bounds. */
+    describePublic(): Promise<TelemetryPublicConfig>;
+    /**
+     * `PUT /api/admin/telemetry/config` — full replace of the namespace.
+     *
+     * Order, each step load-bearing:
+     *   1. `If-Match` refused BEFORE anything is written (409);
+     *   2. the settings write, passing `expectedVersion` again so the write
+     *      re-checks it (that also writes the generic `system_settings:patch`
+     *      audit row);
+     *   3. the cache dropped SYNCHRONOUSLY, before anything else awaits;
+     *   4. the `telemetry:config_update` audit row — changed field NAMES only;
+     *   5. the gate re-applied on this instance (others follow within
+     *      `TELEMETRY_GATE_REFRESH_MS`);
+     *   6. a `telemetry.retention.apply` job enqueued, so a changed retention
+     *      reaches GreptimeDB now rather than at the next 4am run. Never fails
+     *      the save: the helper swallows its own errors, and the nightly cron
+     *      re-asserts the TTL regardless.
+     */
+    replace(input: UpdateTelemetryConfigInput, userId: string, expectedVersion?: number): Promise<TelemetryConfigResponse>;
+    /** The `global` settings row's provenance, WITHOUT creating it. */
+    private readRow;
+}
+/**
+ * The dotted NAMES of the fields that differ between two policies — never the
+ * values (the audit row's contract, the same as `ai_config:replace`).
+ */
+export declare function diffTelemetryFieldNames(before: SystemTelemetryValue, after: SystemTelemetryValue): string[];
+//# sourceMappingURL=telemetry-settings.service.d.ts.map

package/dist/telemetry/telemetry-settings.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry-settings.service.d.ts","sourceRoot":"","sources":["../../src/telemetry/telemetry-settings.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,eAAe,EACf,YAAY,EACb,MAAM,gBAAgB,CAAC;AAGxB,OAAO,KAAK,EAAE,iBAAiB,IAAI,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAEzG,OAAO,KAAK,EACV,uBAAuB,EACvB,qBAAqB,EACrB,0BAA0B,EAC3B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAE5D,OAAO,EAKL,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EAEtB,KAAK,sBAAsB,EAC5B,MAAM,SAAS,CAAC;AA0CjB,qDAAqD;AACrD,eAAO,MAAM,yBAAyB,OAAQ,CAAC;AAE/C,4EAA4E;AAC5E,eAAO,MAAM,yBAAyB,OAAQ,CAAC;AAE/C,kDAAkD;AAClD,eAAO,MAAM,6BAA6B,4BAA4B,CAAC;AAEvE;;;;;GAKG;AACH,qBACa,wBAAyB,YAAW,YAAY,EAAE,eAAe;IAS5C,OAAO,CAAC,QAAQ,CAAC,KAAK;IAClB,OAAO,CAAC,QAAQ,CAAC,cAAc;IACjE,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACD,OAAO,CAAC,QAAQ,CAAC,IAAI;IACjB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAZtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6C;IAEpE,OAAO,CAAC,KAAK,CAAgE;IAC7E,OAAO,CAAC,YAAY,CAA+B;IACnD,iGAAiG;IACjG,OAAO,CAAC,cAAc,CAAS;gBAGkB,KAAK,EAAE,kBAAkB,EACrB,cAAc,EAAE,sBAAsB,EACxE,QAAQ,EAAE,cAAc,EACA,IAAI,EAAE,iBAAiB,EACnB,OAAO,EAAE,gBAAgB;IAGxE;;;OAGG;IACH,YAAY,IAAI,IAAI;IAUpB,8BAA8B;IAC9B,eAAe,IAAI,IAAI;IAOvB;;;OAGG;IACG,SAAS,CAAC,IAAI,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAa9E,gEAAgE;IAChE,eAAe,IAAI,IAAI;IAIvB;;;;;;;OAOG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAqCrC,yFAAyF;IACnF,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAe1D,4FAA4F;IACtF,cAAc,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAUtD;;;;;;;;;;;;;;;;OAgBG;IACG,OAAO,CACX,KAAK,EAAE,0BAA0B,EACjC,MAAM,EAAE,MAAM,EACd,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,uBAAuB,CAAC;IAmDnC,mEAAmE;IACnE,OAAO,CAAC,OAAO;CAGhB;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,oBAAoB,EAAE,KAAK,EAAE,oBAAoB,GAAG,MAAM,EAAE,CAmB3G"}

package/dist/telemetry/telemetry-settings.service.js

@@ -0,0 +1,278 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var TelemetrySettingsService_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelemetrySettingsService = exports.TELEMETRY_CONFIG_AUDIT_ACTION = exports.TELEMETRY_GATE_REFRESH_MS = exports.TELEMETRY_POLICY_CACHE_MS = void 0;
+exports.diffTelemetryFieldNames = diffTelemetryFieldNames;
+const common_1 = require("@nestjs/common");
+const index_1 = require("../otel-core/index");
+const greptime_client_1 = require("./greptime/greptime.client");
+const telemetry_retention_handler_1 = require("./handlers/telemetry-retention.handler");
+const ports_1 = require("./ports");
+// =============================================================================
+// TelemetrySettingsService — the `telemetry` namespace, and the runtime gate
+// (issue #534, epic #528)
+// =============================================================================
+//
+// Three jobs, one owner:
+//
+//   1. THE ONE CACHED READ of `telemetry.*` (`getPolicy`, 5s TTL — the same
+//      bound `AiConfigService` uses). The explorer (#535) and the assistant
+//      (#536) read their bounds (`query.maxRows`, `query.timeoutSeconds`,
+//      `assistant.*`) through this, not through `SystemSettingsService`.
+//
+//   2. THE ADMIN WRITE (`replace`), modelled on `AiConfigAdminService.replace`:
+//      If-Match checked before anything is written, `patchSettings` (which
+//      re-checks it), cache dropped synchronously, audit row with changed
+//      field NAMES, then the two side effects — the gate, and the retention
+//      job.
+//
+//   3. THE EXPORT GATE. `telemetryGate` (common/otel/telemetry-gate.ts) starts
+//      CLOSED; this service opens it when `telemetry.enabled` is true AND a
+//      telemetry store is configured (the connection saved at
+//      /admin/settings/telemetry, else the `GREPTIME_*` deployment default —
+//      `TelemetryConnectionService`, #558), on boot and every
+//      `TELEMETRY_GATE_REFRESH_MS` after. The interval is what makes a
+//      multi-instance deployment converge: the instance that served the PUT
+//      flips its gate immediately, every other one within one interval.
+//      The same refresh pushes the resolved instance identifier
+//      (`telemetry.instanceId`, else the app's slug — #565) with
+//      `telemetryGate.setInstanceId()`, so a relabel converges the same way.
+//
+// WHY BOTH CONDITIONS FOR THE GATE: with no GreptimeDB there is nowhere for
+// the collector to write. Exporting anyway would only fill the collector's
+// retry queue and its logs.
+//
+// A FAILED SETTINGS READ LEAVES THE GATE AS IT IS. Flipping it closed on a
+// database blip would drop telemetry exactly when an operator most needs it;
+// flipping it open would ignore an administrator's "off". The last known
+// answer stands until a read succeeds.
+// =============================================================================
+/** How long a `getPolicy()` answer may be reused. */
+exports.TELEMETRY_POLICY_CACHE_MS = 5_000;
+/** How often every instance re-reads the policy and re-applies the gate. */
+exports.TELEMETRY_GATE_REFRESH_MS = 5_000;
+/** Audit `action` for a successful admin save. */
+exports.TELEMETRY_CONFIG_AUDIT_ACTION = 'telemetry:config_update';
+/**
+ * The `telemetry` namespace (one cached read, the admin replace) and the
+ * runtime export gate it drives. Exported by `TelemetryModule`.
+ *
+ * @stability experimental
+ */
+let TelemetrySettingsService = TelemetrySettingsService_1 = class TelemetrySettingsService {
+    audit;
+    systemSettings;
+    greptime;
+    jobs;
+    appInfo;
+    logger = new common_1.Logger(TelemetrySettingsService_1.name);
+    cache = null;
+    refreshTimer = null;
+    /** Whether the previous background refresh failed — so a long outage logs once, not every 5s. */
+    refreshFailing = false;
+    constructor(audit, systemSettings, greptime, jobs, appInfo) {
+        this.audit = audit;
+        this.systemSettings = systemSettings;
+        this.greptime = greptime;
+        this.jobs = jobs;
+        this.appInfo = appInfo;
+    }
+    /**
+     * Applies the gate once, then keeps it fresh. Detached and swallowed: boot
+     * must never wait on, or fail because of, a settings read.
+     */
+    onModuleInit() {
+        void this.refreshGate();
+        this.refreshTimer = setInterval(() => {
+            void this.refreshGate();
+        }, exports.TELEMETRY_GATE_REFRESH_MS);
+        // Never the reason a process (or a test run) stays alive.
+        this.refreshTimer.unref?.();
+    }
+    /** Stops the gate refresh. */
+    onModuleDestroy() {
+        if (this.refreshTimer) {
+            clearInterval(this.refreshTimer);
+            this.refreshTimer = null;
+        }
+    }
+    /**
+     * The current `telemetry` policy. `fresh: true` bypasses the cache — for a
+     * caller SHOWING the configuration, never for a hot path.
+     */
+    async getPolicy(opts = {}) {
+        const now = Date.now();
+        if (!opts.fresh && this.cache && now - this.cache.readAt < exports.TELEMETRY_POLICY_CACHE_MS) {
+            return this.cache.value;
+        }
+        const value = await this.systemSettings.getTelemetryPolicy();
+        this.cache = { value, readAt: Date.now() };
+        return value;
+    }
+    /** Drop the cached policy so the next read consults the row. */
+    invalidateCache() {
+        this.cache = null;
+    }
+    /**
+     * Re-reads the policy and sets the export gate to
+     * `telemetry.enabled && GreptimeDB configured`, and the gate's instance id
+     * to `telemetry.instanceId ??` the app's slug. Never throws: on a failed read the
+     * gate keeps its last values (see the header).
+     *
+     * @returns the gate's state after the call.
+     */
+    async refreshGate() {
+        try {
+            const policy = await this.getPolicy({ fresh: true });
+            const next = policy.enabled && this.greptime.isConfigured();
+            const previous = index_1.telemetryGate.isEnabled();
+            const nextInstanceId = (0, index_1.resolveTelemetryInstanceId)(policy.instanceId, this.appInfo.slug);
+            const previousInstanceId = index_1.telemetryGate.instanceId();
+            index_1.telemetryGate.setEnabled(next);
+            index_1.telemetryGate.setInstanceId(nextInstanceId);
+            if (next !== previous) {
+                this.logger.log(`Telemetry export ${next ? 'enabled' : 'disabled'}`);
+            }
+            if (nextInstanceId !== previousInstanceId) {
+                this.logger.log(`Telemetry instance id is now "${nextInstanceId}"`);
+            }
+            if (this.refreshFailing) {
+                this.refreshFailing = false;
+                this.logger.log('Telemetry settings readable again; export gate is current');
+            }
+        }
+        catch (error) {
+            if (!this.refreshFailing) {
+                this.refreshFailing = true;
+                this.logger.warn('Could not read the telemetry settings; the export gate keeps its last value ' +
+                    `(${index_1.telemetryGate.isEnabled() ? 'open' : 'closed'}): ` +
+                    `${error instanceof Error ? error.message : String(error)}`);
+            }
+        }
+        return index_1.telemetryGate.isEnabled();
+    }
+    /** `GET /api/admin/telemetry/config`. Read fresh, and never creates the settings row. */
+    async describeForAdmin() {
+        const [policy, row] = await Promise.all([this.getPolicy({ fresh: true }), this.readRow()]);
+        return {
+            ...structuredClone(policy),
+            available: this.greptime.isConfigured(),
+            retentionApplicable: this.greptime.isAdminConfigured(),
+            instanceIdDefault: this.appInfo.slug,
+            instanceIdEffective: (0, index_1.resolveTelemetryInstanceId)(policy.instanceId, this.appInfo.slug),
+            version: row?.version ?? 0,
+            updatedAt: row?.updatedAt.toISOString() ?? null,
+            updatedBy: row?.updatedBy ?? null,
+        };
+    }
+    /** `GET /api/telemetry/config` — the web feature flag. Cached; no provenance, no bounds. */
+    async describePublic() {
+        const policy = await this.getPolicy();
+        return {
+            available: this.greptime.isConfigured(),
+            enabled: policy.enabled,
+            assistantEnabled: policy.assistant.enabled,
+        };
+    }
+    /**
+     * `PUT /api/admin/telemetry/config` — full replace of the namespace.
+     *
+     * Order, each step load-bearing:
+     *   1. `If-Match` refused BEFORE anything is written (409);
+     *   2. the settings write, passing `expectedVersion` again so the write
+     *      re-checks it (that also writes the generic `system_settings:patch`
+     *      audit row);
+     *   3. the cache dropped SYNCHRONOUSLY, before anything else awaits;
+     *   4. the `telemetry:config_update` audit row — changed field NAMES only;
+     *   5. the gate re-applied on this instance (others follow within
+     *      `TELEMETRY_GATE_REFRESH_MS`);
+     *   6. a `telemetry.retention.apply` job enqueued, so a changed retention
+     *      reaches GreptimeDB now rather than at the next 4am run. Never fails
+     *      the save: the helper swallows its own errors, and the nightly cron
+     *      re-asserts the TTL regardless.
+     */
+    async replace(input, userId, expectedVersion) {
+        const row = await this.readRow();
+        const currentVersion = row?.version ?? 0;
+        if (expectedVersion !== undefined && currentVersion !== expectedVersion) {
+            throw new common_1.ConflictException(`Telemetry settings version mismatch. Expected ${expectedVersion}, found ${currentVersion}`);
+        }
+        const current = await this.systemSettings.getTelemetryPolicy();
+        // `instanceId` is the one optional field of the PUT body (see the DTO):
+        // absent keeps the stored value, so a client that predates it cannot
+        // reset it.
+        const next = structuredClone({
+            ...input,
+            instanceId: input.instanceId !== undefined ? input.instanceId : current.instanceId,
+        });
+        await this.systemSettings.replaceTelemetryPolicy(next, userId, expectedVersion);
+        // Step 3 — nothing awaits between the write and this.
+        this.invalidateCache();
+        const changedFields = diffTelemetryFieldNames(current, next);
+        await this.audit.record({
+            actorUserId: userId,
+            action: exports.TELEMETRY_CONFIG_AUDIT_ACTION,
+            targetType: 'telemetry_config',
+            targetId: 'telemetry',
+            meta: { changedFields },
+        });
+        this.logger.log(`Telemetry configuration replaced by user ${userId} ` +
+            `(enabled=${next.enabled} retentionDays=${next.retentionDays} ` +
+            `changed=${changedFields.join(',') || '(none)'})`);
+        await this.refreshGate();
+        await this.jobs.enqueueHousekeepingJob({
+            logger: this.logger,
+            type: telemetry_retention_handler_1.TELEMETRY_RETENTION_TYPE,
+            what: 'telemetry retention',
+        });
+        return this.describeForAdmin();
+    }
+    /** The `global` settings row's provenance, WITHOUT creating it. */
+    readRow() {
+        return this.systemSettings.readPolicyProvenance();
+    }
+};
+exports.TelemetrySettingsService = TelemetrySettingsService;
+exports.TelemetrySettingsService = TelemetrySettingsService = TelemetrySettingsService_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(ports_1.TELEMETRY_AUDIT_SINK)),
+    __param(1, (0, common_1.Inject)(ports_1.TELEMETRY_SETTINGS_STORE)),
+    __param(3, (0, common_1.Inject)(ports_1.TELEMETRY_JOBS)),
+    __param(4, (0, common_1.Inject)(ports_1.TELEMETRY_APP_INFO)),
+    __metadata("design:paramtypes", [Object, Object, greptime_client_1.GreptimeClient, Object, Object])
+], TelemetrySettingsService);
+/**
+ * The dotted NAMES of the fields that differ between two policies — never the
+ * values (the audit row's contract, the same as `ai_config:replace`).
+ */
+function diffTelemetryFieldNames(before, after) {
+    const flat = (value) => ({
+        enabled: value.enabled,
+        retentionDays: value.retentionDays,
+        instanceId: value.instanceId,
+        'query.maxRows': value.query.maxRows,
+        'query.timeoutSeconds': value.query.timeoutSeconds,
+        'assistant.enabled': value.assistant.enabled,
+        'assistant.provider': value.assistant.provider,
+        'assistant.modelId': value.assistant.modelId,
+        'assistant.shareResults': value.assistant.shareResults,
+        'assistant.maxResultRowsToModel': value.assistant.maxResultRowsToModel,
+        'assistant.maxSteps': value.assistant.maxSteps,
+    });
+    const a = flat(before);
+    const b = flat(after);
+    return Object.keys(a).filter((key) => a[key] !== b[key]);
+}
+//# sourceMappingURL=telemetry-settings.service.js.map

package/dist/telemetry/telemetry-settings.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry-settings.service.js","sourceRoot":"","sources":["../../src/telemetry/telemetry-settings.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AA6SA,0DAmBC;AAhUD,2CAOwB;AAExB,8CAA+E;AAQ/E,gEAA4D;AAC5D,wFAAkF;AAClF,mCAUiB;AAEjB,gFAAgF;AAChF,6EAA6E;AAC7E,0BAA0B;AAC1B,gFAAgF;AAChF,EAAE;AACF,yBAAyB;AACzB,EAAE;AACF,4EAA4E;AAC5E,4EAA4E;AAC5E,0EAA0E;AAC1E,yEAAyE;AACzE,EAAE;AACF,gFAAgF;AAChF,2EAA2E;AAC3E,0EAA0E;AAC1E,4EAA4E;AAC5E,YAAY;AACZ,EAAE;AACF,+EAA+E;AAC/E,4EAA4E;AAC5E,8DAA8D;AAC9D,6EAA6E;AAC7E,8DAA8D;AAC9D,uEAAuE;AACvE,4EAA4E;AAC5E,wEAAwE;AACxE,gEAAgE;AAChE,iEAAiE;AACjE,6EAA6E;AAC7E,EAAE;AACF,4EAA4E;AAC5E,2EAA2E;AAC3E,4BAA4B;AAC5B,EAAE;AACF,2EAA2E;AAC3E,6EAA6E;AAC7E,yEAAyE;AACzE,uCAAuC;AACvC,gFAAgF;AAEhF,qDAAqD;AACxC,QAAA,yBAAyB,GAAG,KAAK,CAAC;AAE/C,4EAA4E;AAC/D,QAAA,yBAAyB,GAAG,KAAK,CAAC;AAE/C,kDAAkD;AACrC,QAAA,6BAA6B,GAAG,yBAAyB,CAAC;AAEvE;;;;;GAKG;AAEI,IAAM,wBAAwB,gCAA9B,MAAM,wBAAwB;IASc;IACI;IAClC;IACwB;IACI;IAZ9B,MAAM,GAAG,IAAI,eAAM,CAAC,0BAAwB,CAAC,IAAI,CAAC,CAAC;IAE5D,KAAK,GAA2D,IAAI,CAAC;IACrE,YAAY,GAA0B,IAAI,CAAC;IACnD,iGAAiG;IACzF,cAAc,GAAG,KAAK,CAAC;IAE/B,YACiD,KAAyB,EACrB,cAAsC,EACxE,QAAwB,EACA,IAAuB,EACnB,OAAyB;QAJvB,UAAK,GAAL,KAAK,CAAoB;QACrB,mBAAc,GAAd,cAAc,CAAwB;QACxE,aAAQ,GAAR,QAAQ,CAAgB;QACA,SAAI,GAAJ,IAAI,CAAmB;QACnB,YAAO,GAAP,OAAO,CAAkB;IACrE,CAAC;IAEJ;;;OAGG;IACH,YAAY;QACV,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;QAExB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE;YACnC,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1B,CAAC,EAAE,iCAAyB,CAAC,CAAC;QAC9B,0DAA0D;QAC1D,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,CAAC;IAC9B,CAAC;IAED,8BAA8B;IAC9B,eAAe;QACb,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS,CAAC,OAA4B,EAAE;QAC5C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,iCAAyB,EAAE,CAAC;YACrF,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;QAC1B,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE,CAAC;QAC7D,IAAI,CAAC,KAAK,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QAE3C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gEAAgE;IAChE,eAAe;QACb,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACrD,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;YAC5D,MAAM,QAAQ,GAAG,qBAAa,CAAC,SAAS,EAAE,CAAC;YAC3C,MAAM,cAAc,GAAG,IAAA,kCAA0B,EAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACxF,MAAM,kBAAkB,GAAG,qBAAa,CAAC,UAAU,EAAE,CAAC;YAEtD,qBAAa,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC/B,qBAAa,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAE5C,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACtB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC;YACvE,CAAC;YAED,IAAI,cAAc,KAAK,kBAAkB,EAAE,CAAC;gBAC1C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iCAAiC,cAAc,GAAG,CAAC,CAAC;YACtE,CAAC;YAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;gBAC5B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;gBAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,8EAA8E;oBAC5E,IAAI,qBAAa,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,KAAK;oBACtD,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAC9D,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,qBAAa,CAAC,SAAS,EAAE,CAAC;IACnC,CAAC;IAED,yFAAyF;IACzF,KAAK,CAAC,gBAAgB;QACpB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAE3F,OAAO;YACL,GAAG,eAAe,CAAC,MAAM,CAAC;YAC1B,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE;YACvC,mBAAmB,EAAE,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE;YACtD,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;YACpC,mBAAmB,EAAE,IAAA,kCAA0B,EAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YACrF,OAAO,EAAE,GAAG,EAAE,OAAO,IAAI,CAAC;YAC1B,SAAS,EAAE,GAAG,EAAE,SAAS,CAAC,WAAW,EAAE,IAAI,IAAI;YAC/C,SAAS,EAAE,GAAG,EAAE,SAAS,IAAI,IAAI;SAClC,CAAC;IACJ,CAAC;IAED,4FAA4F;IAC5F,KAAK,CAAC,cAAc;QAClB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAEtC,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE;YACvC,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,gBAAgB,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO;SAC3C,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,OAAO,CACX,KAAiC,EACjC,MAAc,EACd,eAAwB;QAExB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACjC,MAAM,cAAc,GAAG,GAAG,EAAE,OAAO,IAAI,CAAC,CAAC;QAEzC,IAAI,eAAe,KAAK,SAAS,IAAI,cAAc,KAAK,eAAe,EAAE,CAAC;YACxE,MAAM,IAAI,0BAAiB,CACzB,iDAAiD,eAAe,WAAW,cAAc,EAAE,CAC5F,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE,CAAC;QAC/D,wEAAwE;QACxE,qEAAqE;QACrE,YAAY;QACZ,MAAM,IAAI,GAAyB,eAAe,CAAC;YACjD,GAAG,KAAK;YACR,UAAU,EAAE,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU;SACnF,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;QAEhF,sDAAsD;QACtD,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,MAAM,aAAa,GAAG,uBAAuB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAE7D,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YACtB,WAAW,EAAE,MAAM;YACnB,MAAM,EAAE,qCAA6B;YACrC,UAAU,EAAE,kBAAkB;YAC9B,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,EAAE,aAAa,EAAE;SACxB,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,GAAG,CACb,4CAA4C,MAAM,GAAG;YACnD,YAAY,IAAI,CAAC,OAAO,kBAAkB,IAAI,CAAC,aAAa,GAAG;YAC/D,WAAW,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,GAAG,CACpD,CAAC;QAEF,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzB,MAAM,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC;YACrC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,sDAAwB;YAC9B,IAAI,EAAE,qBAAqB;SAC5B,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACjC,CAAC;IAED,mEAAmE;IAC3D,OAAO;QACb,OAAO,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACpD,CAAC;CACF,CAAA;AAhNY,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,mBAAU,GAAE;IAUR,WAAA,IAAA,eAAM,EAAC,4BAAoB,CAAC,CAAA;IAC5B,WAAA,IAAA,eAAM,EAAC,gCAAwB,CAAC,CAAA;IAEhC,WAAA,IAAA,eAAM,EAAC,sBAAc,CAAC,CAAA;IACtB,WAAA,IAAA,eAAM,EAAC,0BAAkB,CAAC,CAAA;qDAFA,gCAAc;GAXhC,wBAAwB,CAgNpC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CAAC,MAA4B,EAAE,KAA2B;IAC/F,MAAM,IAAI,GAAG,CAAC,KAA2B,EAA2B,EAAE,CAAC,CAAC;QACtE,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,aAAa,EAAE,KAAK,CAAC,aAAa;QAClC,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,eAAe,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO;QACpC,sBAAsB,EAAE,KAAK,CAAC,KAAK,CAAC,cAAc;QAClD,mBAAmB,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO;QAC5C,oBAAoB,EAAE,KAAK,CAAC,SAAS,CAAC,QAAQ;QAC9C,mBAAmB,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO;QAC5C,wBAAwB,EAAE,KAAK,CAAC,SAAS,CAAC,YAAY;QACtD,gCAAgC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB;QACtE,oBAAoB,EAAE,KAAK,CAAC,SAAS,CAAC,QAAQ;KAC/C,CAAC,CAAC;IAEH,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IAEtB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAC3D,CAAC"}

package/dist/telemetry/telemetry-status.service.d.ts

@@ -0,0 +1,28 @@
+import type { TelemetryStatus, TelemetryTtl } from './dto/telemetry-status.dto';
+import { GreptimeClient } from './greptime/greptime.client';
+import { TelemetrySettingsService } from './telemetry-settings.service';
+/** Per-statement ceiling for the status reads. A status page must not hang. */
+export declare const TELEMETRY_STATUS_TIMEOUT_MS = 5000;
+export declare class TelemetryStatusService {
+    private readonly greptime;
+    private readonly settings;
+    private readonly logger;
+    constructor(greptime: GreptimeClient, settings: TelemetrySettingsService);
+    getStatus(): Promise<TelemetryStatus>;
+    private readTtl;
+    private readTables;
+}
+/**
+ * The TTL out of a `SHOW CREATE DATABASE` statement, e.g.
+ * `CREATE DATABASE IF NOT EXISTS public\nWITH(\n  ttl = '7days'\n)` →
+ * `{ raw: '7days', days: 7 }`. Null when the statement sets no TTL.
+ */
+export declare function parseTtlFromCreateDatabase(statement: string): TelemetryTtl | null;
+/**
+ * GreptimeDB prints durations with Rust's `humantime` (`7days`, `30days`,
+ * `1month 13h 26m 24s`, `1year`). Its month is 30.44 days and its year 365.25
+ * days, which is why 31 days does not print as `31days`. Returns seconds, or
+ * null for `forever`/`instant`/anything unrecognised.
+ */
+export declare function parseHumantimeSeconds(value: string): number | null;
+//# sourceMappingURL=telemetry-status.service.d.ts.map

package/dist/telemetry/telemetry-status.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry-status.service.d.ts","sourceRoot":"","sources":["../../src/telemetry/telemetry-status.service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAChF,OAAO,EAAE,cAAc,EAA4B,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAqBxE,+EAA+E;AAC/E,eAAO,MAAM,2BAA2B,OAAQ,CAAC;AAEjD,qBACa,sBAAsB;IAI/B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAJ3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2C;gBAG/C,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,wBAAwB;IAG/C,SAAS,IAAI,OAAO,CAAC,eAAe,CAAC;YAuD7B,OAAO;YAmBP,UAAU;CAYzB;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI,CAQjF;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAkClE"}