api

Documentation

Index

• Variables
• type API
  • func New(logger log.Logger, ctx context.Context, qe *promql.Engine, ...) *API
  • func (api *API) Register(r *route.Router)
• type GlobalURLOptions

Variables

var (
	LocalhostRepresentations = []string{"127.0.0.1", "localhost", "::1"}
)

Types

type API

type API struct {
	Queryable   storage.SampleAndChunkQueryable
	QueryEngine *promql.Engine
	// contains filtered or unexported fields
}

API can register a set of endpoints in a router and handle them using the provided storage and query engine.

func New

func New(
	logger log.Logger,
	ctx context.Context,
	qe *promql.Engine,
	q storage.SampleAndChunkQueryable,
) *API

New returns an initialized API type.

func (*API) Register

func (api *API) Register(r *route.Router)

Register the API's endpoints in the given router.

type GlobalURLOptions

type GlobalURLOptions struct {
	ListenAddress string
	Host          string
	Scheme        string
}

GlobalURLOptions contains fields used for deriving the global URL for local targets.