Faro Web Sdk banner
grafana grafana

Faro Web Sdk

Development community

Description

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.

Installation

This entry records only its repository, not the path inside it, so there is no exact command to give. Open the source below and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

README

Grafana Faro Web SDK

Grafana Faro logo Grafana Faro logo

The Grafana Faro Web SDK can instrument frontend JavaScript applications to collect telemetry and forward it to the [Grafana Alloy][grafana-alloy-docs] (with faro receiver integration enabled), to a Grafana Cloud instance or to a custom receiver. Grafana Alloy can then send this data to [Loki][grafana-logs] or [Tempo][grafana-traces].

The repository consists of multiple packages that can be combined depending on your requirements. For a full reference instrumentation of a real-world app, see [grafana/quickpizza][faro-demo] — the canonical Frontend Observability demo, deployed live at [quickpizza.grafana-dev.com](https://quickpizza.grafana-dev.com) and instrumented with the current Faro Web SDK, Web Tracing, and Session Replay packages.

Get started

[!NOTE] For more information, you can find the Faro documentation in the [Grafana Cloud docs for Faro](https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/instrument/).

See [quick start for web applications][faro-quick-start].

Local development

Contributing to the SDK? See [local development][faro-local-dev] for the three supported paths: the in-repo smoke harness, your own Grafana Cloud free-tier stack, or a local Alloy install.

[Pull requests][faro-pull-requests] explains how pull requests work here, including the automation that labels a pull request `stale` after 60 days without activity, closes it 14 days after that, and how to keep one open.

Packages

Core

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

Web SDK

[@grafana/faro-web-sdk][faro-web-sdk] provides instrumentations, met