@grest-ts/metrics 0.0.6 → 0.0.8

package/src/exporters/GGJsonMetricsExporter.ts

@@ -1,176 +1,176 @@
-import {GGMetric} from "../GGMetric.js";
-import {GGCounter} from "../metric/GGCounter.js";
-import {GGGauge} from "../metric/GGGauge.js";
-import {GGLazyGauge} from "../metric/GGLazyGauge.js";
-import {GGHistogram, HistogramData} from "../metric/GGHistogram.js";
-import {GGMetricsExporter, ExporterConfig} from "./GGMetricsExporter.js";
-
-export type JsonMetricConverter = (metric: GGMetric<any>, exporter: GGJsonMetricsExporter) => JsonMetric;
-
-export class GGJsonMetricsExporter extends GGMetricsExporter<JsonMetricsOutput> {
-
-    // Static map for extensibility - register converters for new metric types
-    private static converters = new Map<Function, JsonMetricConverter>();
-
-    static {
-        GGJsonMetricsExporter.registerConverter(GGCounter, convertCounter);
-        GGJsonMetricsExporter.registerConverter(GGGauge, convertGauge);
-        GGJsonMetricsExporter.registerConverter(GGLazyGauge, convertLazyGauge);
-        GGJsonMetricsExporter.registerConverter(GGHistogram, convertHistogram);
-    }
-
-    /**
-     * Register a converter for a custom metric type.
-     */
-    static registerConverter(metricClass: Function, converter: JsonMetricConverter): void {
-        GGJsonMetricsExporter.converters.set(metricClass, converter);
-    }
-
-    constructor(config: ExporterConfig = {}) {
-        super(config);
-    }
-
-    getMetrics(): JsonMetricsOutput {
-        const output: JsonMetricsOutput = {
-            timestamp: Date.now(),
-            metrics: {}
-        };
-
-        for (const metric of this.getFilteredMetrics()) {
-            output.metrics[metric.name] = this.convertMetric(metric);
-        }
-
-        return output;
-    }
-
-    private convertMetric(metric: GGMetric<any>): JsonMetric {
-        const converter = GGJsonMetricsExporter.converters.get(metric.constructor);
-        if (!converter) {
-            throw new Error(`No converter registered for metric type: ${metric.constructor.name}`);
-        }
-        return converter(metric, this);
-    }
-
-    /**
-     * Parse a label key string into a labels object.
-     * Exposed for use by converters.
-     */
-    parseLabels(labelKey: string): Record<string, string> {
-        if (!labelKey) return {};
-        const labels: Record<string, string> = {};
-        const parts = labelKey.split(',');
-        for (const part of parts) {
-            const [key, val] = part.split('=');
-            if (key && val !== undefined) {
-                labels[key] = val;
-            }
-        }
-        return labels;
-    }
-}
-
-// Built-in converters
-
-function convertCounter(metric: GGCounter<any>, exporter: GGJsonMetricsExporter): JsonMetric {
-    const values: JsonMetricValue[] = [];
-    for (const [labelKey, value] of metric.getValues()) {
-        values.push({
-            labels: exporter.parseLabels(labelKey),
-            value
-        });
-    }
-    return {
-        name: metric.name,
-        type: 'counter',
-        help: metric.key.help,
-        values
-    };
-}
-
-function convertGauge(metric: GGGauge<any>, exporter: GGJsonMetricsExporter): JsonMetric {
-    const values: JsonMetricValue[] = [];
-    for (const [labelKey, value] of metric.getValues()) {
-        values.push({
-            labels: exporter.parseLabels(labelKey),
-            value
-        });
-    }
-    return {
-        name: metric.name,
-        type: 'gauge',
-        help: metric.key.help,
-        values
-    };
-}
-
-function convertLazyGauge(metric: GGLazyGauge, exporter: GGJsonMetricsExporter): JsonMetric {
-    // Lazy gauge computes value on read - no labels
-    return {
-        name: metric.name,
-        type: 'gauge',
-        help: metric.key.help,
-        values: [{
-            labels: {},
-            value: metric.getValue()
-        }]
-    };
-}
-
-function convertHistogram(metric: GGHistogram<any>, exporter: GGJsonMetricsExporter): JsonMetric {
-    const values: JsonMetricValue[] = [];
-    const buckets = metric.getBuckets();
-
-    for (const [labelKey, data] of metric.getValues() as Map<string, HistogramData>) {
-        const bucketObj: Record<string, number> = {};
-        for (let i = 0; i < buckets.length; i++) {
-            bucketObj[String(buckets[i])] = data.values[i] ?? 0;
-        }
-
-        values.push({
-            labels: exporter.parseLabels(labelKey),
-            value: {
-                count: data.count,
-                sum: data.sum,
-                avg: data.count > 0 ? data.sum / data.count : 0,
-                min: data.min === Infinity ? 0 : data.min,
-                max: data.max === -Infinity ? 0 : data.max,
-                buckets: bucketObj
-            }
-        });
-    }
-
-    return {
-        name: metric.name,
-        type: 'histogram',
-        help: metric.key.help,
-        values
-    };
-}
-
-// Types
-
-export interface JsonMetricValue {
-    labels: Record<string, string>;
-    value: number | JsonHistogramValue;
-}
-
-export interface JsonHistogramValue {
-    count: number;
-    sum: number;
-    avg: number;
-    min: number;
-    max: number;
-    buckets: Record<string, number>;
-}
-
-export interface JsonMetric {
-    name: string;
-    type: string;
-    help: string;
-    values: JsonMetricValue[];
-}
-
-export interface JsonMetricsOutput {
-    timestamp: number;
-    metrics: Record<string, JsonMetric>;
-}
+import {GGMetric} from "../GGMetric.js";
+import {GGCounter} from "../metric/GGCounter.js";
+import {GGGauge} from "../metric/GGGauge.js";
+import {GGLazyGauge} from "../metric/GGLazyGauge.js";
+import {GGHistogram, HistogramData} from "../metric/GGHistogram.js";
+import {GGMetricsExporter, ExporterConfig} from "./GGMetricsExporter.js";
+
+export type JsonMetricConverter = (metric: GGMetric<any>, exporter: GGJsonMetricsExporter) => JsonMetric;
+
+export class GGJsonMetricsExporter extends GGMetricsExporter<JsonMetricsOutput> {
+
+    // Static map for extensibility - register converters for new metric types
+    private static converters = new Map<Function, JsonMetricConverter>();
+
+    static {
+        GGJsonMetricsExporter.registerConverter(GGCounter, convertCounter);
+        GGJsonMetricsExporter.registerConverter(GGGauge, convertGauge);
+        GGJsonMetricsExporter.registerConverter(GGLazyGauge, convertLazyGauge);
+        GGJsonMetricsExporter.registerConverter(GGHistogram, convertHistogram);
+    }
+
+    /**
+     * Register a converter for a custom metric type.
+     */
+    static registerConverter(metricClass: Function, converter: JsonMetricConverter): void {
+        GGJsonMetricsExporter.converters.set(metricClass, converter);
+    }
+
+    constructor(config: ExporterConfig = {}) {
+        super(config);
+    }
+
+    getMetrics(): JsonMetricsOutput {
+        const output: JsonMetricsOutput = {
+            timestamp: Date.now(),
+            metrics: {}
+        };
+
+        for (const metric of this.getFilteredMetrics()) {
+            output.metrics[metric.name] = this.convertMetric(metric);
+        }
+
+        return output;
+    }
+
+    private convertMetric(metric: GGMetric<any>): JsonMetric {
+        const converter = GGJsonMetricsExporter.converters.get(metric.constructor);
+        if (!converter) {
+            throw new Error(`No converter registered for metric type: ${metric.constructor.name}`);
+        }
+        return converter(metric, this);
+    }
+
+    /**
+     * Parse a label key string into a labels object.
+     * Exposed for use by converters.
+     */
+    parseLabels(labelKey: string): Record<string, string> {
+        if (!labelKey) return {};
+        const labels: Record<string, string> = {};
+        const parts = labelKey.split(',');
+        for (const part of parts) {
+            const [key, val] = part.split('=');
+            if (key && val !== undefined) {
+                labels[key] = val;
+            }
+        }
+        return labels;
+    }
+}
+
+// Built-in converters
+
+function convertCounter(metric: GGCounter<any>, exporter: GGJsonMetricsExporter): JsonMetric {
+    const values: JsonMetricValue[] = [];
+    for (const [labelKey, value] of metric.getValues()) {
+        values.push({
+            labels: exporter.parseLabels(labelKey),
+            value
+        });
+    }
+    return {
+        name: metric.name,
+        type: 'counter',
+        help: metric.key.help,
+        values
+    };
+}
+
+function convertGauge(metric: GGGauge<any>, exporter: GGJsonMetricsExporter): JsonMetric {
+    const values: JsonMetricValue[] = [];
+    for (const [labelKey, value] of metric.getValues()) {
+        values.push({
+            labels: exporter.parseLabels(labelKey),
+            value
+        });
+    }
+    return {
+        name: metric.name,
+        type: 'gauge',
+        help: metric.key.help,
+        values
+    };
+}
+
+function convertLazyGauge(metric: GGLazyGauge, exporter: GGJsonMetricsExporter): JsonMetric {
+    // Lazy gauge computes value on read - no labels
+    return {
+        name: metric.name,
+        type: 'gauge',
+        help: metric.key.help,
+        values: [{
+            labels: {},
+            value: metric.getValue()
+        }]
+    };
+}
+
+function convertHistogram(metric: GGHistogram<any>, exporter: GGJsonMetricsExporter): JsonMetric {
+    const values: JsonMetricValue[] = [];
+    const buckets = metric.getBuckets();
+
+    for (const [labelKey, data] of metric.getValues() as Map<string, HistogramData>) {
+        const bucketObj: Record<string, number> = {};
+        for (let i = 0; i < buckets.length; i++) {
+            bucketObj[String(buckets[i])] = data.values[i] ?? 0;
+        }
+
+        values.push({
+            labels: exporter.parseLabels(labelKey),
+            value: {
+                count: data.count,
+                sum: data.sum,
+                avg: data.count > 0 ? data.sum / data.count : 0,
+                min: data.min === Infinity ? 0 : data.min,
+                max: data.max === -Infinity ? 0 : data.max,
+                buckets: bucketObj
+            }
+        });
+    }
+
+    return {
+        name: metric.name,
+        type: 'histogram',
+        help: metric.key.help,
+        values
+    };
+}
+
+// Types
+
+export interface JsonMetricValue {
+    labels: Record<string, string>;
+    value: number | JsonHistogramValue;
+}
+
+export interface JsonHistogramValue {
+    count: number;
+    sum: number;
+    avg: number;
+    min: number;
+    max: number;
+    buckets: Record<string, number>;
+}
+
+export interface JsonMetric {
+    name: string;
+    type: string;
+    help: string;
+    values: JsonMetricValue[];
+}
+
+export interface JsonMetricsOutput {
+    timestamp: number;
+    metrics: Record<string, JsonMetric>;
+}

package/src/exporters/GGMetricsExporter.ts

@@ -1,88 +1,88 @@
-import {GGMetricsStore} from "../GGMetricsStore.js";
-import {GG_METRICS} from "../GGMetricsLoader.js";
-import {GGMetric} from "../GGMetric.js";
-import {GGMetricKey} from "../GGMetricKey.js";
-
-export interface ExporterConfig {
-    store?: GGMetricsStore;
-    include?: unknown[];
-    exclude?: unknown[];
-}
-
-/**
- * Abstract base class for metrics exporters.
- * Handles config parsing, metric filtering, and key discovery.
- */
-export abstract class GGMetricsExporter<TOutput> {
-    protected readonly store: GGMetricsStore;
-    private readonly includeKeys?: Set<GGMetricKey<any>>;
-    private readonly excludeKeys?: Set<GGMetricKey<any>>;
-
-    constructor(config: ExporterConfig = {}) {
-        this.store = config.store ?? GG_METRICS.get();
-        this.includeKeys = config.include ? this.discoverKeys(config.include) : undefined;
-        this.excludeKeys = config.exclude ? this.discoverKeys(config.exclude) : undefined;
-    }
-
-    /**
-     * Discover all GGMetricKey instances from an array of objects.
-     * Objects can be individual keys, or nested structures containing keys.
-     */
-    private discoverKeys(objects: unknown[]): Set<GGMetricKey<any>> {
-        const keys = new Set<GGMetricKey<any>>();
-        for (const obj of objects) {
-            this.discoverKeysRecursive(obj, keys);
-        }
-        return keys;
-    }
-
-    private discoverKeysRecursive(obj: unknown, keys: Set<GGMetricKey<any>>): void {
-        if (obj instanceof GGMetricKey) {
-            keys.add(obj);
-        } else if (obj && typeof obj === 'object') {
-            for (const value of Object.values(obj)) {
-                this.discoverKeysRecursive(value, keys);
-            }
-        }
-    }
-
-    /**
-     * Check if a metric should be included in the export.
-     * Exclude takes precedence over include.
-     */
-    protected shouldIncludeMetric(metric: GGMetric<any>): boolean {
-        // Exclude takes precedence
-        if (this.excludeKeys?.has(metric.key)) {
-            return false;
-        }
-        // If include is set, only include those
-        if (this.includeKeys) {
-            return this.includeKeys.has(metric.key);
-        }
-        // Default: include all
-        return true;
-    }
-
-    /**
-     * Get all metrics that pass the include/exclude filters.
-     */
-    protected* getFilteredMetrics(): Iterable<GGMetric<any>> {
-        for (const metric of this.store.getAllMetrics()) {
-            if (this.shouldIncludeMetric(metric)) {
-                yield metric;
-            }
-        }
-    }
-
-    /**
-     * Export metrics to the output format.
-     */
-    abstract getMetrics(): TOutput;
-
-    /**
-     * Export metrics as a JSON string.
-     */
-    getMetricsString(): string {
-        return JSON.stringify(this.getMetrics(), null, 2);
-    }
-}
+import {GGMetricsStore} from "../GGMetricsStore.js";
+import {GG_METRICS} from "../GGMetricsLoader.js";
+import {GGMetric} from "../GGMetric.js";
+import {GGMetricKey} from "../GGMetricKey.js";
+
+export interface ExporterConfig {
+    store?: GGMetricsStore;
+    include?: unknown[];
+    exclude?: unknown[];
+}
+
+/**
+ * Abstract base class for metrics exporters.
+ * Handles config parsing, metric filtering, and key discovery.
+ */
+export abstract class GGMetricsExporter<TOutput> {
+    protected readonly store: GGMetricsStore;
+    private readonly includeKeys?: Set<GGMetricKey<any>>;
+    private readonly excludeKeys?: Set<GGMetricKey<any>>;
+
+    constructor(config: ExporterConfig = {}) {
+        this.store = config.store ?? GG_METRICS.get();
+        this.includeKeys = config.include ? this.discoverKeys(config.include) : undefined;
+        this.excludeKeys = config.exclude ? this.discoverKeys(config.exclude) : undefined;
+    }
+
+    /**
+     * Discover all GGMetricKey instances from an array of objects.
+     * Objects can be individual keys, or nested structures containing keys.
+     */
+    private discoverKeys(objects: unknown[]): Set<GGMetricKey<any>> {
+        const keys = new Set<GGMetricKey<any>>();
+        for (const obj of objects) {
+            this.discoverKeysRecursive(obj, keys);
+        }
+        return keys;
+    }
+
+    private discoverKeysRecursive(obj: unknown, keys: Set<GGMetricKey<any>>): void {
+        if (obj instanceof GGMetricKey) {
+            keys.add(obj);
+        } else if (obj && typeof obj === 'object') {
+            for (const value of Object.values(obj)) {
+                this.discoverKeysRecursive(value, keys);
+            }
+        }
+    }
+
+    /**
+     * Check if a metric should be included in the export.
+     * Exclude takes precedence over include.
+     */
+    protected shouldIncludeMetric(metric: GGMetric<any>): boolean {
+        // Exclude takes precedence
+        if (this.excludeKeys?.has(metric.key)) {
+            return false;
+        }
+        // If include is set, only include those
+        if (this.includeKeys) {
+            return this.includeKeys.has(metric.key);
+        }
+        // Default: include all
+        return true;
+    }
+
+    /**
+     * Get all metrics that pass the include/exclude filters.
+     */
+    protected* getFilteredMetrics(): Iterable<GGMetric<any>> {
+        for (const metric of this.store.getAllMetrics()) {
+            if (this.shouldIncludeMetric(metric)) {
+                yield metric;
+            }
+        }
+    }
+
+    /**
+     * Export metrics to the output format.
+     */
+    abstract getMetrics(): TOutput;
+
+    /**
+     * Export metrics as a JSON string.
+     */
+    getMetricsString(): string {
+        return JSON.stringify(this.getMetrics(), null, 2);
+    }
+}