ui

README

Grafana Agent Flow UI

Prerequisites

• Yarn >= v1.22
• Node.js >= v16

Documentation

Overview

Package ui exposes utilities to get a Handler for the Grafana Agent Flow UI.

Index

• func Assets() http.FileSystem
• func RegisterRoutes(pathPrefix string, router *mux.Router)

Functions

func Assets

func Assets() http.FileSystem

Assets contains the UI's assets.

func RegisterRoutes

func RegisterRoutes(pathPrefix string, router *mux.Router)

RegisterRoutes registers routes to the provided mux.Router for serving the Grafana Agent Flow UI. The UI will be served relative to pathPrefix. If no pathPrefix is specified, the UI will be served at root.

By default, the UI is retrieved from the ./web/ui/build directory relative to working directory, assuming that the Agent is run from the repo root. However, if the builtinassets Go tag is present, the built UI will be embedded into the binary; run go generate -tags builtinassets for this package to generate the assets to embed.

RegisterRoutes catches all requests from pathPrefix and so should only be invoked after all other routes have been registered.

RegisterRoutes is not intended for public use and will only work properly when called from github.com/grafana/agent.