@phil-r/stats 2.0.0 → 2.1.0

package/README.md

@@ -80,15 +80,30 @@ See [Nest examples and integration details](./docs/guide.md) or
 
 ## Collector API
 
-`createStats(options?)` returns an independent collector. All options default to
-false (or `[]`):
+`createStats(options?)` returns an independent collector. Features are disabled
+by default; paths are unchanged unless normalized or grouped:
 
 - `endpointStats`: per-method/path totals, excluding query strings.
+- `endpointNormalizer`: synchronous `(pathname: string) => string`, called only
+  with `endpointStats` enabled. Receives the query-free pathname before
+  `complexEndpoints` matching and counter allocation; HTTP methods stay separate.
+  Exceptions are not caught, so keep the callback non-throwing.
 - `complexEndpoints`: ordered regexparam patterns, e.g. `['/user/:id']`; first
   match groups dynamic URLs. Use with `endpointStats` to limit unique keys.
 - `customStats`: include named custom measurements in output.
 - `addHeader`: add `X-Response-Time: Nms`, preserving existing values.
 
+Normalize noisy bot paths before allocating counters, alongside dynamic routes:
+
+```ts
+const stats = createStats({
+  endpointStats: true,
+  endpointNormalizer: (pathname) =>
+    pathname.endsWith('.php') ? '/*.php' : pathname,
+  complexEndpoints: ['/user/:id'],
+});
+```
+
 `stats.getStats()` returns request count, total/average milliseconds, status
 counts, process identity/uptime and enabled endpoint/custom totals. Nested maps
 are live; treat them as read-only. Counters are process-local and unbounded.
@@ -109,4 +124,4 @@ precise adapter timing, supported versions, migration and development commands.
 
 ## License
 
-[MIT](LICENSE). Fork of zenmate/stats.
+[MIT](LICENSE).

package/dist/index.js

@@ -66,6 +66,8 @@ function createStats(opts = {}) {
     if (!opts.endpointStats)
       return;
     let path = url.startsWith("/") ? url.split(/[?#]/, 1)[0] : new URL(url, "http://localhost").pathname;
+    if (opts.endpointNormalizer)
+      path = opts.endpointNormalizer(path);
     const complexPath = complexEndpoints.find((endpoint) => endpoint.pattern.test(path));
     path = complexPath ? complexPath.path : path;
     const endpoint = `${method} ${path}`;

package/dist/types.d.ts

@@ -1,7 +1,13 @@
-/** Collection features; every option defaults to false or an empty list. */
+/** Collection features; disabled by default, with paths unchanged. */
 export interface StatsOptions {
     /** Include counters keyed by HTTP method and path, excluding query strings. */
     endpointStats?: boolean;
+    /**
+     * Normalize the query-free pathname before complexEndpoints matching and storage.
+     * Requires endpointStats; omitted means identity. HTTP methods remain separate.
+     * Must return a string synchronously; exceptions are not caught.
+     */
+    endpointNormalizer?: (pathname: string) => string;
     /** Ordered regexparam patterns; first match groups dynamic URLs. Requires endpointStats. */
     complexEndpoints?: string[];
     /** Include custom measurements in getStats(); measurement methods always work. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phil-r/stats",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "license": "MIT",
   "author": "Phil Rukin <philipp@rukin.me> (https://rukin.me)",
   "description": "Request statistics middleware",