pyroproxy

Documentation

Overview

Package pyroproxy provides Pyroscope proxy for observability and research.

Index

• type Server
  • func NewServer(api *pyroscopeapi.Client) *Server
  • func (s *Server) GetApps(ctx context.Context) ([]pyroscopeapi.ApplicationMetadata, error)
  • func (s *Server) Ingest(ctx context.Context, req *pyroscopeapi.IngestReqWithContentType, ...) error
  • func (s *Server) LabelValues(ctx context.Context, params pyroscopeapi.LabelValuesParams) (pyroscopeapi.LabelValues, error)
  • func (s *Server) Labels(ctx context.Context, params pyroscopeapi.LabelsParams) (pyroscopeapi.Labels, error)
  • func (s *Server) NewError(ctx context.Context, err error) *pyroscopeapi.ErrorStatusCode
  • func (s *Server) Render(ctx context.Context, params pyroscopeapi.RenderParams) (*pyroscopeapi.FlamebearerProfileV1, error)

Types

type Server

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

Server implement proxy server.

func NewServer

func NewServer(api *pyroscopeapi.Client) *Server

NewServer initializes new proxy Server from openapi client.

func (*Server) GetApps

func (s *Server) GetApps(ctx context.Context) ([]pyroscopeapi.ApplicationMetadata, error)

GetApps implements getApps operation. Returns list of application metadata. Used by Grafana to test connection to Pyroscope.

GET /api/apps

func (*Server) Ingest

func (s *Server) Ingest(ctx context.Context, req *pyroscopeapi.IngestReqWithContentType, params pyroscopeapi.IngestParams) error

Ingest implements ingest operation.

Push data to Pyroscope.

POST /ingest

func (*Server) LabelValues

func (s *Server) LabelValues(ctx context.Context, params pyroscopeapi.LabelValuesParams) (pyroscopeapi.LabelValues, error)

LabelValues implements labelValues operation.

Returns list of label values.

GET /label-values

func (*Server) Labels

func (s *Server) Labels(ctx context.Context, params pyroscopeapi.LabelsParams) (pyroscopeapi.Labels, error)

Labels implements labels operation.

Returns list of labels.

GET /labels

func (*Server) NewError

func (s *Server) NewError(ctx context.Context, err error) *pyroscopeapi.ErrorStatusCode

NewError creates *ErrorStatusCode from error returned by handler.

Used for common default response.

func (*Server) Render

func (s *Server) Render(ctx context.Context, params pyroscopeapi.RenderParams) (*pyroscopeapi.FlamebearerProfileV1, error)

Render implements render operation.

Renders given query. One of `query` or `key` is required.

GET /render