apiv2

Documentation

Index

• type API
  • func New(db TSDBAdmin, dbDir string, enableAdmin bool) *API
  • func (api *API) HTTPHandler(ctx context.Context, grpcAddr string) (http.Handler, error)
  • func (api *API) RegisterGRPC(srv *grpc.Server)
• type Admin
  • func NewAdmin(db TSDBAdmin, dbDir string) *Admin
  • func (s *Admin) DeleteSeries(_ context.Context, r *pb.SeriesDeleteRequest) (*pb.SeriesDeleteResponse, error)
  • func (s *Admin) TSDBCleanTombstones(_ context.Context, _ *pb.TSDBCleanTombstonesRequest) (*pb.TSDBCleanTombstonesResponse, error)
  • func (s *Admin) TSDBSnapshot(_ context.Context, req *pb.TSDBSnapshotRequest) (*pb.TSDBSnapshotResponse, error)
• type AdminDisabled
  • func (s *AdminDisabled) DeleteSeries(_ context.Context, r *pb.SeriesDeleteRequest) (*pb.SeriesDeleteResponse, error)
  • func (s *AdminDisabled) TSDBCleanTombstones(_ context.Context, _ *pb.TSDBCleanTombstonesRequest) (*pb.TSDBCleanTombstonesResponse, error)
  • func (s *AdminDisabled) TSDBSnapshot(_ context.Context, _ *pb.TSDBSnapshotRequest) (*pb.TSDBSnapshotResponse, error)
• type TSDBAdmin

Types

type API

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

API encapsulates all API services.

func New

func New(
	db TSDBAdmin,
	dbDir string,
	enableAdmin bool,
) *API

New returns a new API object.

func (*API) HTTPHandler

func (api *API) HTTPHandler(ctx context.Context, grpcAddr string) (http.Handler, error)

HTTPHandler returns an HTTP handler for a REST API gateway to the given grpc address.

func (*API) RegisterGRPC

func (api *API) RegisterGRPC(srv *grpc.Server)

RegisterGRPC registers all API services with the given server.

type Admin

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

Admin provides an administration interface to Prometheus.

func NewAdmin

func NewAdmin(db TSDBAdmin, dbDir string) *Admin

NewAdmin returns a Admin server.

func (*Admin) DeleteSeries

func (s *Admin) DeleteSeries(_ context.Context, r *pb.SeriesDeleteRequest) (*pb.SeriesDeleteResponse, error)

DeleteSeries implements pb.AdminServer.

func (*Admin) TSDBCleanTombstones

func (s *Admin) TSDBCleanTombstones(_ context.Context, _ *pb.TSDBCleanTombstonesRequest) (*pb.TSDBCleanTombstonesResponse, error)

TSDBCleanTombstones implements pb.AdminServer.

func (*Admin) TSDBSnapshot

func (s *Admin) TSDBSnapshot(_ context.Context, req *pb.TSDBSnapshotRequest) (*pb.TSDBSnapshotResponse, error)

TSDBSnapshot implements pb.AdminServer.

type AdminDisabled

type AdminDisabled struct {
}

AdminDisabled implements the administration interface that informs that the API endpoints are disabled.

func (*AdminDisabled) DeleteSeries

func (s *AdminDisabled) DeleteSeries(_ context.Context, r *pb.SeriesDeleteRequest) (*pb.SeriesDeleteResponse, error)

DeleteSeries implements pb.AdminServer.

func (*AdminDisabled) TSDBCleanTombstones

func (s *AdminDisabled) TSDBCleanTombstones(_ context.Context, _ *pb.TSDBCleanTombstonesRequest) (*pb.TSDBCleanTombstonesResponse, error)

TSDBCleanTombstones implements pb.AdminServer.

func (*AdminDisabled) TSDBSnapshot

func (s *AdminDisabled) TSDBSnapshot(_ context.Context, _ *pb.TSDBSnapshotRequest) (*pb.TSDBSnapshotResponse, error)

TSDBSnapshot implements pb.AdminServer.

type TSDBAdmin

type TSDBAdmin interface {
	CleanTombstones() error
	Delete(mint, maxt int64, ms ...*labels.Matcher) error
	Snapshot(dir string, withHead bool) error
}

TSDBAdmin defines the tsdb interfaces used by the v1 API for admin operations as well as statistics.