v1

Documentation

Overview

Copyright 2020 The Prometheus Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type API
  • func New(l log.Logger, ms storage.MetricStore, flags map[string]string, ...) *API
  • func (api *API) Register(r *route.Router)

Types

type API

type API struct {
	MetricStore storage.MetricStore
	Flags       map[string]string
	StartTime   time.Time
	BuildInfo   map[string]string
	// contains filtered or unexported fields
}

API provides registration of handlers for API routes.

func New

func New(
	l log.Logger,
	ms storage.MetricStore,
	flags map[string]string,
	buildInfo map[string]string,
) *API

New returns a new API. The log.Logger can be nil, in which case no logging is performed.

func (*API) Register

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

Register registers the API handlers under their correct routes in the given router.