mirror of
https://github.com/prometheus/prometheus.git
synced 2024-12-25 05:34:05 -08:00
Merge pull request #774 from prometheus/fabxc/api-v1
Initial API v1 implementation
This commit is contained in:
commit
ae01a5366d
13
main.go
13
main.go
|
@ -41,7 +41,8 @@ import (
|
||||||
"github.com/prometheus/prometheus/storage/remote/influxdb"
|
"github.com/prometheus/prometheus/storage/remote/influxdb"
|
||||||
"github.com/prometheus/prometheus/storage/remote/opentsdb"
|
"github.com/prometheus/prometheus/storage/remote/opentsdb"
|
||||||
"github.com/prometheus/prometheus/web"
|
"github.com/prometheus/prometheus/web"
|
||||||
"github.com/prometheus/prometheus/web/api"
|
"github.com/prometheus/prometheus/web/api/legacy"
|
||||||
|
"github.com/prometheus/prometheus/web/api/v1"
|
||||||
)
|
)
|
||||||
|
|
||||||
const deletionBatchSize = 100
|
const deletionBatchSize = 100
|
||||||
|
@ -184,16 +185,22 @@ func NewPrometheus() *prometheus {
|
||||||
PathPrefix: *pathPrefix,
|
PathPrefix: *pathPrefix,
|
||||||
}
|
}
|
||||||
|
|
||||||
metricsService := &api.MetricsService{
|
apiLegacy := &legacy.API{
|
||||||
Now: clientmodel.Now,
|
Now: clientmodel.Now,
|
||||||
Storage: memStorage,
|
Storage: memStorage,
|
||||||
QueryEngine: queryEngine,
|
QueryEngine: queryEngine,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
apiv1 := &v1.API{
|
||||||
|
Storage: memStorage,
|
||||||
|
QueryEngine: queryEngine,
|
||||||
|
}
|
||||||
|
|
||||||
webService := web.NewWebService(&web.WebServiceOptions{
|
webService := web.NewWebService(&web.WebServiceOptions{
|
||||||
PathPrefix: *pathPrefix,
|
PathPrefix: *pathPrefix,
|
||||||
StatusHandler: prometheusStatus,
|
StatusHandler: prometheusStatus,
|
||||||
MetricsHandler: metricsService,
|
APILegacy: apiLegacy,
|
||||||
|
APIv1: apiv1,
|
||||||
ConsolesHandler: consolesHandler,
|
ConsolesHandler: consolesHandler,
|
||||||
AlertsHandler: alertsHandler,
|
AlertsHandler: alertsHandler,
|
||||||
GraphsHandler: graphsHandler,
|
GraphsHandler: graphsHandler,
|
||||||
|
|
|
@ -666,7 +666,8 @@ func lexNumberOrDuration(l *lexer) stateFn {
|
||||||
// not necessarily a valid number. This case is caught by the parser.
|
// not necessarily a valid number. This case is caught by the parser.
|
||||||
func (l *lexer) scanNumber() bool {
|
func (l *lexer) scanNumber() bool {
|
||||||
digits := "0123456789"
|
digits := "0123456789"
|
||||||
if l.accept("0") && l.accept("xX") {
|
// Disallow hexadecimal in series descriptions as the syntax is ambiguous.
|
||||||
|
if !l.seriesDesc && l.accept("0") && l.accept("xX") {
|
||||||
digits = "0123456789abcdefABCDEF"
|
digits = "0123456789abcdefABCDEF"
|
||||||
}
|
}
|
||||||
l.acceptRun(digits)
|
l.acceptRun(digits)
|
||||||
|
@ -677,12 +678,13 @@ func (l *lexer) scanNumber() bool {
|
||||||
l.accept("+-")
|
l.accept("+-")
|
||||||
l.acceptRun("0123456789")
|
l.acceptRun("0123456789")
|
||||||
}
|
}
|
||||||
// Next thing must not be alphanumeric.
|
// Next thing must not be alphanumeric unless it's the times token
|
||||||
if isAlphaNumeric(l.peek()) && !l.seriesDesc {
|
// for series repetitions.
|
||||||
return false
|
if r := l.peek(); (l.seriesDesc && r == 'x') || !isAlphaNumeric(r) {
|
||||||
}
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
// lexIdentifier scans an alphanumeric identifier. The next character
|
// lexIdentifier scans an alphanumeric identifier. The next character
|
||||||
// is known to be a letter.
|
// is known to be a letter.
|
||||||
|
|
|
@ -1274,6 +1274,13 @@ var testSeries = []struct {
|
||||||
"a": "b",
|
"a": "b",
|
||||||
},
|
},
|
||||||
expectedValues: newSeq(1, 2, 3, -7, -17, -27, -37),
|
expectedValues: newSeq(1, 2, 3, -7, -17, -27, -37),
|
||||||
|
}, {
|
||||||
|
input: `my_metric{a="b"} 1 2 3-0x4`,
|
||||||
|
expectedMetric: clientmodel.Metric{
|
||||||
|
clientmodel.MetricNameLabel: "my_metric",
|
||||||
|
"a": "b",
|
||||||
|
},
|
||||||
|
expectedValues: newSeq(1, 2, 3, 3, 3, 3, 3),
|
||||||
}, {
|
}, {
|
||||||
input: `my_metric{a="b"} 1 3 _ 5 _x4`,
|
input: `my_metric{a="b"} 1 3 _ 5 _x4`,
|
||||||
expectedMetric: clientmodel.Metric{
|
expectedMetric: clientmodel.Metric{
|
||||||
|
|
|
@ -77,6 +77,16 @@ func NewTestFromFile(t testutil.T, filename string) (*Test, error) {
|
||||||
return NewTest(t, string(content))
|
return NewTest(t, string(content))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// QueryEngine returns the test's query engine.
|
||||||
|
func (t *Test) QueryEngine() *Engine {
|
||||||
|
return t.queryEngine
|
||||||
|
}
|
||||||
|
|
||||||
|
// Storage returns the test's storage.
|
||||||
|
func (t *Test) Storage() local.Storage {
|
||||||
|
return t.storage
|
||||||
|
}
|
||||||
|
|
||||||
func raise(line int, format string, v ...interface{}) error {
|
func raise(line int, format string, v ...interface{}) error {
|
||||||
return &ParseErr{
|
return &ParseErr{
|
||||||
Line: line + 1,
|
Line: line + 1,
|
||||||
|
|
|
@ -11,7 +11,7 @@
|
||||||
// See the License for the specific language governing permissions and
|
// See the License for the specific language governing permissions and
|
||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
|
|
||||||
package api
|
package legacy
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"net/http"
|
"net/http"
|
||||||
|
@ -26,18 +26,18 @@ import (
|
||||||
"github.com/prometheus/prometheus/util/route"
|
"github.com/prometheus/prometheus/util/route"
|
||||||
)
|
)
|
||||||
|
|
||||||
// MetricsService manages the /api HTTP endpoint.
|
// API manages the /api HTTP endpoint.
|
||||||
type MetricsService struct {
|
type API struct {
|
||||||
Now func() clientmodel.Timestamp
|
Now func() clientmodel.Timestamp
|
||||||
Storage local.Storage
|
Storage local.Storage
|
||||||
QueryEngine *promql.Engine
|
QueryEngine *promql.Engine
|
||||||
}
|
}
|
||||||
|
|
||||||
// RegisterHandler registers the handler for the various endpoints below /api.
|
// RegisterHandler registers the handler for the various endpoints below /api.
|
||||||
func (msrv *MetricsService) RegisterHandler(router *route.Router) {
|
func (api *API) Register(router *route.Router) {
|
||||||
router.Get("/query", handle("query", msrv.Query))
|
router.Get("/query", handle("query", api.Query))
|
||||||
router.Get("/query_range", handle("query_range", msrv.QueryRange))
|
router.Get("/query_range", handle("query_range", api.QueryRange))
|
||||||
router.Get("/metrics", handle("metrics", msrv.Metrics))
|
router.Get("/metrics", handle("metrics", api.Metrics))
|
||||||
}
|
}
|
||||||
|
|
||||||
func handle(name string, f http.HandlerFunc) http.HandlerFunc {
|
func handle(name string, f http.HandlerFunc) http.HandlerFunc {
|
|
@ -11,7 +11,7 @@
|
||||||
// See the License for the specific language governing permissions and
|
// See the License for the specific language governing permissions and
|
||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
|
|
||||||
package api
|
package legacy
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
|
@ -93,13 +93,13 @@ func TestQuery(t *testing.T) {
|
||||||
})
|
})
|
||||||
storage.WaitForIndexing()
|
storage.WaitForIndexing()
|
||||||
|
|
||||||
api := MetricsService{
|
api := &API{
|
||||||
Now: testNow,
|
Now: testNow,
|
||||||
Storage: storage,
|
Storage: storage,
|
||||||
QueryEngine: promql.NewEngine(storage),
|
QueryEngine: promql.NewEngine(storage),
|
||||||
}
|
}
|
||||||
rtr := route.New()
|
rtr := route.New()
|
||||||
api.RegisterHandler(rtr.WithPrefix("/api"))
|
api.Register(rtr.WithPrefix("/api"))
|
||||||
|
|
||||||
server := httptest.NewServer(rtr)
|
server := httptest.NewServer(rtr)
|
||||||
defer server.Close()
|
defer server.Close()
|
|
@ -11,7 +11,7 @@
|
||||||
// See the License for the specific language governing permissions and
|
// See the License for the specific language governing permissions and
|
||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
|
|
||||||
package api
|
package legacy
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
@ -63,20 +63,20 @@ func parseDuration(d string) (time.Duration, error) {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Query handles the /api/query endpoint.
|
// Query handles the /api/query endpoint.
|
||||||
func (serv MetricsService) Query(w http.ResponseWriter, r *http.Request) {
|
func (api *API) Query(w http.ResponseWriter, r *http.Request) {
|
||||||
setAccessControlHeaders(w)
|
setAccessControlHeaders(w)
|
||||||
w.Header().Set("Content-Type", "application/json")
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
|
||||||
params := httputil.GetQueryParams(r)
|
params := httputil.GetQueryParams(r)
|
||||||
expr := params.Get("expr")
|
expr := params.Get("expr")
|
||||||
|
|
||||||
timestamp, err := parseTimestampOrNow(params.Get("timestamp"), serv.Now())
|
timestamp, err := parseTimestampOrNow(params.Get("timestamp"), api.Now())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
httpJSONError(w, fmt.Errorf("invalid query timestamp %s", err), http.StatusBadRequest)
|
httpJSONError(w, fmt.Errorf("invalid query timestamp %s", err), http.StatusBadRequest)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
query, err := serv.QueryEngine.NewInstantQuery(expr, timestamp)
|
query, err := api.QueryEngine.NewInstantQuery(expr, timestamp)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
httpJSONError(w, err, http.StatusOK)
|
httpJSONError(w, err, http.StatusOK)
|
||||||
return
|
return
|
||||||
|
@ -92,7 +92,7 @@ func (serv MetricsService) Query(w http.ResponseWriter, r *http.Request) {
|
||||||
}
|
}
|
||||||
|
|
||||||
// QueryRange handles the /api/query_range endpoint.
|
// QueryRange handles the /api/query_range endpoint.
|
||||||
func (serv MetricsService) QueryRange(w http.ResponseWriter, r *http.Request) {
|
func (api *API) QueryRange(w http.ResponseWriter, r *http.Request) {
|
||||||
setAccessControlHeaders(w)
|
setAccessControlHeaders(w)
|
||||||
w.Header().Set("Content-Type", "application/json")
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
|
||||||
|
@ -111,7 +111,7 @@ func (serv MetricsService) QueryRange(w http.ResponseWriter, r *http.Request) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
end, err := parseTimestampOrNow(params.Get("end"), serv.Now())
|
end, err := parseTimestampOrNow(params.Get("end"), api.Now())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
httpJSONError(w, fmt.Errorf("invalid query timestamp: %s", err), http.StatusBadRequest)
|
httpJSONError(w, fmt.Errorf("invalid query timestamp: %s", err), http.StatusBadRequest)
|
||||||
return
|
return
|
||||||
|
@ -121,7 +121,7 @@ func (serv MetricsService) QueryRange(w http.ResponseWriter, r *http.Request) {
|
||||||
// the current time as the end time. Instead, the "end" parameter should
|
// the current time as the end time. Instead, the "end" parameter should
|
||||||
// simply be omitted or set to an empty string for that case.
|
// simply be omitted or set to an empty string for that case.
|
||||||
if end == 0 {
|
if end == 0 {
|
||||||
end = serv.Now()
|
end = api.Now()
|
||||||
}
|
}
|
||||||
|
|
||||||
// For safety, limit the number of returned points per timeseries.
|
// For safety, limit the number of returned points per timeseries.
|
||||||
|
@ -136,7 +136,7 @@ func (serv MetricsService) QueryRange(w http.ResponseWriter, r *http.Request) {
|
||||||
end = end.Add(-time.Duration(end.UnixNano() % int64(step)))
|
end = end.Add(-time.Duration(end.UnixNano() % int64(step)))
|
||||||
start := end.Add(-duration)
|
start := end.Add(-duration)
|
||||||
|
|
||||||
query, err := serv.QueryEngine.NewRangeQuery(expr, start, end, step)
|
query, err := api.QueryEngine.NewRangeQuery(expr, start, end, step)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
httpJSONError(w, err, http.StatusOK)
|
httpJSONError(w, err, http.StatusOK)
|
||||||
return
|
return
|
||||||
|
@ -152,11 +152,11 @@ func (serv MetricsService) QueryRange(w http.ResponseWriter, r *http.Request) {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Metrics handles the /api/metrics endpoint.
|
// Metrics handles the /api/metrics endpoint.
|
||||||
func (serv MetricsService) Metrics(w http.ResponseWriter, r *http.Request) {
|
func (api *API) Metrics(w http.ResponseWriter, r *http.Request) {
|
||||||
setAccessControlHeaders(w)
|
setAccessControlHeaders(w)
|
||||||
w.Header().Set("Content-Type", "application/json")
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
|
||||||
metricNames := serv.Storage.LabelValuesForLabelName(clientmodel.MetricNameLabel)
|
metricNames := api.Storage.LabelValuesForLabelName(clientmodel.MetricNameLabel)
|
||||||
sort.Sort(metricNames)
|
sort.Sort(metricNames)
|
||||||
resultBytes, err := json.Marshal(metricNames)
|
resultBytes, err := json.Marshal(metricNames)
|
||||||
if err != nil {
|
if err != nil {
|
|
@ -11,7 +11,7 @@
|
||||||
// See the License for the specific language governing permissions and
|
// See the License for the specific language governing permissions and
|
||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
|
|
||||||
package api
|
package legacy
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"testing"
|
"testing"
|
213
web/api/v1/api.go
Normal file
213
web/api/v1/api.go
Normal file
|
@ -0,0 +1,213 @@
|
||||||
|
package v1
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"sort"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/prometheus/client_golang/prometheus"
|
||||||
|
|
||||||
|
clientmodel "github.com/prometheus/client_golang/model"
|
||||||
|
|
||||||
|
"github.com/prometheus/prometheus/promql"
|
||||||
|
"github.com/prometheus/prometheus/storage/local"
|
||||||
|
"github.com/prometheus/prometheus/util/route"
|
||||||
|
"github.com/prometheus/prometheus/util/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
type status string
|
||||||
|
|
||||||
|
const (
|
||||||
|
statusSuccess status = "success"
|
||||||
|
statusError = "error"
|
||||||
|
)
|
||||||
|
|
||||||
|
type errorType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
errorTimeout errorType = "timeout"
|
||||||
|
errorCanceled = "canceled"
|
||||||
|
errorExec = "execution"
|
||||||
|
errorBadData = "bad_data"
|
||||||
|
)
|
||||||
|
|
||||||
|
type apiError struct {
|
||||||
|
typ errorType
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *apiError) Error() string {
|
||||||
|
return fmt.Sprintf("%s: %s", e.typ, e.err)
|
||||||
|
}
|
||||||
|
|
||||||
|
type response struct {
|
||||||
|
Status status `json:"status"`
|
||||||
|
Data interface{} `json:"data,omitempty"`
|
||||||
|
ErrorType errorType `json:"errorType,omitempty"`
|
||||||
|
Error string `json:"error,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// API can register a set of endpoints in a router and handle
|
||||||
|
// them using the provided storage and query engine.
|
||||||
|
type API struct {
|
||||||
|
Storage local.Storage
|
||||||
|
QueryEngine *promql.Engine
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enables cross-site script calls.
|
||||||
|
func setCORS(w http.ResponseWriter) {
|
||||||
|
w.Header().Set("Access-Control-Allow-Headers", "Accept, Authorization, Content-Type, Origin")
|
||||||
|
w.Header().Set("Access-Control-Allow-Methods", "GET, POST, DELETE")
|
||||||
|
w.Header().Set("Access-Control-Allow-Origin", "*")
|
||||||
|
w.Header().Set("Access-Control-Expose-Headers", "Date")
|
||||||
|
}
|
||||||
|
|
||||||
|
type apiFunc func(r *http.Request) (interface{}, *apiError)
|
||||||
|
|
||||||
|
// Register the API's endpoints in the given router.
|
||||||
|
func (api *API) Register(r *route.Router) {
|
||||||
|
instr := func(name string, f apiFunc) http.HandlerFunc {
|
||||||
|
return prometheus.InstrumentHandlerFunc(name, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
setCORS(w)
|
||||||
|
if data, err := f(r); err != nil {
|
||||||
|
respondError(w, err, data)
|
||||||
|
} else {
|
||||||
|
respond(w, data)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Get("/query", instr("query", api.query))
|
||||||
|
r.Get("/query_range", instr("query_range", api.queryRange))
|
||||||
|
|
||||||
|
r.Get("/metrics/names", instr("metric_names", api.metricNames))
|
||||||
|
}
|
||||||
|
|
||||||
|
type queryData struct {
|
||||||
|
ResultType promql.ExprType `json:"resultType"`
|
||||||
|
Result promql.Value `json:"result"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (api *API) query(r *http.Request) (interface{}, *apiError) {
|
||||||
|
ts, err := parseTime(r.FormValue("time"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, &apiError{errorBadData, err}
|
||||||
|
}
|
||||||
|
qry, err := api.QueryEngine.NewInstantQuery(r.FormValue("query"), ts)
|
||||||
|
if err != nil {
|
||||||
|
return nil, &apiError{errorBadData, err}
|
||||||
|
}
|
||||||
|
|
||||||
|
res := qry.Exec()
|
||||||
|
if res.Err != nil {
|
||||||
|
return nil, &apiError{errorBadData, res.Err}
|
||||||
|
}
|
||||||
|
return &queryData{
|
||||||
|
ResultType: res.Value.Type(),
|
||||||
|
Result: res.Value,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (api *API) queryRange(r *http.Request) (interface{}, *apiError) {
|
||||||
|
start, err := parseTime(r.FormValue("start"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, &apiError{errorBadData, err}
|
||||||
|
}
|
||||||
|
end, err := parseTime(r.FormValue("end"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, &apiError{errorBadData, err}
|
||||||
|
}
|
||||||
|
step, err := parseDuration(r.FormValue("step"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, &apiError{errorBadData, err}
|
||||||
|
}
|
||||||
|
|
||||||
|
// For safety, limit the number of returned points per timeseries.
|
||||||
|
// This is sufficient for 60s resolution for a week or 1h resolution for a year.
|
||||||
|
if end.Sub(start)/step > 11000 {
|
||||||
|
err := errors.New("exceeded maximum resolution of 11,000 points per timeseries. Try decreasing the query resolution (?step=XX)")
|
||||||
|
return nil, &apiError{errorBadData, err}
|
||||||
|
}
|
||||||
|
|
||||||
|
qry, err := api.QueryEngine.NewRangeQuery(r.FormValue("query"), start, end, step)
|
||||||
|
if err != nil {
|
||||||
|
switch err.(type) {
|
||||||
|
case promql.ErrQueryCanceled:
|
||||||
|
return nil, &apiError{errorCanceled, err}
|
||||||
|
case promql.ErrQueryTimeout:
|
||||||
|
return nil, &apiError{errorTimeout, err}
|
||||||
|
}
|
||||||
|
return nil, &apiError{errorExec, err}
|
||||||
|
}
|
||||||
|
|
||||||
|
res := qry.Exec()
|
||||||
|
if res.Err != nil {
|
||||||
|
return nil, &apiError{errorBadData, err}
|
||||||
|
}
|
||||||
|
return &queryData{
|
||||||
|
ResultType: res.Value.Type(),
|
||||||
|
Result: res.Value,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (api *API) metricNames(r *http.Request) (interface{}, *apiError) {
|
||||||
|
metricNames := api.Storage.LabelValuesForLabelName(clientmodel.MetricNameLabel)
|
||||||
|
sort.Sort(metricNames)
|
||||||
|
|
||||||
|
return metricNames, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func respond(w http.ResponseWriter, data interface{}) {
|
||||||
|
w.WriteHeader(200)
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
|
||||||
|
b, err := json.Marshal(&response{
|
||||||
|
Status: statusSuccess,
|
||||||
|
Data: data,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Write(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
func respondError(w http.ResponseWriter, apiErr *apiError, data interface{}) {
|
||||||
|
w.WriteHeader(422)
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
|
||||||
|
b, err := json.Marshal(&response{
|
||||||
|
Status: statusError,
|
||||||
|
ErrorType: apiErr.typ,
|
||||||
|
Error: apiErr.err.Error(),
|
||||||
|
Data: data,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Write(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseTime(s string) (clientmodel.Timestamp, error) {
|
||||||
|
if t, err := strconv.ParseFloat(s, 64); err == nil {
|
||||||
|
ts := int64(t * float64(time.Second))
|
||||||
|
return clientmodel.TimestampFromUnixNano(ts), nil
|
||||||
|
}
|
||||||
|
if t, err := time.Parse(time.RFC3339Nano, s); err == nil {
|
||||||
|
return clientmodel.TimestampFromTime(t), nil
|
||||||
|
}
|
||||||
|
return 0, fmt.Errorf("cannot parse %q to a valid timestamp", s)
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseDuration(s string) (time.Duration, error) {
|
||||||
|
if d, err := strconv.ParseFloat(s, 64); err == nil {
|
||||||
|
return time.Duration(d * float64(time.Second)), nil
|
||||||
|
}
|
||||||
|
if d, err := strutil.StringToDuration(s); err == nil {
|
||||||
|
return d, nil
|
||||||
|
}
|
||||||
|
return 0, fmt.Errorf("cannot parse %q to a valid duration", s)
|
||||||
|
}
|
275
web/api/v1/api_test.go
Normal file
275
web/api/v1/api_test.go
Normal file
|
@ -0,0 +1,275 @@
|
||||||
|
package v1
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"net/url"
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
clientmodel "github.com/prometheus/client_golang/model"
|
||||||
|
|
||||||
|
"github.com/prometheus/prometheus/promql"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestEndpoints(t *testing.T) {
|
||||||
|
suite, err := promql.NewTest(t, `
|
||||||
|
load 1m
|
||||||
|
test_metric1{foo="bar"} 0+100x100
|
||||||
|
test_metric1{foo="boo"} 1+0x100
|
||||||
|
test_metric2{foo="boo"} 1+0x100
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer suite.Close()
|
||||||
|
|
||||||
|
if err := suite.Run(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
api := &API{
|
||||||
|
Storage: suite.Storage(),
|
||||||
|
QueryEngine: suite.QueryEngine(),
|
||||||
|
}
|
||||||
|
|
||||||
|
start := clientmodel.Timestamp(0)
|
||||||
|
var tests = []struct {
|
||||||
|
endpoint apiFunc
|
||||||
|
query url.Values
|
||||||
|
response interface{}
|
||||||
|
errType errorType
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
endpoint: api.query,
|
||||||
|
query: url.Values{
|
||||||
|
"query": []string{"2"},
|
||||||
|
"time": []string{"123.3"},
|
||||||
|
},
|
||||||
|
response: &queryData{
|
||||||
|
ResultType: promql.ExprScalar,
|
||||||
|
Result: &promql.Scalar{
|
||||||
|
Value: 2,
|
||||||
|
Timestamp: start.Add(123*time.Second + 300*time.Millisecond),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
endpoint: api.query,
|
||||||
|
query: url.Values{
|
||||||
|
"query": []string{"0.333"},
|
||||||
|
"time": []string{"1970-01-01T00:02:03Z"},
|
||||||
|
},
|
||||||
|
response: &queryData{
|
||||||
|
ResultType: promql.ExprScalar,
|
||||||
|
Result: &promql.Scalar{
|
||||||
|
Value: 0.333,
|
||||||
|
Timestamp: start.Add(123 * time.Second),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
endpoint: api.query,
|
||||||
|
query: url.Values{
|
||||||
|
"query": []string{"0.333"},
|
||||||
|
"time": []string{"1970-01-01T01:02:03+01:00"},
|
||||||
|
},
|
||||||
|
response: &queryData{
|
||||||
|
ResultType: promql.ExprScalar,
|
||||||
|
Result: &promql.Scalar{
|
||||||
|
Value: 0.333,
|
||||||
|
Timestamp: start.Add(123 * time.Second),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
endpoint: api.metricNames,
|
||||||
|
response: clientmodel.LabelValues{
|
||||||
|
"test_metric1",
|
||||||
|
"test_metric2",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
req, err := http.NewRequest("ANY", fmt.Sprintf("http://example.com?%s", test.query.Encode()), nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
resp, apierr := test.endpoint(req)
|
||||||
|
if apierr != nil {
|
||||||
|
if test.errType == "" {
|
||||||
|
t.Fatalf("Unexpected error: %s", apierr)
|
||||||
|
}
|
||||||
|
if test.errType != apierr.typ {
|
||||||
|
t.Fatalf("Expected error of type %q but got type %q", test.errType, apierr.typ)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if apierr == nil && test.errType != "" {
|
||||||
|
t.Fatalf("Expected error of type %q but got none", test.errType)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(resp, test.response) {
|
||||||
|
t.Fatalf("Response does not match, expected:\n%v\ngot:\n%v", test.response, resp)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRespondSuccess(t *testing.T) {
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
respond(w, "test")
|
||||||
|
|
||||||
|
if w.Code != 200 {
|
||||||
|
t.Fatalf("Return code %d expected in success response but got %d", 200, w.Code)
|
||||||
|
}
|
||||||
|
var res response
|
||||||
|
err := json.Unmarshal([]byte(w.Body.String()), &res)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if h := w.Header().Get("Content-Type"); h != "application/json" {
|
||||||
|
t.Fatalf("expected Content-Type %q but got %q", "application/json", h)
|
||||||
|
}
|
||||||
|
|
||||||
|
exp := &response{
|
||||||
|
Status: statusSuccess,
|
||||||
|
Data: "test",
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(&res, exp) {
|
||||||
|
t.Fatalf("Expected response \n%v\n but got \n%v\n", res, exp)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRespondError(t *testing.T) {
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
respondError(w, &apiError{errorTimeout, errors.New("message")}, "test")
|
||||||
|
|
||||||
|
if w.Code != 422 {
|
||||||
|
t.Fatalf("Return code %d expected in success response but got %d", 422, w.Code)
|
||||||
|
}
|
||||||
|
var res response
|
||||||
|
err := json.Unmarshal([]byte(w.Body.String()), &res)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if h := w.Header().Get("Content-Type"); h != "application/json" {
|
||||||
|
t.Fatalf("expected Content-Type %q but got %q", "application/json", h)
|
||||||
|
}
|
||||||
|
|
||||||
|
exp := &response{
|
||||||
|
Status: statusError,
|
||||||
|
Data: "test",
|
||||||
|
ErrorType: errorTimeout,
|
||||||
|
Error: "message",
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(&res, exp) {
|
||||||
|
t.Fatalf("Expected response \n%v\n but got \n%v\n", res, exp)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseTime(t *testing.T) {
|
||||||
|
ts, err := time.Parse(time.RFC3339Nano, "2015-06-03T13:21:58.555Z")
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var tests = []struct {
|
||||||
|
input string
|
||||||
|
fail bool
|
||||||
|
result time.Time
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
input: "",
|
||||||
|
fail: true,
|
||||||
|
}, {
|
||||||
|
input: "abc",
|
||||||
|
fail: true,
|
||||||
|
}, {
|
||||||
|
input: "30s",
|
||||||
|
fail: true,
|
||||||
|
}, {
|
||||||
|
input: "123",
|
||||||
|
result: time.Unix(123, 0),
|
||||||
|
}, {
|
||||||
|
input: "123.123",
|
||||||
|
result: time.Unix(123, 123000000),
|
||||||
|
}, {
|
||||||
|
input: "123.123",
|
||||||
|
result: time.Unix(123, 123000000),
|
||||||
|
}, {
|
||||||
|
input: "2015-06-03T13:21:58.555Z",
|
||||||
|
result: ts,
|
||||||
|
}, {
|
||||||
|
input: "2015-06-03T14:21:58.555+01:00",
|
||||||
|
result: ts,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
ts, err := parseTime(test.input)
|
||||||
|
if err != nil && !test.fail {
|
||||||
|
t.Errorf("Unexpected error for %q: %s", test.input, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err == nil && test.fail {
|
||||||
|
t.Errorf("Expected error for %q but got none", test.input)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
res := clientmodel.TimestampFromTime(test.result)
|
||||||
|
if !test.fail && ts != res {
|
||||||
|
t.Errorf("Expected time %v for input %q but got %v", res, test.input, ts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseDuration(t *testing.T) {
|
||||||
|
var tests = []struct {
|
||||||
|
input string
|
||||||
|
fail bool
|
||||||
|
result time.Duration
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
input: "",
|
||||||
|
fail: true,
|
||||||
|
}, {
|
||||||
|
input: "abc",
|
||||||
|
fail: true,
|
||||||
|
}, {
|
||||||
|
input: "2015-06-03T13:21:58.555Z",
|
||||||
|
fail: true,
|
||||||
|
}, {
|
||||||
|
input: "123",
|
||||||
|
result: 123 * time.Second,
|
||||||
|
}, {
|
||||||
|
input: "123.333",
|
||||||
|
result: 123*time.Second + 333*time.Millisecond,
|
||||||
|
}, {
|
||||||
|
input: "15s",
|
||||||
|
result: 15 * time.Second,
|
||||||
|
}, {
|
||||||
|
input: "5m",
|
||||||
|
result: 5 * time.Minute,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
d, err := parseDuration(test.input)
|
||||||
|
if err != nil && !test.fail {
|
||||||
|
t.Errorf("Unexpected error for %q: %s", test.input, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err == nil && test.fail {
|
||||||
|
t.Errorf("Expected error for %q but got none", test.input)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !test.fail && d != test.result {
|
||||||
|
t.Errorf("Expected duration %v for input %q but got %v", test.result, test.input, d)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
18
web/web.go
18
web/web.go
|
@ -26,13 +26,14 @@ import (
|
||||||
|
|
||||||
pprof_runtime "runtime/pprof"
|
pprof_runtime "runtime/pprof"
|
||||||
|
|
||||||
|
clientmodel "github.com/prometheus/client_golang/model"
|
||||||
"github.com/prometheus/client_golang/prometheus"
|
"github.com/prometheus/client_golang/prometheus"
|
||||||
"github.com/prometheus/log"
|
"github.com/prometheus/log"
|
||||||
|
|
||||||
|
"github.com/prometheus/prometheus/web/api/legacy"
|
||||||
|
"github.com/prometheus/prometheus/web/api/v1"
|
||||||
|
|
||||||
"github.com/prometheus/prometheus/util/route"
|
"github.com/prometheus/prometheus/util/route"
|
||||||
|
|
||||||
clientmodel "github.com/prometheus/client_golang/model"
|
|
||||||
|
|
||||||
"github.com/prometheus/prometheus/web/api"
|
|
||||||
"github.com/prometheus/prometheus/web/blob"
|
"github.com/prometheus/prometheus/web/blob"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -57,7 +58,8 @@ type WebService struct {
|
||||||
type WebServiceOptions struct {
|
type WebServiceOptions struct {
|
||||||
PathPrefix string
|
PathPrefix string
|
||||||
StatusHandler *PrometheusStatusHandler
|
StatusHandler *PrometheusStatusHandler
|
||||||
MetricsHandler *api.MetricsService
|
APILegacy *legacy.API
|
||||||
|
APIv1 *v1.API
|
||||||
AlertsHandler *AlertsHandler
|
AlertsHandler *AlertsHandler
|
||||||
ConsolesHandler *ConsolesHandler
|
ConsolesHandler *ConsolesHandler
|
||||||
GraphsHandler *GraphsHandler
|
GraphsHandler *GraphsHandler
|
||||||
|
@ -75,7 +77,7 @@ func NewWebService(o *WebServiceOptions) *WebService {
|
||||||
if o.PathPrefix != "" {
|
if o.PathPrefix != "" {
|
||||||
// If the prefix is missing for the root path, append it.
|
// If the prefix is missing for the root path, append it.
|
||||||
router.Get("/", func(w http.ResponseWriter, r *http.Request) {
|
router.Get("/", func(w http.ResponseWriter, r *http.Request) {
|
||||||
http.Redirect(w, r, o.PathPrefix, 301)
|
http.Redirect(w, r, o.PathPrefix, 302)
|
||||||
})
|
})
|
||||||
router = router.WithPrefix(o.PathPrefix)
|
router = router.WithPrefix(o.PathPrefix)
|
||||||
}
|
}
|
||||||
|
@ -89,7 +91,9 @@ func NewWebService(o *WebServiceOptions) *WebService {
|
||||||
|
|
||||||
router.Get(*metricsPath, prometheus.Handler().ServeHTTP)
|
router.Get(*metricsPath, prometheus.Handler().ServeHTTP)
|
||||||
|
|
||||||
o.MetricsHandler.RegisterHandler(router.WithPrefix("/api"))
|
o.APILegacy.Register(router.WithPrefix("/api"))
|
||||||
|
|
||||||
|
o.APIv1.Register(router.WithPrefix("/api/v1"))
|
||||||
|
|
||||||
router.Get("/consoles/*filepath", instr("consoles", o.ConsolesHandler))
|
router.Get("/consoles/*filepath", instr("consoles", o.ConsolesHandler))
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue