hearald

A single server drop-in file system based metrics and analytics library.

TODO

• top stats histogram should/could be it's own ui-configurable data type
• top stats histogram fields should be controlled in the ui configuration settings

Usage

Tracking User Visits (Client)

import { trackVisit } from "hearald/client/trackVisit.js";
trackVisit({ userId: "user-123" });

Tracking Errors (Client)

import { trackError } from "hearald/client/trackError.js";
try {
  // ...code...
} catch (err) {
  trackError(err);
}

Tracking Errors (Server)

import {
  trackServerError,
  errorTrackingMiddleware,
} from "hearald/server/serverTrackError.js";
app.use(errorTrackingMiddleware);

Analytics Helpers

import {
  iso,
  getData,
  fetchChartData,
  fetchData,
  numFormatter,
} from "hearald/shared/analyticsClientHelpers.js";

Admin Stats Endpoint

The adminStatsEndpoint has been removed. For admin statistics, use the analytics router provided by hearald/server/analytics.js. Example:

import { createAnalyticsRouter } from 'hearald/server/analytics.js';
app.use('/admin/stats', createAnalyticsRouter({...}));

Admin Stats Client Fetcher

import { fetchAdminStats } from "hearald/client/adminStatsClient.js";
const stats = await fetchAdminStats();

Roadmap

See TODO.md for next steps and roadmap.