@remit/logger-lambda 0.0.15 → 0.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/logger-lambda",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -16,7 +16,7 @@
   },
   "scripts": {
     "test:typecheck": "tsgo --noEmit",
-    "test:run": "node --experimental-test-module-mocks --import tsx --experimental-test-coverage --test-coverage-include='src/**' --test-coverage-exclude='src/**/*.test.ts' --test-coverage-exclude='src/**/*.test.tsx' --test-coverage-lines=98 --test 'src/**/*.test.ts'",
+    "test:run": "node $NODE_TEST_FLAGS --experimental-test-module-mocks --import tsx --experimental-test-coverage --test-coverage-include='src/**' --test-coverage-exclude='src/**/*.test.ts' --test-coverage-exclude='src/**/*.test.tsx' --test-coverage-lines=98 --test 'src/**/*.test.ts'",
     "test": "npm run test:typecheck && npm run test:run",
     "build": "npm run test:typecheck"
   },

package/src/metrics.test.ts

@@ -178,18 +178,33 @@ describe("metrics registry", () => {
 		);
 	});
 
-	it("declares no unlabelled series, so no process renders a value it cannot know", async () => {
+	it("declares no application series, so no process renders a value it cannot know", async () => {
 		const text = await renderMetrics();
 		const samples = text
 			.split("\n")
-			.filter((line) => line.length > 0 && !line.startsWith("#"));
+			.filter((line) => line.startsWith("remit_"));
 		assert.deepEqual(
 			samples,
 			[],
-			"a fresh registry must render nothing until something records",
+			"a fresh registry must render no remit series until something records",
 		);
 	});
 
+	it("reports this process's own memory and event-loop health", async () => {
+		const text = await renderMetrics();
+		for (const name of [
+			"nodejs_heap_size_used_bytes",
+			"nodejs_heap_size_total_bytes",
+			"nodejs_external_memory_bytes",
+			"process_resident_memory_bytes",
+		]) {
+			assert.match(text, new RegExp(`^# TYPE ${name} gauge$`, "m"));
+			assert.ok(sample(text, name) > 0, `${name} rendered no value`);
+		}
+		assert.match(text, /^# TYPE nodejs_eventloop_lag_seconds gauge$/m);
+		assert.ok(sample(text, "nodejs_eventloop_lag_seconds") >= 0);
+	});
+
 	it("runs registered collectors before rendering", async () => {
 		let ran = 0;
 		onScrape(async () => {

package/src/metrics.ts

@@ -4,7 +4,13 @@ import {
 	type Server,
 	type ServerResponse,
 } from "node:http";
-import { Counter, Gauge, Histogram, Registry } from "prom-client";
+import {
+	Counter,
+	collectDefaultMetrics,
+	Gauge,
+	Histogram,
+	Registry,
+} from "prom-client";
 
 /**
  * The process-wide metric registry every service renders at `/metrics`
@@ -12,13 +18,26 @@ import { Counter, Gauge, Histogram, Registry } from "prom-client";
  * emitted CloudWatch Embedded Metric Format, which no configuration turns into
  * a scrape endpoint; this registry is what the endpoint renders.
  *
- * The exported recorders are the only way a series enters it. The registry
- * itself is exported for a service that owns a signal of its own shape — the
- * queue sidecar's per-queue depth gauges — so the whole process still renders
- * from one registry.
+ * The exported recorders are the only way an application series enters it. The
+ * registry itself is exported for a service that owns a signal of its own shape
+ * — the queue sidecar's per-queue depth gauges — so the whole process still
+ * renders from one registry.
  */
 export const registry = new Registry();
 
+/**
+ * Heap, resident memory and event-loop lag, read from the process itself. On a
+ * self-hosted box memory is the dimension that actually runs out, and nothing
+ * else in the deployment reports it.
+ *
+ * These are unlabelled series present in every service at once, which the
+ * application gauges deliberately avoid. A process always knows its own heap,
+ * so the value is right in all of them and `instance` tells them apart; a
+ * backlog or a queue depth would be a confident zero everywhere it is not
+ * computed.
+ */
+collectDefaultMetrics({ register: registry });
+
 /** Content type of the exposition format `renderMetrics` produces. */
 export const metricsContentType = registry.contentType;