api

package
v1.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 7, 2025 License: AGPL-3.0 Imports: 58 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MemberlistStatusHandler 

func MemberlistStatusHandler(httpPathPrefix string, kvs *memberlist.KVInitService) http.Handler

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

func New 

func New(cfg Config, s *server.Server, grpcGatewayMux *grpcgw.ServeMux, logger log.Logger) (*API, error)

func (*API) RegisterAPI 

func (a *API) RegisterAPI(statusService statusv1.StatusServiceServer) error

RegisterAPI registers the standard endpoints associated with a running Pyroscope.

func (*API) RegisterAdHocProfiles added in v1.4.0 

func (a *API) RegisterAdHocProfiles(ahp *adhocprofiles.AdHocProfiles)

func (*API) RegisterAdmin added in v1.2.1 

func (a *API) RegisterAdmin(ad *operations.Admin)

func (*API) RegisterCatchAll 

func (a *API) RegisterCatchAll() error

func (*API) RegisterCompactor added in v1.2.0 

func (a *API) RegisterCompactor(c *compactor.MultitenantCompactor)

RegisterCompactor registers routes associated with the compactor.

func (*API) RegisterDistributor 

func (a *API) RegisterDistributor(d *distributor.Distributor, limits *validation.Overrides, multitenancyEnabled bool, cfg server.Config)

RegisterDistributor registers the endpoints associated with the distributor.

func (*API) RegisterFeatureFlagsServiceHandler added in v1.14.0 

func (a *API) RegisterFeatureFlagsServiceHandler(svc capabilitiesv1connect.FeatureFlagsServiceHandler)

func (*API) RegisterFrontendForQuerierHandler added in v1.8.0 

func (a *API) RegisterFrontendForQuerierHandler(frontendSvc *frontend.Frontend)

RegisterFrontendForQuerierHandler registers the endpoints associated with the query frontend.

func (*API) RegisterIngester 

func (a *API) RegisterIngester(svc *ingester.Ingester)

RegisterIngester registers the endpoints associated with the ingester.

func (*API) RegisterIngesterRing added in v1.8.0 

func (a *API) RegisterIngesterRing(r http.Handler)

RegisterIngesterRing registers the ring UI page associated with the distributor for writes.

func (*API) RegisterMemberlistKV 

func (a *API) RegisterMemberlistKV(pathPrefix string, kvs *memberlist.KVInitService)

RegisterMemberlistKV registers the endpoints associated with the memberlist KV store.

func (*API) RegisterMetastoreAdmin added in v1.11.0 

func (a *API) RegisterMetastoreAdmin(adm *metastoreadmin.Admin)

func (*API) RegisterOverridesExporter 

func (a *API) RegisterOverridesExporter(oe *exporter.OverridesExporter)

RegisterOverridesExporter registers the endpoints associated with the overrides exporter.

func (*API) RegisterPyroscopeHandlers 

func (a *API) RegisterPyroscopeHandlers(client querierv1connect.QuerierServiceClient)

func (*API) RegisterQuerierServiceHandler added in v1.8.0 

func (a *API) RegisterQuerierServiceHandler(svc querierv1connect.QuerierServiceHandler)

func (*API) RegisterQueryBackend added in v1.8.0 

func (a *API) RegisterQueryBackend(svc *querybackend.QueryBackend)

func (*API) RegisterQueryScheduler 

func (a *API) RegisterQueryScheduler(s *scheduler.Scheduler)

RegisterQueryScheduler registers the endpoints associated with the query scheduler.

func (*API) RegisterReadyHandler added in v1.14.0 

func (a *API) RegisterReadyHandler(handler http.Handler)

func (*API) RegisterRoute 

func (a *API) RegisterRoute(path string, handler http.Handler, registerOpts ...RegisterOption)

registerRoute registers an HTTP handler with the main HTTP server.

Register Options allow to filter the HTTP methods and apply middlewares.

func (*API) RegisterRuntimeConfig 

func (a *API) RegisterRuntimeConfig(runtimeConfigHandler http.HandlerFunc, userLimitsHandler http.HandlerFunc)

RegisterRuntimeConfig registers the endpoints associates with the runtime configuration

func (*API) RegisterSegmentWriter added in v1.8.0 

func (a *API) RegisterSegmentWriter(svc *segmentwriter.SegmentWriterService)

func (*API) RegisterSegmentWriterRing added in v1.8.0 

func (a *API) RegisterSegmentWriterRing(r http.Handler)

RegisterSegmentWriterRing registers the ring UI page associated with the distributor for writes.

func (*API) RegisterStoreGateway 

func (a *API) RegisterStoreGateway(svc *storegateway.StoreGateway)

func (*API) RegisterTenantSettings added in v1.2.1 

func (a *API) RegisterTenantSettings(ts *settings.TenantSettings)

func (*API) RegisterVCSServiceHandler added in v1.8.0 

func (a *API) RegisterVCSServiceHandler(svc vcsv1connect.VCSServiceHandler)

func (*API) RegisterVersion added in v1.2.1 

func (a *API) RegisterVersion(svc versionv1connect.VersionHandler)

RegisterVersion registers the endpoints associated with the versions service.

func (*API) WithArtificialDelayMiddleware added in v1.14.0 

func (a *API) WithArtificialDelayMiddleware(limits delayhandler.Limits) RegisterOption

func (*API) WithAuthMiddleware added in v1.14.0 

func (a *API) WithAuthMiddleware() RegisterOption

func (*API) WithBodySizeLimitMiddleware added in v1.15.0 

func (a *API) WithBodySizeLimitMiddleware(limits body.Limits) RegisterOption

type Config 

type Config struct {
	// The following configs are injected by the upstream caller.
	HTTPAuthMiddleware middleware.Interface `yaml:"-"`
	GrpcAuthMiddleware connect.Option       `yaml:"-"`
	BaseURL            string               `yaml:"base-url"`
}

func (*Config) RegisterFlags 

func (cfg *Config) RegisterFlags(fs *flag.FlagSet)

RegisterFlags registers api-related flags.

type IndexPageContent 

type IndexPageContent struct {
	// contains filtered or unexported fields
}

IndexPageContent is a map of sections to path -> description.

func NewIndexPageContent 

func NewIndexPageContent() *IndexPageContent
func (pc *IndexPageContent) AddLinks(weight int, groupDesc string, links []IndexPageLink)

func (*IndexPageContent) GetContent 

func (pc *IndexPageContent) GetContent() []IndexPageLinkGroup
type IndexPageLink struct {
	Desc      string
	Path      string
	Dangerous bool
}

type IndexPageLinkGroup 

type IndexPageLinkGroup struct {
	Desc  string
	Links []IndexPageLink
	// contains filtered or unexported fields
}

type RegisterOption added in v1.14.0 

type RegisterOption func(*registerParams)

func WithGzipMiddleware added in v1.14.0 

func WithGzipMiddleware() RegisterOption

func WithMethod added in v1.14.0 

func WithMethod(method string) RegisterOption

func WithPrefix added in v1.14.0 

func WithPrefix() RegisterOption

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.