farol
library
Classes
-
FakeTransport
-
In-memory transport for tests: records every payload in sent.
-
Faro
-
The RUM client: a process-wide singleton that batches signals (logs,
events, measurements, exceptions) and ships them to a Faro collector.
-
FaroApp
-
Identity of the monitored application.
-
FaroConfig
-
Configuration for Faro.initialize.
-
FaroEvent
-
A named product/UX event signal.
-
FaroException
-
An exception signal: type, redacted value, and parsed stack frames.
-
FaroLog
-
A log line signal.
-
FaroMeasurement
-
A numeric measurement signal (e.g. frame timings, RPC durations).
-
FaroMeta
-
Batch meta: app, SDK, session, view, and user, one per POST.
-
FaroPayload
-
One collector POST: shared meta plus the batched signals.
-
FaroSdk
-
Identity of the reporting SDK.
-
FaroSession
-
The telemetry session a batch belongs to.
-
FaroTraceContext
-
Trace/span ids linking a signal to a distributed trace.
-
FaroTransport
-
Delivers assembled batches to a collector; pluggable for testing.
-
FaroUser
-
The (optionally identified) end user.
-
FaroView
-
The logical view (screen/route) active for a batch.
-
HttpFaroTransport
-
Default transport: JSON POST to the collector URL, fire-and-forget.
Typedefs
-
FaroBeforeSend
= FaroPayload? Function(FaroPayload)
-
Hook invoked with each batch before transport; return
null to drop the
batch, or a modified payload to scrub/enrich it.