← hyperlink-ts

ApiMetrics17

Constructors

TagconstClass factory for an ApiMetrics instance tag — its own per-instance RPC group, so it serves on a node alongside queues/processes via ApiMetrics.serve and is reached with Hyperlink.client.

Layers & Serving

layerconstLocal layer for one ApiMetrics tag — reads the in-process usage registry.layerForconstLike layer, but takes the outbound client's Service class as a witness so the compiler proves the metrics tag's clientId matches that client's Context key (correct by construction).serveconstServe this metrics resource and grant its local instance from one materialization — the counterpart to Hyperlink.serve, fed from the in-process usage registry (ApiMetrics.layer semantics, via instrumentEndpoints).serveRemoteconstServe this metrics resource remotely (served-only) — the counterpart to Hyperlink.serveRemote.

Models

ApiMetricsConstructOptionsinterfaceTag-construction options for ApiMetrics.Tag: bind the metrics resource to a (so it's served + reached on that node) and/or set its dashboard panel title.ApiMetricsNodeTagtypeA node-bound ApiMetricsTag — its [nodeSym] narrowed to the node (so Hyperlink.client resolves the transport).ApiMetricsTagtypeAn ApiMetrics instance tag — a HyperlinkTag plus the linked client id.ApiMetricsTagOptionsinterfaceOptions for ApiMetrics.Tag (second stage).ApiUsageMetricstype ApiUsageSnapshottype

Wire Schemas

apiUsageMetricsconstWindowed API usage metrics — element of the ApiMetrics metrics stream.apiUsageSnapshotconstPoint-in-time API usage snapshot — element of the ApiMetrics usage ref (usage.get).

Utils

clientIdOfconstRead the linked outbound client id from an ApiMetrics tag.clientIdSymconstWhere the linked outbound client id is stored on an ApiMetrics tag.kindconstThis contract's canonical kind — stamped on every tag so consumers (e.g.metricsKeyForconstDefault Hyperlink key for a metrics tag bound to clientId.