api

Documentation

Overview

Package api implements the HTTP API used for the Grafana Alloy UI.

The API is internal only; it is not stable and shouldn't be relied on externally.

Index

• type AlloyAPI
  • func NewAlloyAPI(alloy service.Host, CallbackManager livedebugging.CallbackManager) *AlloyAPI
  • func (a *AlloyAPI) RegisterRoutes(urlPrefix string, r *mux.Router)

Types

type AlloyAPI

type AlloyAPI struct {
	CallbackManager livedebugging.CallbackManager
	// contains filtered or unexported fields
}

AlloyAPI is a wrapper around the component API.

func NewAlloyAPI

func NewAlloyAPI(alloy service.Host, CallbackManager livedebugging.CallbackManager) *AlloyAPI

NewAlloyAPI instantiates a new Alloy API.

func (*AlloyAPI) RegisterRoutes

func (a *AlloyAPI) RegisterRoutes(urlPrefix string, r *mux.Router)

RegisterRoutes registers all the API's routes.