Merge pull request #127 from axiomhq/arne/allow-route-override

Allow route override in reportWebVitals, bump version
axiomhq · Jun 27, 2023 · e6648d2 · e6648d2 · vercel · Jun 27, 2023
2 parents 60501b9 + a72c12e
commit e6648d2
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "next-axiom",
   "description": "Send WebVitals from your Next.js project to Axiom.",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "author": "Axiom, Inc.",
   "license": "MIT",
   "contributors": [

diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,4 @@
-export { reportWebVitals } from './webVitals';
+export { reportWebVitals, reportWebVitalsWithPath } from './webVitals';
 export { log, Logger } from './logger';
 export {
   withAxiom,

diff --git a/src/webVitals.ts b/src/webVitals.ts
@@ -10,7 +10,12 @@ const throttledSendMetrics = throttle(sendMetrics, 1000);
 let collectedMetrics: WebVitalsMetric[] = [];
 
 export function reportWebVitals(metric: NextWebVitalsMetric) {
-  collectedMetrics.push({ route: window.__NEXT_DATA__?.page, ...metric });
+  reportWebVitalsWithPath(metric);
+}
+
+export function reportWebVitalsWithPath(metric: NextWebVitalsMetric, path?: string) {
+  const route = path || window.__NEXT_DATA__?.page;
+  collectedMetrics.push({ route, ...metric });
   // if Axiom env vars are not set, do nothing,
   // otherwise devs will get errors on dev environments
   if (!config.isEnvVarsSet()) {