https://github.com/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.
https://github.com/grafana/faro-web-sdk

Last synced: 2 days ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/grafana/faro-web-sdk
• Owner: grafana
• License: apache-2.0
• Created: 2021-09-23T09:30:45.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-22T20:44:45.000Z (20 days ago)
• Last Synced: 2024-11-28T13:52:56.140Z (14 days ago)
• Language: TypeScript
• Homepage: https://grafana.com/oss/faro/
• Size: 12.9 MB
• Stars: 771
• Watchers: 137
• Forks: 66
• Open Issues: 92
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Governance: GOVERNANCE.md

Awesome Lists containing this project

• awesome-repositories - 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 sign (TypeScript)

README

        
# Grafana Faro Web SDK

[![Build Status][faro-drone-status]][faro-drone]



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, as well as a

[demo][faro-demo], which can be run by following the [README.md file][faro-demo-readme].

## 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].

## 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, metas and transports for use in web applications. See

the [README.md][faro-web-sdk-readme] for more information.

### Web Tracing

[@grafana/faro-web-tracing][faro-web-tracing] provides implementation for tracing web applications. See the

[README.md][faro-web-tracing-readme] for more information.

### React Support

[@grafana/faro-react][faro-react] is a package that enables easier integration in projects built with React. See the

[README.md][faro-react-readme] for more information.

[faro-drone]: https://drone.grafana.net/grafana/faro-web-sdk

[faro-drone-status]: https://drone.grafana.net/api/badges/grafana/faro-web-sdk/status.svg

[grafana-alloy-docs]: https://grafana.com/docs/alloy/latest/

[grafana-logs]: https://grafana.com/logs/

[grafana-traces]: https://grafana.com/traces/

[faro-core]: ./packages/core

[faro-core-readme]: ./packages/core/README.md

[faro-demo]: ./demo

[faro-demo-readme]: ./demo/README.md

[faro-quick-start]: ./docs/sources/tutorials/quick-start-browser.md

[faro-react]: ./packages/react

[faro-react-readme]: ./packages/react/README.md

[faro-web-sdk]: ./packages/web-sdk

[faro-web-sdk-readme]: ./packages/web-sdk/README.md

[faro-web-tracing]: ./packages/web-tracing

[faro-web-tracing-readme]: ./packages/web-tracing/README.md

## Releases

Faro releases follow the [Semantic Versioning](https://semver.org/) 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.