GitHub - grafana/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. (original) (raw)

Grafana Faro Web SDK

The Grafana Faro Web SDK can instrument frontend JavaScript applications to collect telemetry and forward it to theGrafana 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 ademo, 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. TheREADME.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 theREADME.md for more information.

React Support

@grafana/faro-react is a package that enables easier integration in projects built with React. See theREADME.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