mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-18 21:16:47 +00:00
Maurice
d30b916f9c
Every route is calculated in the browser against the public FOSSGIS hosts, so the server never sees a routing request and nobody has a number: not how many a real trip costs, not how big they are, not how much already goes to a self-hosted engine. Deciding whether TREK could run its own router without that number is guessing at the bill, and the counters have to be collecting before the question comes up. Counters, not a log. A row is a day, a profile, a request kind and an engine kind with totals on it: how many requests, how many waypoints, roughly how far, how many were refused. No query, no coordinate, no route, no user, no trip. Nothing leaves the instance: its own database holds them and its own admin reads them at GET /api/route-usage/summary. The client tallies in memory and flushes in batches — on a timer, past a threshold and when the page is hidden — because a counter that cost a request of its own would measure the load by adding to it. Routing all funnels through one fetch in RouteCalculator, so that is the only place instrumented. On by default and switchable off with route_usage_enabled, unlike the shadow log next door: that one stores what people typed, this one stores four integers about a day.
25 lines
1.0 KiB
TypeScript
25 lines
1.0 KiB
TypeScript
import type { RouteUsageEntry, RouteUsageSummaryResult } from '@trek/shared'
|
|
import { apiClient } from './client'
|
|
|
|
/**
|
|
* Reports the routing counters this browser has tallied up.
|
|
*
|
|
* Fire and forget: it never throws and never blocks the route it is describing. A
|
|
* failed report is a lost count, which is a far smaller problem than a map that waits
|
|
* on a measurement.
|
|
*
|
|
* No client-side switch to check, unlike the shadow log. Counting is on unless an
|
|
* operator turned it off, and that is a server setting the server enforces — a report
|
|
* to a switched-off instance is answered with `recorded: false` and costs one request.
|
|
*/
|
|
export const routeUsageApi = {
|
|
report: (entries: RouteUsageEntry[]): Promise<void> =>
|
|
entries.length
|
|
? apiClient.post('/route-usage/report', { entries }).then(() => undefined)
|
|
: Promise.resolve(),
|
|
|
|
/** Admin only. The figures behind "could we host a router ourselves". */
|
|
summary: (): Promise<RouteUsageSummaryResult> =>
|
|
apiClient.get('/route-usage/summary').then(r => r.data),
|
|
}
|