The Grafana Faro Web SDK can instrument frontend JavaScript applications to collect telemetry and forward it to the Grafana Alloy (with faro receiver integration enabled), to a Grafana Cloud instance or to a custom receiver. Grafana Alloy 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.
Note
For more information, you can find the Faro documentation in the Grafana Cloud docs for Faro.
See quick start for web applications.
@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.
@grafana/faro-web-sdk provides instrumentations, metas and transports for use in web applications. See the README.md for more information.
@grafana/faro-web-tracing provides implementation for tracing web applications. See the README.md for more information.
@grafana/faro-react is a package that enables easier integration in projects built with React. See the README.md for more information.
Faro releases follow the Semantic Versioning naming scheme: MAJOR.MINOR.PATCH.
-
MAJOR: Major releases include large new features which will significantly change how Faro operates and possible backwards-compatibility breaking changes. -
MINOR: these releases include new features which generally do not break backwards-compatibility. -
PATCH: patch releases include bug and security fixes which do not break backwards-compatibility.NOTE: Our goal is to provide regular releases that are as stable as possible, and we take backwards-compatibility seriously. As with any software, always read the release notes and the upgrade guide whenever choosing a new version of Faro to install.