@adalo/metrics 0.0.0-staging.3 → 0.0.0-staging.31

package/README.md

@@ -25,8 +25,15 @@ new MetricsClient({
   pushgatewayUrl,     // defaults: process.env.METRICS_PUSHGATEWAY_URL || ''
   pushgatewaySecret,  // defaults: process.env.METRICS_PUSHGATEWAY_SECRET || '' (Base64 of user:password)
   intervalSec,        // defaults: process.env.METRICS_INTERVAL_SEC || 15
+  httpMetricsEnabled, // defaults: METRICS_HTTP_ENABLED === 'true' (in-process HTTP counters only)
 })
 ```
+
+### HTTP metrics: `MetricsClient` vs Redis
+
+**`MetricsClient`** only registers **in-process** `app_requests_*` counters when `METRICS_HTTP_ENABLED` / `httpMetricsEnabled` is on. For **Redis-backed** HTTP aggregation (multi-web / cluster), use **`HttpMetricsRedisRecorder`** (writers) and **`HttpMetricsRedisCollector`** (drain + push) with an injected **`redisClient`** — same idea as `RedisMetricsClient`, not mixed into `MetricsClient`. See **[`docs/http-metrics-redis.md`](docs/http-metrics-redis.md)** (quick Redis reference) and the repo guide **[`../docs/METRICS.md`](../docs/METRICS.md)** (full architecture for devs and AI assistants).
+
+`DatabaseMetricsClient` / `QueueRedisMetricsClient` / `RedisMetricsClient` call **`process.exit(0)` with no logs** if `BUILD_DYNO_PROCESS_TYPE` (or `processType`) does not match `database-metrics` / `queue-metrics` / (`redis-metrics` or `queue-metrics`) respectively.
 ## Example Usage
 ```ts
 import { MetricsClient } from '@adalo/metrics-js'
@@ -117,17 +124,4 @@ Environment variables:
 secret env was created as 
 ```js
 Buffer.from(`${username}:${password}`).toString('base64')
-```
-
-## Troubleshooting (consumers)
-
-**TypeScript build errors in `node_modules/@types/node`** (e.g. `TS1005: '?' expected` in `crypto.d.ts` or `http.d.ts`):  
-These come from a version of `@types/node` that requires TypeScript 4.7+. If your app uses TypeScript 4.6 or older, force an older `@types/node` by adding to your app’s `package.json`:
-
-```json
-"resolutions": {
-  "@types/node": "^16.0.0"
-}
-```
-
-Then run `yarn install` again and rebuild. Alternatively, upgrade your app to TypeScript 4.7+.
+```

package/__tests__/httpMetricsRedisCollector.test.js

@@ -0,0 +1,203 @@
+const { HttpMetricsRedisCollector } = require('../src/metrics/httpMetricsRedisCollector')
+const { buildFieldKey } = require('../src/metrics/httpMetricsRedisStore')
+
+function appRequestTotalsByRoute(metricsJson) {
+  const reqTotal = metricsJson.find(m => m.name === 'app_requests_total')
+  if (!reqTotal || !reqTotal.values) {
+    return {}
+  }
+  return Object.fromEntries(reqTotal.values.map(v => [v.labels.route, v.value]))
+}
+
+function createRedisV3Mock() {
+  const multiChain = {
+    hincrby: jest.fn().mockReturnThis(),
+    expire: jest.fn().mockReturnThis(),
+    exec: jest.fn(cb => {
+      if (cb) {
+        setImmediate(() => cb(null))
+      }
+    }),
+  }
+  return {
+    multi: jest.fn(() => multiChain),
+    eval: jest.fn(),
+    _multiChain: multiChain,
+  }
+}
+
+describe('HttpMetricsRedisCollector', () => {
+  const originalEnv = process.env
+
+  beforeEach(() => {
+    process.env = { ...originalEnv, METRICS_DISABLE_PUSHGATEWAY: 'true' }
+  })
+
+  afterEach(() => {
+    process.env = originalEnv
+  })
+
+  it('throws without redisClient', () => {
+    expect(() => new HttpMetricsRedisCollector({ appName: 'a' })).toThrow('redisClient is required')
+  })
+
+  it('pushMetrics drains Redis then completes without network push', async () => {
+    const redis = createRedisV3Mock()
+    const field = buildFieldKey('GET', '/health', 200)
+    redis.eval.mockImplementation((lua, numKeys, k1, k2, cb) => {
+      cb(null, [
+        [field, '1'],
+        [field, '10'],
+      ])
+    })
+
+    const collector = new HttpMetricsRedisCollector({
+      redisClient: redis,
+      appName: 'test-app',
+      dynoId: 'dyno-1',
+      processType: 'http-metrics',
+      redisProcessTypeForKeys: 'web',
+      disablePushgateway: true,
+    })
+
+    const pushSpy = jest.spyOn(collector, 'gatewayPush').mockResolvedValue()
+
+    await collector.pushMetrics()
+
+    expect(redis.eval).toHaveBeenCalled()
+    expect(pushSpy).toHaveBeenCalledTimes(1)
+    const metrics = await collector._registry.getMetricsAsJSON()
+    const total = metrics.find(m => m.name === 'app_requests_total')
+    expect(total).toBeDefined()
+    const totalDur = metrics.find(m => m.name === 'app_requests_total_duration')
+    expect(totalDur).toBeDefined()
+
+    pushSpy.mockRestore()
+  })
+
+  it('primes new label sets with 0 then applies count (extra push only when labels are new)', async () => {
+    const redis = createRedisV3Mock()
+    const field = buildFieldKey('GET', '/health', 200)
+
+    const collector = new HttpMetricsRedisCollector({
+      redisClient: redis,
+      appName: 'test-app',
+      dynoId: 'dyno-1',
+      processType: 'http-metrics',
+      redisProcessTypeForKeys: 'web',
+      disablePushgateway: true,
+    })
+
+    const pushSpy = jest.spyOn(collector, 'gatewayPush').mockResolvedValue()
+
+    redis.eval.mockImplementation((lua, numKeys, k1, k2, cb) => {
+      cb(null, [
+        [field, '2'],
+        [field, '0'],
+      ])
+    })
+    await collector.pushMetrics()
+    expect(pushSpy).toHaveBeenCalledTimes(1)
+
+    redis.eval.mockImplementation((lua, numKeys, k1, k2, cb) => {
+      cb(null, [
+        [field, '1'],
+        [field, '0'],
+      ])
+    })
+    await collector.pushMetrics()
+    expect(pushSpy).toHaveBeenCalledTimes(1)
+
+    pushSpy.mockRestore()
+  })
+
+  it('prime push for new route a leaves existing route b unchanged (a=0, b=18), then a=1, b=38', async () => {
+    const redis = createRedisV3Mock()
+    const fieldB = buildFieldKey('GET', '/b', 200)
+    const fieldA = buildFieldKey('GET', '/a', 200)
+
+    const collector = new HttpMetricsRedisCollector({
+      redisClient: redis,
+      appName: 'test-app',
+      dynoId: 'dyno-1',
+      processType: 'http-metrics',
+      redisProcessTypeForKeys: 'web',
+      disablePushgateway: true,
+    })
+
+    let primePushCount = 0
+    const pushSpy = jest.spyOn(collector, 'gatewayPush').mockImplementation(async () => {
+      primePushCount++
+      if (primePushCount === 2) {
+        const metrics = await collector._registry.getMetricsAsJSON()
+        const byRoute = appRequestTotalsByRoute(metrics)
+        expect(byRoute['/a']).toBe(0)
+        expect(byRoute['/b']).toBe(18)
+      }
+    })
+
+    redis.eval.mockImplementation((lua, numKeys, k1, k2, cb) => {
+      cb(null, [
+        [fieldB, '18'],
+        [fieldB, '0'],
+      ])
+    })
+    await collector.pushMetrics()
+
+    redis.eval.mockImplementation((lua, numKeys, k1, k2, cb) => {
+      cb(null, [
+        [fieldA, '1', fieldB, '20'],
+        [fieldA, '0', fieldB, '0'],
+      ])
+    })
+    await collector.pushMetrics()
+
+    const final = appRequestTotalsByRoute(await collector._registry.getMetricsAsJSON())
+    expect(final['/a']).toBe(1)
+    expect(final['/b']).toBe(38)
+    expect(pushSpy).toHaveBeenCalledTimes(2)
+
+    pushSpy.mockRestore()
+  })
+
+  it('does not prime POST when drain only has already-seen routes (was a:1 b:18, then a:1 b:20)', async () => {
+    const redis = createRedisV3Mock()
+    const fieldA = buildFieldKey('GET', '/a', 200)
+    const fieldB = buildFieldKey('GET', '/b', 200)
+
+    const collector = new HttpMetricsRedisCollector({
+      redisClient: redis,
+      appName: 'test-app',
+      dynoId: 'dyno-1',
+      processType: 'http-metrics',
+      redisProcessTypeForKeys: 'web',
+      disablePushgateway: true,
+    })
+
+    const pushSpy = jest.spyOn(collector, 'gatewayPush').mockResolvedValue()
+
+    redis.eval.mockImplementation((lua, numKeys, k1, k2, cb) => {
+      cb(null, [
+        [fieldA, '1', fieldB, '18'],
+        [fieldA, '0', fieldB, '0'],
+      ])
+    })
+    await collector.pushMetrics()
+    expect(pushSpy).toHaveBeenCalledTimes(1)
+
+    redis.eval.mockImplementation((lua, numKeys, k1, k2, cb) => {
+      cb(null, [
+        [fieldA, '1', fieldB, '20'],
+        [fieldA, '0', fieldB, '0'],
+      ])
+    })
+    await collector.pushMetrics()
+    expect(pushSpy).toHaveBeenCalledTimes(1)
+
+    const final = appRequestTotalsByRoute(await collector._registry.getMetricsAsJSON())
+    expect(final['/a']).toBe(2)
+    expect(final['/b']).toBe(38)
+
+    pushSpy.mockRestore()
+  })
+})

package/__tests__/httpMetricsRedisRecorder.test.js

@@ -0,0 +1,60 @@
+const { HttpMetricsRedisRecorder } = require('../src/metrics/httpMetricsRedisRecorder')
+const { buildFieldKey } = require('../src/metrics/httpMetricsRedisStore')
+
+const flushMicrotasks = () => new Promise(resolve => setImmediate(resolve))
+
+function createRedisV3Mock() {
+  const multiChain = {
+    hincrby: jest.fn().mockReturnThis(),
+    expire: jest.fn().mockReturnThis(),
+    exec: jest.fn(cb => {
+      if (cb) {
+        setImmediate(() => cb(null))
+      }
+    }),
+  }
+  return {
+    multi: jest.fn(() => multiChain),
+    set: jest.fn(),
+    eval: jest.fn(),
+    del: jest.fn(),
+    _multiChain: multiChain,
+  }
+}
+
+describe('HttpMetricsRedisRecorder', () => {
+  const originalEnv = process.env
+
+  beforeEach(() => {
+    process.env = { ...originalEnv, BUILD_APP_NAME: 'app' }
+  })
+
+  afterEach(() => {
+    process.env = originalEnv
+  })
+
+  it('throws without redisClient', () => {
+    expect(() => new HttpMetricsRedisRecorder({})).toThrow('redisClient is required')
+  })
+
+  it('trackHttpRequest forwards to Redis multi/hincrby', async () => {
+    const redis = createRedisV3Mock()
+    const rec = new HttpMetricsRedisRecorder({
+      redisClient: redis,
+    })
+    const countKey = rec._store.countKey
+    const durKey = rec._store.durKey
+    const field = buildFieldKey('GET', '/p', 404)
+
+    rec.trackHttpRequest({
+      method: 'GET',
+      route: '/p',
+      status_code: 404,
+      duration: 5,
+    })
+    await flushMicrotasks()
+
+    expect(redis._multiChain.hincrby).toHaveBeenCalledWith(countKey, field, 1)
+    expect(redis._multiChain.hincrby).toHaveBeenCalledWith(durKey, field, 5)
+  })
+})