@loglayer/mixin-datadog-http-metrics 1.0.0

package/dist/index.mjs

@@ -0,0 +1,539 @@
+import metrics from "datadog-metrics";
+
+//#region src/client.ts
+let metricsClient = null;
+/**
+* Set the datadog-metrics client for the mixin.
+* Called during mixin registration.
+*
+* @param client - The BufferedMetricsLogger instance
+*/
+function setMetricsClient(client) {
+	metricsClient = client;
+}
+/**
+* Check if the client is null (no-op mode)
+*
+* @returns True if the client is null, false otherwise
+*/
+function isNoOpClient() {
+	return metricsClient === null;
+}
+/**
+* Get the datadog-metrics client.
+* Returns the configured client or null if not configured.
+*
+* @returns The BufferedMetricsLogger instance or null
+*/
+function getMetricsClient() {
+	return metricsClient;
+}
+
+//#endregion
+//#region ../../core/plugin/dist/index.js
+/**
+* List of plugin callbacks that can be called by the plugin manager.
+*
+* @see {@link https://loglayer.dev/plugins/creating-plugins.html#transformloglevel | transformLogLevel Docs}
+* @see {@link https://loglayer.dev/plugins/creating-plugins.html#onbeforedataout | onBeforeDataOut Docs}
+* @see {@link https://loglayer.dev/plugins/creating-plugins.html#shouldsendtologger | shouldSendToLogger Docs}
+* @see {@link https://loglayer.dev/plugins/creating-plugins.html#onmetadatacalled | onMetadataCalled Docs}
+* @see {@link https://loglayer.dev/plugins/creating-plugins.html#onbeforemessageout | onBeforeMessageOut Docs}
+* @see {@link https://loglayer.dev/plugins/creating-plugins.html#oncontextcalled | onContextCalled Docs}
+*/
+let PluginCallbackType = /* @__PURE__ */ function(PluginCallbackType) {
+	PluginCallbackType["transformLogLevel"] = "transformLogLevel";
+	PluginCallbackType["onBeforeDataOut"] = "onBeforeDataOut";
+	PluginCallbackType["shouldSendToLogger"] = "shouldSendToLogger";
+	PluginCallbackType["onMetadataCalled"] = "onMetadataCalled";
+	PluginCallbackType["onBeforeMessageOut"] = "onBeforeMessageOut";
+	PluginCallbackType["onContextCalled"] = "onContextCalled";
+	return PluginCallbackType;
+}({});
+
+//#endregion
+//#region ../../core/loglayer/dist/index.js
+const CALLBACK_LIST = [
+	PluginCallbackType.onBeforeDataOut,
+	PluginCallbackType.onMetadataCalled,
+	PluginCallbackType.onBeforeMessageOut,
+	PluginCallbackType.transformLogLevel,
+	PluginCallbackType.shouldSendToLogger,
+	PluginCallbackType.onContextCalled
+];
+/**
+* The class that the mixin extends
+*/
+let LogLayerMixinAugmentType = /* @__PURE__ */ function(LogLayerMixinAugmentType) {
+	/**
+	* Mixin extends the LogBuilder prototype
+	*/
+	LogLayerMixinAugmentType["LogBuilder"] = "LogBuilder";
+	/**
+	* Mixin extends the LogLayer prototype
+	*/
+	LogLayerMixinAugmentType["LogLayer"] = "LogLayer";
+	return LogLayerMixinAugmentType;
+}({});
+
+//#endregion
+//#region src/CommonMetricsBuilder.ts
+/**
+* Base class for common metrics builder functionality.
+* Provides shared methods for configuring tags and timestamp.
+*/
+var CommonMetricsBuilder = class {
+	/** Tags to attach to the metric */
+	tags;
+	/** Timestamp in milliseconds since epoch */
+	timestamp;
+	/** The datadog-metrics client instance */
+	client;
+	/**
+	* Creates a new CommonMetricsBuilder instance.
+	*
+	* @param client - The datadog-metrics BufferedMetricsLogger instance
+	*/
+	constructor(client) {
+		this.client = client;
+	}
+	/**
+	* Add tags to the metric.
+	*
+	* @param tags - Tags as an array of strings (e.g., ['env:prod', 'service:api'])
+	* @returns The builder instance for method chaining
+	*/
+	withTags(tags) {
+		this.tags = tags;
+		return this;
+	}
+	/**
+	* Set the timestamp for the metric.
+	*
+	* @param timestamp - Timestamp in milliseconds since epoch
+	* @returns The builder instance for method chaining
+	*/
+	withTimestamp(timestamp) {
+		this.timestamp = timestamp;
+		return this;
+	}
+};
+
+//#endregion
+//#region src/builders/DistributionBuilder.ts
+/**
+* Builder for the distribution method.
+* Supports chaining with withTags() and withTimestamp().
+*/
+var DistributionBuilder = class extends CommonMetricsBuilder {
+	/** The metric key */
+	key;
+	/** The distribution value */
+	value;
+	/**
+	* Creates a new DistributionBuilder instance.
+	*
+	* @param client - The datadog-metrics BufferedMetricsLogger instance
+	* @param key - The metric key to record
+	* @param value - The distribution value to record
+	*/
+	constructor(client, key, value) {
+		super(client);
+		this.key = key;
+		this.value = value;
+	}
+	/**
+	* Send the distribution metric with the configured options.
+	*/
+	send() {
+		this.client.distribution(this.key, this.value, this.tags, this.timestamp);
+	}
+};
+
+//#endregion
+//#region src/builders/GaugeBuilder.ts
+/**
+* Builder for the gauge method.
+* Supports chaining with withTags() and withTimestamp().
+*/
+var GaugeBuilder = class extends CommonMetricsBuilder {
+	/** The metric key */
+	key;
+	/** The gauge value */
+	value;
+	/**
+	* Creates a new GaugeBuilder instance.
+	*
+	* @param client - The datadog-metrics BufferedMetricsLogger instance
+	* @param key - The metric key to set
+	* @param value - The value to set the gauge to
+	*/
+	constructor(client, key, value) {
+		super(client);
+		this.key = key;
+		this.value = value;
+	}
+	/**
+	* Send the gauge metric with the configured options.
+	*/
+	send() {
+		this.client.gauge(this.key, this.value, this.tags, this.timestamp);
+	}
+};
+
+//#endregion
+//#region src/builders/HistogramBuilder.ts
+/**
+* Builder for the histogram method.
+* Supports chaining with withTags(), withTimestamp(), and withHistogramOptions().
+*/
+var HistogramBuilder = class extends CommonMetricsBuilder {
+	/** The metric key */
+	key;
+	/** The histogram value */
+	value;
+	/** Optional histogram-specific options */
+	histogramOptions;
+	/**
+	* Creates a new HistogramBuilder instance.
+	*
+	* @param client - The datadog-metrics BufferedMetricsLogger instance
+	* @param key - The metric key to record
+	* @param value - The histogram value to record
+	*/
+	constructor(client, key, value) {
+		super(client);
+		this.key = key;
+		this.value = value;
+	}
+	/**
+	* Set histogram-specific options for aggregation and percentiles.
+	*
+	* @param options - Histogram options with aggregates and/or percentiles
+	* @returns The builder instance for method chaining
+	*/
+	withHistogramOptions(options) {
+		this.histogramOptions = options;
+		return this;
+	}
+	/**
+	* Send the histogram metric with the configured options.
+	*/
+	send() {
+		this.client.histogram(this.key, this.value, this.tags, this.timestamp, this.histogramOptions);
+	}
+};
+
+//#endregion
+//#region src/builders/IncrementBuilder.ts
+/**
+* Builder for the increment method.
+* Supports chaining with withValue(), withTags(), and withTimestamp().
+*/
+var IncrementBuilder = class extends CommonMetricsBuilder {
+	/** The metric key */
+	key;
+	/** The increment value (optional, defaults to 1) */
+	value;
+	/**
+	* Creates a new IncrementBuilder instance.
+	*
+	* @param client - The datadog-metrics BufferedMetricsLogger instance
+	* @param key - The metric key to increment
+	*/
+	constructor(client, key) {
+		super(client);
+		this.key = key;
+	}
+	/**
+	* Set the increment value.
+	*
+	* @param value - The value to increment by (defaults to 1 if not specified)
+	* @returns The builder instance for method chaining
+	*/
+	withValue(value) {
+		this.value = value;
+		return this;
+	}
+	/**
+	* Send the increment metric with the configured options.
+	*/
+	send() {
+		this.client.increment(this.key, this.value, this.tags, this.timestamp);
+	}
+};
+
+//#endregion
+//#region src/MetricsAPI.ts
+/**
+* Metrics API implementation that wraps datadog-metrics BufferedMetricsLogger.
+* Provides a fluent interface for sending metrics to Datadog via HTTP.
+*/
+var MetricsAPI = class {
+	/**
+	* Creates a new MetricsAPI instance.
+	*
+	* @param client - The datadog-metrics BufferedMetricsLogger instance
+	*/
+	constructor(client) {
+		this.client = client;
+	}
+	/**
+	* Increment a counter metric.
+	* Returns a builder that supports chaining with withValue(), withTags(), and withTimestamp().
+	*
+	* @param key - The metric key to increment
+	* @returns A builder instance for chaining additional options
+	*/
+	increment(key) {
+		return new IncrementBuilder(this.client, key);
+	}
+	/**
+	* Set a gauge metric to a specific value.
+	* Returns a builder that supports chaining with withTags() and withTimestamp().
+	*
+	* @param key - The metric key to set
+	* @param value - The value to set the gauge to
+	* @returns A builder instance for chaining additional options
+	*/
+	gauge(key, value) {
+		return new GaugeBuilder(this.client, key, value);
+	}
+	/**
+	* Record a histogram value.
+	* Returns a builder that supports chaining with withTags(), withTimestamp(), and withHistogramOptions().
+	*
+	* @param key - The metric key to record
+	* @param value - The histogram value to record
+	* @returns A builder instance for chaining additional options
+	*/
+	histogram(key, value) {
+		return new HistogramBuilder(this.client, key, value);
+	}
+	/**
+	* Record a distribution value (server-side calculated).
+	* Returns a builder that supports chaining with withTags() and withTimestamp().
+	*
+	* @param key - The metric key to record
+	* @param value - The distribution value to record
+	* @returns A builder instance for chaining additional options
+	*/
+	distribution(key, value) {
+		return new DistributionBuilder(this.client, key, value);
+	}
+	/**
+	* Flush all buffered metrics to Datadog immediately.
+	*
+	* @returns A promise that resolves when the flush completes
+	*/
+	flush() {
+		return this.client.flush();
+	}
+	/**
+	* Start auto-flushing metrics at the configured interval.
+	*/
+	start() {
+		this.client.start();
+	}
+	/**
+	* Stop auto-flushing and optionally flush remaining metrics.
+	*
+	* @param options - Options for stopping. `flush` defaults to true.
+	* @returns A promise that resolves when stopping completes
+	*/
+	stop(options) {
+		return this.client.stop(options);
+	}
+	/**
+	* Get the underlying BufferedMetricsLogger instance.
+	*
+	* @returns The BufferedMetricsLogger instance
+	*/
+	getClient() {
+		return this.client;
+	}
+};
+
+//#endregion
+//#region src/MockMetricsAPI.ts
+/**
+* Base class for mock metrics builders.
+* Provides no-op implementations of common builder methods.
+*/
+var MockCommonMetricsBuilder = class {
+	withTags(_tags) {
+		return this;
+	}
+	withTimestamp(_timestamp) {
+		return this;
+	}
+	send() {}
+};
+/**
+* Mock implementation of IncrementBuilder.
+* Does nothing when methods are called.
+*/
+var MockIncrementBuilder = class extends MockCommonMetricsBuilder {
+	constructor(_key) {
+		super();
+	}
+	withValue(_value) {
+		return this;
+	}
+};
+/**
+* Mock implementation of GaugeBuilder.
+* Does nothing when methods are called.
+*/
+var MockGaugeBuilder = class extends MockCommonMetricsBuilder {
+	constructor(_key, _value) {
+		super();
+	}
+};
+/**
+* Mock implementation of HistogramBuilder.
+* Does nothing when methods are called.
+*/
+var MockHistogramBuilder = class extends MockCommonMetricsBuilder {
+	constructor(_key, _value) {
+		super();
+	}
+	withHistogramOptions(_options) {
+		return this;
+	}
+};
+/**
+* Mock implementation of DistributionBuilder.
+* Does nothing when methods are called.
+*/
+var MockDistributionBuilder = class extends MockCommonMetricsBuilder {
+	constructor(_key, _value) {
+		super();
+	}
+};
+/**
+* No-op implementation of IMetricsAPI.
+* All methods return mock builder instances that do nothing when send() is called.
+* This is used when datadogMetricsMixin(null) is called, allowing the metrics API
+* to be used without actually sending any metrics.
+*/
+var MockMetricsAPI = class {
+	increment(key) {
+		return new MockIncrementBuilder(key);
+	}
+	gauge(key, value) {
+		return new MockGaugeBuilder(key, value);
+	}
+	histogram(key, value) {
+		return new MockHistogramBuilder(key, value);
+	}
+	distribution(key, value) {
+		return new MockDistributionBuilder(key, value);
+	}
+	flush() {
+		return Promise.resolve();
+	}
+	start() {}
+	stop(_options) {
+		return Promise.resolve();
+	}
+	getClient() {
+		return {
+			gauge: () => {},
+			increment: () => {},
+			histogram: () => {},
+			distribution: () => {},
+			flush: () => Promise.resolve(),
+			start: () => {},
+			stop: () => Promise.resolve()
+		};
+	}
+};
+
+//#endregion
+//#region src/LogLayer.augment.ts
+/**
+* LogLayer mixin that adds a `ddStats` property to LogLayer instances.
+* Provides access to the MetricsAPI for sending metrics to Datadog via HTTP.
+*/
+const logLayerDatadogMetricsMixin = {
+	augmentationType: LogLayerMixinAugmentType.LogLayer,
+	augment: (prototype) => {
+		Object.defineProperty(prototype, "ddStats", {
+			get() {
+				if (!this._ddMetricsAPI) {
+					const client = getMetricsClient();
+					this._ddMetricsAPI = isNoOpClient() || !client ? new MockMetricsAPI() : new MetricsAPI(client);
+				}
+				return this._ddMetricsAPI;
+			},
+			enumerable: true,
+			configurable: true
+		});
+	},
+	augmentMock: (prototype) => {
+		Object.defineProperty(prototype, "ddStats", {
+			get() {
+				if (!this._ddMetricsAPI) {
+					const client = getMetricsClient();
+					this._ddMetricsAPI = isNoOpClient() || !client ? new MockMetricsAPI() : new MetricsAPI(client);
+				}
+				return this._ddMetricsAPI;
+			},
+			enumerable: true,
+			configurable: true
+		});
+	}
+};
+
+//#endregion
+//#region src/index.ts
+const BufferedMetricsLogger = metrics.BufferedMetricsLogger;
+/**
+* A reporter that discards all metrics. Useful for testing or temporarily
+* disabling metric submission without using the `enabled` flag.
+* Re-exported from the `datadog-metrics` library.
+*/
+const NullReporter = metrics.reporters.NullReporter;
+/**
+* The default reporter that sends metrics to Datadog's HTTP API with automatic retries.
+* Re-exported from the `datadog-metrics` library.
+*/
+const DatadogReporter = metrics.reporters.DatadogReporter;
+/**
+* Register the datadog-metrics mixin with LogLayer.
+* This adds a `ddStats` property to LogLayer instances,
+* providing a fluent API for sending metrics to Datadog via HTTP.
+*
+* @param options - The BufferedMetricsLogger configuration options, or null for no-op mode.
+*   Set `enabled: false` to use no-op mode while still passing options.
+* @returns A LogLayer mixin registration object
+*
+* @example
+* ```typescript
+* import { useLogLayerMixin } from 'loglayer';
+* import { datadogMetricsMixin } from '@loglayer/mixin-datadog-http-metrics';
+*
+* useLogLayerMixin(datadogMetricsMixin({
+*   apiKey: 'your-api-key',
+*   prefix: 'myapp.',
+*   enabled: process.env.NODE_ENV === 'production',
+* }));
+* ```
+*/
+function datadogMetricsMixin(options) {
+	if (options && options.enabled !== false) {
+		const { enabled: _, ...metricsOptions } = options;
+		setMetricsClient(new metrics.BufferedMetricsLogger({
+			flushIntervalSeconds: 5,
+			...metricsOptions
+		}));
+	} else setMetricsClient(null);
+	return {
+		mixinsToAdd: [logLayerDatadogMetricsMixin],
+		pluginsToAdd: []
+	};
+}
+
+//#endregion
+export { BufferedMetricsLogger, DatadogReporter, MetricsAPI, MockMetricsAPI, NullReporter, datadogMetricsMixin };

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@loglayer/mixin-datadog-http-metrics",
+  "description": "Adds Datadog HTTP metrics functionality to LogLayer using the datadog-metrics library.",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "types": "./dist/index.d.mts",
+  "sideEffects": false,
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loglayer/loglayer.git",
+    "directory": "packages/mixins/datadog-http-metrics"
+  },
+  "author": "Theo Gravity <theo@suteki.nu>",
+  "keywords": [
+    "logging",
+    "log",
+    "loglayer",
+    "observability",
+    "datadog",
+    "metrics",
+    "datadog-metrics"
+  ],
+  "dependencies": {
+    "datadog-metrics": "0.12.1"
+  },
+  "devDependencies": {
+    "@types/node": "25.2.0",
+    "tsdown": "0.20.1",
+    "typescript": "5.9.3",
+    "vitest": "4.0.18",
+    "@internal/tsconfig": "2.1.0",
+    "loglayer": "8.5.0",
+    "@loglayer/shared": "3.3.0"
+  },
+  "bugs": "https://github.com/loglayer/loglayer/issues",
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://loglayer.dev",
+  "scripts": {
+    "build": "tsdown src/index.ts",
+    "test": "vitest --run",
+    "clean": "rm -rf .turbo node_modules dist",
+    "lint": "biome check --no-errors-on-unmatched --write --unsafe src",
+    "lint:staged": "biome check --no-errors-on-unmatched --write --unsafe --staged src",
+    "livetest": "tsx src/__tests__/livetest.ts",
+    "verify-types": "tsc --noEmit"
+  }
+}