api

Documentation

Index

• Variables
• func Add(api *mux.Router, mdb *metrics.Store)
• type JSONCodec
  • func (j JSONCodec) Encode(resp *Response) ([]byte, error)
• type QueryData
• type Response

Variables

var (
	// MinTime is the default timestamp used for the begin of optional time ranges.
	// Exposed to let downstream projects to reference it.
	MinTime = time.Unix(math.MinInt64/1000+62135596801, 0).UTC()

	// MaxTime is the default timestamp used for the end of optional time ranges.
	// Exposed to let downstream projects to reference it.
	MaxTime = time.Unix(math.MaxInt64/1000-62135596801, 999999999).UTC()
)

Functions

func Add

func Add(api *mux.Router, mdb *metrics.Store)

Types

type JSONCodec

type JSONCodec struct{}

JSONCodec is a Codec that encodes API responses as JSON.

func (JSONCodec) Encode

func (j JSONCodec) Encode(resp *Response) ([]byte, error)

type QueryData

type QueryData struct {
	ResultType parser.ValueType `json:"resultType"`
	Result     parser.Value     `json:"result"`
	Stats      stats.QueryStats `json:"stats,omitempty"`
}

type Response

type Response struct {
	Status    status      `json:"status"`
	Data      interface{} `json:"data,omitempty"`
	ErrorType errorType   `json:"errorType,omitempty"`
	Error     string      `json:"error,omitempty"`
	Warnings  []string    `json:"warnings,omitempty"`
}

Response contains a response to a HTTP API request.