Grafana Faro

About

A project for frontend application observability, Grafana Faro includes a highly configurable web SDK for real user monitoring (RUM) that instruments browser frontend applications to capture observability signals. The frontend telemetry can then be correlated with backend and infrastructure data for seamless, full-stack observability.

For the Grafana Faro Web SDK, please go to https://github.com/grafana/faro-web-sdk.

The repository consists of

• OpenAPI specification
• Packages with HTTP Models generated from the OpenAPI specification

Building

With Docker (recommended)

No local dependencies required — Docker handles everything:

make build-all-docker

This builds a local image (faro-build) on first run, then regenerates all packages inside it.

Locally

Install dependencies first:

# Python yq (not mikefarah/yq)
pip3 install yq

# oapi-codegen
make install-dependencies

Then build:

make build-all

Requirements

• Docker (for build-all-docker)
• Python YQ (for local builds — note: this is the Python-based yq, not mikefarah/yq)
• oapi-codegen v2.6.0 (for local builds)

Packages

Go

/pkg/go contains HTTP Models in Go generated from the OpenAPI specification using oapi-codegen.