Skip to content
Back to search

grafana-frontend-observability

MarketplaceWorks with Claude CodeGitHub

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.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/grafana/faro-web-sdk with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/grafana/faro-web-sdk'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/grafana--faro-web-sdk/badge.svg)](/listings/grafana--faro-web-sdk)

HTML

<a href="/listings/grafana--faro-web-sdk"><img src="/api/listings/grafana--faro-web-sdk/badge.svg" alt="findsafeskills safety rating" /></a>

Install

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 23 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "name": "grafana-frontend-observability",
  3. "owner": {
  4. "name": "Grafana Labs",
  5. "email": "frontend-observability@grafana.com"
  6. },
  7. "metadata": {
  8. "description": "Grafana Cloud observability skills for Claude Code",
  9. "version": "1.0.0"
  10. },
  11. "plugins": [
  12. {
  13. "name": "faro-setup",
  14. "source": "./ai/grafana-cloud/faro-setup",
  15. "description": "Auto-instrument any web app with Grafana Faro Web SDK. Detects your framework, generates init code, wires it into your entry point, and opens a PR.",
  16. "version": "1.0.0",
  17. "author": {
  18. "name": "Grafana Labs",
  19. "email": "frontend-observability@grafana.com"
  20. }
  21. }
  22. ]
  23. }
README.md · README · 143 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Grafana Faro Web SDK
  2. <p align="left">
  3. <img src="docs/faro_logo.png#gh-light-mode-only" alt="Grafana Faro logo" width="400">
  4. <img src="docs/faro_logo_dark.png#gh-dark-mode-only" alt="Grafana Faro logo" width="400">
  5. </p>
  6. The Grafana Faro Web SDK can instrument frontend JavaScript applications to collect telemetry and forward it to the
  7. [Grafana Alloy][grafana-alloy-docs] (with faro receiver integration enabled), to a Grafana Cloud instance or to a
  8. custom receiver. Grafana Alloy can then send this data to [Loki][grafana-logs] or [Tempo][grafana-traces].
  9. The repository consists of multiple packages that can be combined depending on your requirements. For a full reference
  10. instrumentation of a real-world app, see [grafana/quickpizza][faro-demo] — the canonical Frontend Observability demo,
  11. deployed live at [quickpizza.grafana-dev.com](https://quickpizza.grafana-dev.com) and instrumented with the current
  12. Faro Web SDK, Web Tracing, and Session Replay packages.
  13. ## Get started
  14. > [!NOTE]
  15. > 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/).
  16. See [quick start for web applications][faro-quick-start].
  17. ## Local development
  18. Contributing to the SDK? See [local development][faro-local-dev] for the three supported paths:
  19. the in-repo smoke harness, your own Grafana Cloud free-tier stack, or a local Alloy install.
  20. [Pull requests][faro-pull-requests] explains how pull requests work here, including the automation
  21. that labels a pull request `stale` after 60 days without activity, closes it 14 days after that, and
  22. how to keep one open.
  23. ## Packages
  24. ### Core
  25. [@grafana/faro-core][faro-core] is the main package that provides the core functionality of the SDK. The
  26. [README.md][faro-core-readme] file provides an overview of the architecture and the API of library.
  27. ### Web SDK
  28. [@grafana/faro-web-sdk][faro-web-sdk] provides instrumentations, metas and transports for use in web applications. See
  29. the [README.md][faro-web-sdk-readme] for more information.
  30. ### Web Tracing
  31. [@grafana/faro-web-tracing][faro-web-tracing] provides implementation for tracing web applications. See the
  32. [README.md][faro-web-tracing-readme] for more information.
  33. ### React Support
  34. [@grafana/faro-react][faro-react] is a package that enables easier integration in projects built with React. See the
  35. [README.md][faro-react-readme] for more information.
  36. [grafana-alloy-docs]: https://grafana.com/docs/alloy/latest/
  37. [grafana-logs]: https://grafana.com/logs/
  38. [grafana-traces]: https://grafana.com/traces/
  39. [faro-core]: ./packages/core
  40. [faro-core-readme]: ./packages/core/README.md
  41. [faro-demo]: https://github.com/grafana/quickpizza
  42. [faro-local-dev]: ./docs/sources/developer/local-development.md
  43. [faro-pull-requests]: ./docs/PULL_REQUESTS.md
  44. [faro-quick-start]: ./docs/sources/tutorials/quick-start-browser.md
  45. [faro-react]: ./packages/react
  46. [faro-react-readme]: ./packages/react/README.md
  47. [faro-supported-environments]: https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/introduction/supported-environments/
  48. [faro-web-sdk]: ./packages/web-sdk
  49. [faro-web-sdk-readme]: ./packages/web-sdk/README.md
  50. [faro-web-tracing]: ./packages/web-tracing
  51. [faro-web-tracing-readme]: ./packages/web-tracing/README.md
  52. ## Supported environments
  53. The Faro Web SDK instruments web pages that run in a browser. During initialization, the SDK and most of its default
  54. instrumentations read browser APIs such as `window`, `document`, `PerformanceObserver` and `sessionStorage`. JavaScript
  55. that doesn't run in a typical web page context is outside the supported scope.
  56. | Environment | Supported |
  57. | -------------------------------------------------------------------------- | --------- |
  58. | Web applications that run in a browser | Yes |
  59. | Client-side of server-rendered applications, such as Next.js and React SSR | Yes |
  60. | Server runtime of server-rendered applications | No |
  61. | Browser extensions | No |
  62. | Web workers and service workers | No |
  63. | Node.js, React Native, and other non-browser JavaScript environments | No |
  64. Browser extensions come up often, so to be explicit, they are not supported. Some users have made Faro run inside an
  65. extension by supplying their own set of instrumentations. That configuration is unsupported and we do not accept
  66. issues for it.
  67. For the reasoning behind each row, and for what to use instead when monitoring a server or a backend, see
  68. [supported environments][faro-supported-environments].
  69. ## Releases
  70. Faro releases follow the [Semantic Versioning](https://semver.org/) naming scheme: `MAJOR.MINOR.PATCH`.
  71. - `MAJOR`: Major releases include large new features which will significantly change how Faro operates
  72. and possible backwards-compatibility breaking changes.
  73. - `MINOR`: these releases include _new features which generally do not break_ backwards-compatibility.
  74. - `PATCH`: patch releases include _bug and security fixes_ which do not break backwards-compatibility.
  75. > NOTE: Our goal is to provide regular releases that are as stable as possible,
  76. > and we take backwards-compatibility seriously. As with any software, always read the release notes
  77. > and the upgrade guide whenever choosing a new version of Faro to install.
  78. ## Supported Node versions
  79. This section is about the Node versions used to build, test and publish the SDK. Node.js is not a runtime that the SDK
  80. itself supports. See [supported environments](#supported-environments).
  81. Faro supports all active LTS (Long Term Support) and current Node versions. When Node.js versions
  82. reach end-of-life, we remove them from our test matrix and add new versions as they are released.
  83. You can find a [release schedule on nodejs.org](https://nodejs.org/en/about/previous-releases#looking-for-the-latest-release-of-a-version-branch)
  84. ---
  85. ### 📢 Faro v2 is Live! 🎉
  86. We’re excited to announce that Faro v2 is now available.
  87. This version modernizes Faro, simplifies setup, and removes legacy code, to give users a cleaner and better performing experience.
  88. #### ✨ What’s New
  89. - Web Vitals v5 – Upgraded to v5 of Web Vitals library to remove FID metric and for improved performance.
  90. - Cleaner Tracing APIs – Removed redundant/deprecated attributes.
  91. - Simplified Setup – Simplified the console instrumentation configuration.
  92. - Leaner Core – Deprecated packages and legacy internals were removed for improved stability.
  93. ##### Follow the upgrade guides for more information
  94. [Upgrading Guide](https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/instrument/upgrading/upgrade-guide/)
  95. [v2 Upgrade Guide](https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/instrument/upgrading/upgrade-v2/)
  96. #### 🚀 Get Involved
  97. - Contribute on [GitHub](https://github.com/grafana/faro-web-sdk)
  98. - Share feedback: Grafana's Community Slack - [#faro](https://grafana.slack.com/archives/C048UH68BM5)
  99. Thanks to all contributors and early adopters for helping us shape Faro v2! 💙

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.