@pristine-ts/telemetry 2.0.1 → 2.0.2

package/dist/lib/esm/tracers/file.tracer.js

@@ -0,0 +1,125 @@
+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); }
+};
+import * as fs from "fs";
+import * as path from "path";
+import { Readable } from "stream";
+import { inject, injectable, singleton } from "tsyringe";
+import { injectConfig, moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
+import { ConsoleTracerOutputModeEnum } from "../enums/console-tracer-output-mode.enum";
+import { TelemetryConfigurationKeys } from "../telemetry.configuration-keys";
+import { TelemetryModuleKeyname } from "../telemetry.module.keyname";
+import { traceRenderer } from "../utils/trace-renderer";
+/**
+ * `FileTracer` writes one file per completed trace to a configured directory. Files are
+ * named after the trace's id (= eventId throughout Pristine), so locating a request's
+ * trace is `cat traces/<eventId>.json`.
+ *
+ * Off by default. Enable via `pristine.telemetry.file-tracer.activated = true`.
+ *
+ * Configuration:
+ *   - `file-tracer.directory`         — defaults to `./traces`
+ *   - `file-tracer.filename-pattern`  — defaults to `<traceId>.json`. Placeholders:
+ *                                       `<traceId>`, `<date>` (UTC YYYY-MM-DD), `<timestamp>` (ms epoch).
+ *   - `file-tracer.output-mode`       — `json` (default), `tree`, or `flat`.
+ *
+ * Crash-isolated: a write failure (read-only fs, missing permissions, etc.) becomes a
+ * stderr line, never an unhandled error. The framework continues and the next trace is
+ * attempted independently.
+ */
+let FileTracer = class FileTracer {
+    constructor(activated, outputMode, directory, filenamePattern, logHandler) {
+        this.activated = activated;
+        this.outputMode = outputMode;
+        this.directory = directory;
+        this.filenamePattern = filenamePattern;
+        this.logHandler = logHandler;
+        this.traceEndedStream = new Readable({
+            objectMode: true,
+            read(_size) { return true; },
+        });
+        this.traceEndedStream.on("data", (trace) => {
+            try {
+                this.handleTraceEnded(trace);
+            }
+            catch (error) {
+                this.reportFailure(error);
+            }
+        });
+        this.traceEndedStream.on("error", (error) => {
+            this.reportFailure(error);
+        });
+    }
+    handleTraceEnded(trace) {
+        if (this.activated === false) {
+            return;
+        }
+        const content = this.renderTrace(trace);
+        const filename = this.expandFilenamePattern(trace);
+        const absoluteDir = path.resolve(process.cwd(), this.directory);
+        const absoluteFile = path.join(absoluteDir, filename);
+        // Make sure the file's parent directory exists. We mkdir on the file's parent rather
+        // than just `absoluteDir` because filename-pattern can introduce subdirectories
+        // (e.g. `<date>/<traceId>.json` partitions traces into per-day folders). `recursive:
+        // true` is a no-op if the path already exists.
+        fs.mkdirSync(path.dirname(absoluteFile), { recursive: true });
+        // Write the file. We use `writeFileSync` rather than the async equivalent because the
+        // tracer pipeline is synchronous (the framework `.push()`es into the stream and moves
+        // on), and a write that returns a Promise would silently leak rejections. The write
+        // is small (one trace's worth of JSON, typically <50KB), so the sync cost is bounded.
+        fs.writeFileSync(absoluteFile, content);
+    }
+    renderTrace(trace) {
+        switch (this.outputMode) {
+            case ConsoleTracerOutputModeEnum.Tree:
+                return traceRenderer.renderTree(trace);
+            case ConsoleTracerOutputModeEnum.Flat:
+                return traceRenderer.renderFlat(trace);
+            case ConsoleTracerOutputModeEnum.Json:
+            default:
+                return traceRenderer.renderJson(trace);
+        }
+    }
+    expandFilenamePattern(trace) {
+        var _a, _b;
+        const date = new Date((_a = trace.endDate) !== null && _a !== void 0 ? _a : Date.now());
+        const isoDate = date.toISOString().slice(0, 10); // YYYY-MM-DD
+        const timestamp = String((_b = trace.endDate) !== null && _b !== void 0 ? _b : Date.now());
+        return this.filenamePattern
+            .replace(/<traceId>/g, trace.id)
+            .replace(/<date>/g, isoDate)
+            .replace(/<timestamp>/g, timestamp);
+    }
+    reportFailure(error) {
+        const message = error instanceof Error ? `${error.name}: ${error.message}` : String(error);
+        try {
+            process.stderr.write(`[pristine][tracer:FileTracer] ${message}\n`);
+        }
+        catch (_a) {
+            // If stderr is unwritable too, there's nothing useful left to do.
+        }
+    }
+};
+FileTracer = __decorate([
+    moduleScoped(TelemetryModuleKeyname),
+    singleton(),
+    tag(ServiceDefinitionTagEnum.Tracer),
+    injectable(),
+    __param(0, injectConfig(TelemetryConfigurationKeys.FileTracerActivated)),
+    __param(1, injectConfig(TelemetryConfigurationKeys.FileTracerOutputMode)),
+    __param(2, injectConfig(TelemetryConfigurationKeys.FileTracerDirectory)),
+    __param(3, injectConfig(TelemetryConfigurationKeys.FileTracerFilenamePattern)),
+    __param(4, inject("LogHandlerInterface")),
+    __metadata("design:paramtypes", [Boolean, String, String, String, Object])
+], FileTracer);
+export { FileTracer };
+//# sourceMappingURL=file.tracer.js.map

package/dist/lib/esm/tracers/file.tracer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.tracer.js","sourceRoot":"","sources":["../../../../src/tracers/file.tracer.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAC,QAAQ,EAAC,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AACvD,OAAO,EAAC,YAAY,EAAE,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAI9F,OAAO,EAAC,2BAA2B,EAAC,MAAM,0CAA0C,CAAC;AACrF,OAAO,EAAC,0BAA0B,EAAC,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAAC,sBAAsB,EAAC,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAC,aAAa,EAAC,MAAM,yBAAyB,CAAC;AAEtD;;;;;;;;;;;;;;;;GAgBG;AAKI,IAAM,UAAU,GAAhB,MAAM,UAAU;IAGrB,YACiF,SAAkB,EACjB,UAAuC,EACxC,SAAiB,EACX,eAAuB,EAC5D,UAA+B;QAJA,cAAS,GAAT,SAAS,CAAS;QACjB,eAAU,GAAV,UAAU,CAA6B;QACxC,cAAS,GAAT,SAAS,CAAQ;QACX,oBAAe,GAAf,eAAe,CAAQ;QAC5D,eAAU,GAAV,UAAU,CAAqB;QAE/E,IAAI,CAAC,gBAAgB,GAAG,IAAI,QAAQ,CAAC;YACnC,UAAU,EAAE,IAAI;YAChB,IAAI,CAAC,KAAa,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC;SACrC,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAY,EAAE,EAAE;YAChD,IAAI,CAAC;gBACH,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC1C,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,gBAAgB,CAAC,KAAY;QACnC,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACnD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAChE,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAEtD,qFAAqF;QACrF,gFAAgF;QAChF,qFAAqF;QACrF,+CAA+C;QAC/C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;QAE5D,sFAAsF;QACtF,sFAAsF;QACtF,oFAAoF;QACpF,sFAAsF;QACtF,EAAE,CAAC,aAAa,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAEO,WAAW,CAAC,KAAY;QAC9B,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,2BAA2B,CAAC,IAAI;gBACnC,OAAO,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACzC,KAAK,2BAA2B,CAAC,IAAI;gBACnC,OAAO,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACzC,KAAK,2BAA2B,CAAC,IAAI,CAAC;YACtC;gBACE,OAAO,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAEO,qBAAqB,CAAC,KAAY;;QACxC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,MAAA,KAAK,CAAC,OAAO,mCAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAG,aAAa;QAChE,MAAM,SAAS,GAAG,MAAM,CAAC,MAAA,KAAK,CAAC,OAAO,mCAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,eAAe;aACxB,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC;aAC/B,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC;aAC3B,OAAO,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;IAEO,aAAa,CAAC,KAAc;QAClC,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3F,IAAI,CAAC;YACH,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,iCAAiC,OAAO,IAAI,CAAC,CAAC;QACrE,CAAC;QAAC,WAAM,CAAC;YACP,kEAAkE;QACpE,CAAC;IACH,CAAC;CACF,CAAA;AAlFY,UAAU;IAJtB,YAAY,CAAC,sBAAsB,CAAC;IACpC,SAAS,EAAE;IACX,GAAG,CAAC,wBAAwB,CAAC,MAAM,CAAC;IACpC,UAAU,EAAE;IAKR,WAAA,YAAY,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,CAAA;IAC5D,WAAA,YAAY,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,CAAA;IAC7D,WAAA,YAAY,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,CAAA;IAC5D,WAAA,YAAY,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,CAAA;IAClE,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;;GARrB,UAAU,CAkFtB"}

package/dist/lib/esm/tracers/tracers.js

@@ -1,2 +1,3 @@
-export * from "./basic.tracer";
+export * from "./console.tracer";
+export * from "./file.tracer";
 //# sourceMappingURL=tracers.js.map

package/dist/lib/esm/tracers/tracers.js.map

@@ -1 +1 @@
-{"version":3,"file":"tracers.js","sourceRoot":"","sources":["../../../../src/tracers/tracers.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"tracers.js","sourceRoot":"","sources":["../../../../src/tracers/tracers.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC"}