faro-setup

Grafana Faro Web SDK

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.

Get started

[!NOTE] For more information, you can find the Faro documentation in the Grafana Cloud docs for Faro.

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.

Releases

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.

Supported Node versions

Faro supports all active LTS (Long Term Support) and current Node versions. When Node.js versions reach end-of-life, we remove them from our test matrix and add new versions as they are released. You can find a release schedule on nodejs.org

---

📢 Faro v2 is Live! 🎉

We’re excited to announce that Faro v2 is now available. This version modernizes Faro, simplifies setup, and removes legacy code, to give users a cleaner and better performing experience.

✨ What’s New

• Web Vitals v5 – Upgraded to v5 of Web Vitals library to remove FID metric and for improved performance.

• Cleaner Tracing APIs – Removed redundant/deprecated attributes.

• Simplified Setup – Simplified the console instrumentation configuration.

• Leaner Core – Deprecated packages and legacy internals were removed for improved stability.

Follow the upgrade guides for more information

Upgrading Guide v2 Upgrade Guide

🚀 Get Involved

• Contribute on GitHub
• Share feedback: Grafana's Community Slack - #faro

Thanks to all contributors and early adopters for helping us shape Faro v2! 💙