api

package

v0.3.0 Latest Latest Go to latest Published: Sep 6, 2021 License: MIT Imports: 24 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

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

This section is empty.

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(
	logger log.Logger,
	ctx context.Context,
	qe *promql.Engine,
	q storage.SampleAndChunkQueryable,
) *API

New returns an initialized API type.

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

Register the API's endpoints in the given router.

type GlobalURLOptions struct {
	ListenAddress string
	Host          string
	Scheme        string
}

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