RomanBronevik / faro-web-sdk

The Grafana Faro Web SDK, part of the Grafana Faro project, is a highly configurable web SDK for real user monitoring (RUM) that instruments browser frontend applications to capture observability signals. Frontend telemetry can then be correlated with backend and infrastructure data for full-stack observability.

Grafana Faro Web SDK

The Grafana Faro Web SDK can instrument frontend JavaScript applications to collect telemetry and forward it to the Grafana Agent (with app agent receiver integration enabled), to a Grafana Cloud instance or to a custom receiver. Grafana Agent can then send this data to Loki or Tempo.

The repository consists of multiple packages that can be combined depending on your requirements, as well as a demo, which can be run by following the README.md file.

Get started

See quick start for web applications.

Packages

Core

@grafana/faro-core is the main package that provides the core functionality of the SDK. The README.md file provides an overview of the architecture and the API of library.

Web SDK

@grafana/faro-web-sdk provides instrumentations, metas and transports for use in web applications. See the README.md for more information.

Web Tracing

@grafana/faro-web-tracing provides implementation for tracing web applications. See the README.md for more information.

React Support

@grafana/faro-react is a package that enables easier integration in projects built with React. See the README.md for more information.