// Copyright 2017 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. // Package v1 provides bindings to the Prometheus HTTP API v1: // http://prometheus.io/docs/querying/api/ package v1 import ( "context" "errors" "fmt" "math" "net/http" "net/url" "strconv" "strings" "time" "unsafe" json "github.com/json-iterator/go" "github.com/prometheus/common/model" "github.com/prometheus/client_golang/api" ) func init() { json.RegisterTypeEncoderFunc("model.SamplePair", marshalSamplePairJSON, marshalJSONIsEmpty) json.RegisterTypeDecoderFunc("model.SamplePair", unmarshalSamplePairJSON) json.RegisterTypeEncoderFunc("model.SampleHistogramPair", marshalSampleHistogramPairJSON, marshalJSONIsEmpty) json.RegisterTypeDecoderFunc("model.SampleHistogramPair", unmarshalSampleHistogramPairJSON) json.RegisterTypeEncoderFunc("model.SampleStream", marshalSampleStreamJSON, marshalJSONIsEmpty) // Only needed for benchmark. json.RegisterTypeDecoderFunc("model.SampleStream", unmarshalSampleStreamJSON) // Only needed for benchmark. } func unmarshalSamplePairJSON(ptr unsafe.Pointer, iter *json.Iterator) { p := (*model.SamplePair)(ptr) if !iter.ReadArray() { iter.ReportError("unmarshal model.SamplePair", "SamplePair must be [timestamp, value]") return } t := iter.ReadNumber() if err := p.Timestamp.UnmarshalJSON([]byte(t)); err != nil { iter.ReportError("unmarshal model.SamplePair", err.Error()) return } if !iter.ReadArray() { iter.ReportError("unmarshal model.SamplePair", "SamplePair missing value") return } f, err := strconv.ParseFloat(iter.ReadString(), 64) if err != nil { iter.ReportError("unmarshal model.SamplePair", err.Error()) return } p.Value = model.SampleValue(f) if iter.ReadArray() { iter.ReportError("unmarshal model.SamplePair", "SamplePair has too many values, must be [timestamp, value]") return } } func marshalSamplePairJSON(ptr unsafe.Pointer, stream *json.Stream) { p := *((*model.SamplePair)(ptr)) stream.WriteArrayStart() marshalTimestamp(p.Timestamp, stream) stream.WriteMore() marshalFloat(float64(p.Value), stream) stream.WriteArrayEnd() } func unmarshalSampleHistogramPairJSON(ptr unsafe.Pointer, iter *json.Iterator) { p := (*model.SampleHistogramPair)(ptr) if !iter.ReadArray() { iter.ReportError("unmarshal model.SampleHistogramPair", "SampleHistogramPair must be [timestamp, {histogram}]") return } t := iter.ReadNumber() if err := p.Timestamp.UnmarshalJSON([]byte(t)); err != nil { iter.ReportError("unmarshal model.SampleHistogramPair", err.Error()) return } if !iter.ReadArray() { iter.ReportError("unmarshal model.SampleHistogramPair", "SamplePair missing histogram") return } h := &model.SampleHistogram{} p.Histogram = h for key := iter.ReadObject(); key != ""; key = iter.ReadObject() { switch key { case "count": f, err := strconv.ParseFloat(iter.ReadString(), 64) if err != nil { iter.ReportError("unmarshal model.SampleHistogramPair", "count of histogram is not a float") return } h.Count = model.FloatString(f) case "sum": f, err := strconv.ParseFloat(iter.ReadString(), 64) if err != nil { iter.ReportError("unmarshal model.SampleHistogramPair", "sum of histogram is not a float") return } h.Sum = model.FloatString(f) case "buckets": for iter.ReadArray() { b, err := unmarshalHistogramBucket(iter) if err != nil { iter.ReportError("unmarshal model.HistogramBucket", err.Error()) return } h.Buckets = append(h.Buckets, b) } default: iter.ReportError("unmarshal model.SampleHistogramPair", fmt.Sprint("unexpected key in histogram:", key)) return } } if iter.ReadArray() { iter.ReportError("unmarshal model.SampleHistogramPair", "SampleHistogramPair has too many values, must be [timestamp, {histogram}]") return } } func marshalSampleHistogramPairJSON(ptr unsafe.Pointer, stream *json.Stream) { p := *((*model.SampleHistogramPair)(ptr)) stream.WriteArrayStart() marshalTimestamp(p.Timestamp, stream) stream.WriteMore() marshalHistogram(*p.Histogram, stream) stream.WriteArrayEnd() } func unmarshalSampleStreamJSON(ptr unsafe.Pointer, iter *json.Iterator) { ss := (*model.SampleStream)(ptr) for key := iter.ReadObject(); key != ""; key = iter.ReadObject() { switch key { case "metric": metricString := iter.ReadAny().ToString() if err := json.UnmarshalFromString(metricString, &ss.Metric); err != nil { iter.ReportError("unmarshal model.SampleStream", err.Error()) return } case "values": for iter.ReadArray() { v := model.SamplePair{} unmarshalSamplePairJSON(unsafe.Pointer(&v), iter) ss.Values = append(ss.Values, v) } case "histograms": for iter.ReadArray() { h := model.SampleHistogramPair{} unmarshalSampleHistogramPairJSON(unsafe.Pointer(&h), iter) ss.Histograms = append(ss.Histograms, h) } default: iter.ReportError("unmarshal model.SampleStream", fmt.Sprint("unexpected key:", key)) return } } } func marshalSampleStreamJSON(ptr unsafe.Pointer, stream *json.Stream) { ss := *((*model.SampleStream)(ptr)) stream.WriteObjectStart() stream.WriteObjectField(`metric`) m, err := json.ConfigCompatibleWithStandardLibrary.Marshal(ss.Metric) if err != nil { stream.Error = err return } stream.SetBuffer(append(stream.Buffer(), m...)) if len(ss.Values) > 0 { stream.WriteMore() stream.WriteObjectField(`values`) stream.WriteArrayStart() for i, v := range ss.Values { if i > 0 { stream.WriteMore() } marshalSamplePairJSON(unsafe.Pointer(&v), stream) } stream.WriteArrayEnd() } if len(ss.Histograms) > 0 { stream.WriteMore() stream.WriteObjectField(`histograms`) stream.WriteArrayStart() for i, h := range ss.Histograms { if i > 0 { stream.WriteMore() } marshalSampleHistogramPairJSON(unsafe.Pointer(&h), stream) } stream.WriteArrayEnd() } stream.WriteObjectEnd() } func marshalFloat(v float64, stream *json.Stream) { stream.WriteRaw(`"`) // Taken from https://github.com/json-iterator/go/blob/master/stream_float.go#L71 as a workaround // to https://github.com/json-iterator/go/issues/365 (json-iterator, to follow json standard, doesn't allow inf/nan). buf := stream.Buffer() abs := math.Abs(v) fmt := byte('f') // Note: Must use float32 comparisons for underlying float32 value to get precise cutoffs right. if abs != 0 { if abs < 1e-6 || abs >= 1e21 { fmt = 'e' } } buf = strconv.AppendFloat(buf, v, fmt, -1, 64) stream.SetBuffer(buf) stream.WriteRaw(`"`) } func marshalTimestamp(timestamp model.Time, stream *json.Stream) { t := int64(timestamp) // Write out the timestamp as a float divided by 1000. // This is ~3x faster than converting to a float. if t < 0 { stream.WriteRaw(`-`) t = -t } stream.WriteInt64(t / 1000) fraction := t % 1000 if fraction != 0 { stream.WriteRaw(`.`) if fraction < 100 { stream.WriteRaw(`0`) } if fraction < 10 { stream.WriteRaw(`0`) } stream.WriteInt64(fraction) } } func unmarshalHistogramBucket(iter *json.Iterator) (*model.HistogramBucket, error) { b := model.HistogramBucket{} if !iter.ReadArray() { return nil, errors.New("HistogramBucket must be [boundaries, lower, upper, count]") } boundaries, err := iter.ReadNumber().Int64() if err != nil { return nil, err } b.Boundaries = int32(boundaries) if !iter.ReadArray() { return nil, errors.New("HistogramBucket must be [boundaries, lower, upper, count]") } f, err := strconv.ParseFloat(iter.ReadString(), 64) if err != nil { return nil, err } b.Lower = model.FloatString(f) if !iter.ReadArray() { return nil, errors.New("HistogramBucket must be [boundaries, lower, upper, count]") } f, err = strconv.ParseFloat(iter.ReadString(), 64) if err != nil { return nil, err } b.Upper = model.FloatString(f) if !iter.ReadArray() { return nil, errors.New("HistogramBucket must be [boundaries, lower, upper, count]") } f, err = strconv.ParseFloat(iter.ReadString(), 64) if err != nil { return nil, err } b.Count = model.FloatString(f) if iter.ReadArray() { return nil, errors.New("HistogramBucket has too many values, must be [boundaries, lower, upper, count]") } return &b, nil } // marshalHistogramBucket writes something like: [ 3, "-0.25", "0.25", "3"] // See marshalHistogram to understand what the numbers mean func marshalHistogramBucket(b model.HistogramBucket, stream *json.Stream) { stream.WriteArrayStart() stream.WriteInt32(b.Boundaries) stream.WriteMore() marshalFloat(float64(b.Lower), stream) stream.WriteMore() marshalFloat(float64(b.Upper), stream) stream.WriteMore() marshalFloat(float64(b.Count), stream) stream.WriteArrayEnd() } // marshalHistogram writes something like: // // { // "count": "42", // "sum": "34593.34", // "buckets": [ // [ 3, "-0.25", "0.25", "3"], // [ 0, "0.25", "0.5", "12"], // [ 0, "0.5", "1", "21"], // [ 0, "2", "4", "6"] // ] // } // // The 1st element in each bucket array determines if the boundaries are // inclusive (AKA closed) or exclusive (AKA open): // // 0: lower exclusive, upper inclusive // 1: lower inclusive, upper exclusive // 2: both exclusive // 3: both inclusive // // The 2nd and 3rd elements are the lower and upper boundary. The 4th element is // the bucket count. func marshalHistogram(h model.SampleHistogram, stream *json.Stream) { stream.WriteObjectStart() stream.WriteObjectField(`count`) marshalFloat(float64(h.Count), stream) stream.WriteMore() stream.WriteObjectField(`sum`) marshalFloat(float64(h.Sum), stream) bucketFound := false for _, bucket := range h.Buckets { if bucket.Count == 0 { continue // No need to expose empty buckets in JSON. } stream.WriteMore() if !bucketFound { stream.WriteObjectField(`buckets`) stream.WriteArrayStart() } bucketFound = true marshalHistogramBucket(*bucket, stream) } if bucketFound { stream.WriteArrayEnd() } stream.WriteObjectEnd() } func marshalJSONIsEmpty(ptr unsafe.Pointer) bool { return false } const ( apiPrefix = "/api/v1" epAlerts = apiPrefix + "/alerts" epAlertManagers = apiPrefix + "/alertmanagers" epQuery = apiPrefix + "/query" epQueryRange = apiPrefix + "/query_range" epQueryExemplars = apiPrefix + "/query_exemplars" epLabels = apiPrefix + "/labels" epLabelValues = apiPrefix + "/label/:name/values" epSeries = apiPrefix + "/series" epTargets = apiPrefix + "/targets" epTargetsMetadata = apiPrefix + "/targets/metadata" epMetadata = apiPrefix + "/metadata" epRules = apiPrefix + "/rules" epSnapshot = apiPrefix + "/admin/tsdb/snapshot" epDeleteSeries = apiPrefix + "/admin/tsdb/delete_series" epCleanTombstones = apiPrefix + "/admin/tsdb/clean_tombstones" epConfig = apiPrefix + "/status/config" epFlags = apiPrefix + "/status/flags" epBuildinfo = apiPrefix + "/status/buildinfo" epRuntimeinfo = apiPrefix + "/status/runtimeinfo" epTSDB = apiPrefix + "/status/tsdb" epWalReplay = apiPrefix + "/status/walreplay" ) // AlertState models the state of an alert. type AlertState string // ErrorType models the different API error types. type ErrorType string // HealthStatus models the health status of a scrape target. type HealthStatus string // RuleType models the type of a rule. type RuleType string // RuleHealth models the health status of a rule. type RuleHealth string // MetricType models the type of a metric. type MetricType string const ( // Possible values for AlertState. AlertStateFiring AlertState = "firing" AlertStateInactive AlertState = "inactive" AlertStatePending AlertState = "pending" // Possible values for ErrorType. ErrBadData ErrorType = "bad_data" ErrTimeout ErrorType = "timeout" ErrCanceled ErrorType = "canceled" ErrExec ErrorType = "execution" ErrBadResponse ErrorType = "bad_response" ErrServer ErrorType = "server_error" ErrClient ErrorType = "client_error" // Possible values for HealthStatus. HealthGood HealthStatus = "up" HealthUnknown HealthStatus = "unknown" HealthBad HealthStatus = "down" // Possible values for RuleType. RuleTypeRecording RuleType = "recording" RuleTypeAlerting RuleType = "alerting" // Possible values for RuleHealth. RuleHealthGood = "ok" RuleHealthUnknown = "unknown" RuleHealthBad = "err" // Possible values for MetricType MetricTypeCounter MetricType = "counter" MetricTypeGauge MetricType = "gauge" MetricTypeHistogram MetricType = "histogram" MetricTypeGaugeHistogram MetricType = "gaugehistogram" MetricTypeSummary MetricType = "summary" MetricTypeInfo MetricType = "info" MetricTypeStateset MetricType = "stateset" MetricTypeUnknown MetricType = "unknown" ) // Error is an error returned by the API. type Error struct { Type ErrorType Msg string Detail string } func (e *Error) Error() string { return fmt.Sprintf("%s: %s", e.Type, e.Msg) } // Range represents a sliced time range. type Range struct { // The boundaries of the time range. Start, End time.Time // The maximum time between two slices within the boundaries. Step time.Duration } // API provides bindings for Prometheus's v1 API. type API interface { // Alerts returns a list of all active alerts. Alerts(ctx context.Context) (AlertsResult, error) // AlertManagers returns an overview of the current state of the Prometheus alert manager discovery. AlertManagers(ctx context.Context) (AlertManagersResult, error) // CleanTombstones removes the deleted data from disk and cleans up the existing tombstones. CleanTombstones(ctx context.Context) error // Config returns the current Prometheus configuration. Config(ctx context.Context) (ConfigResult, error) // DeleteSeries deletes data for a selection of series in a time range. DeleteSeries(ctx context.Context, matches []string, startTime, endTime time.Time) error // Flags returns the flag values that Prometheus was launched with. Flags(ctx context.Context) (FlagsResult, error) // LabelNames returns the unique label names present in the block in sorted order by given time range and matchers. LabelNames(ctx context.Context, matches []string, startTime, endTime time.Time) ([]string, Warnings, error) // LabelValues performs a query for the values of the given label, time range and matchers. LabelValues(ctx context.Context, label string, matches []string, startTime, endTime time.Time) (model.LabelValues, Warnings, error) // Query performs a query for the given time. Query(ctx context.Context, query string, ts time.Time, opts ...Option) (model.Value, Warnings, error) // QueryRange performs a query for the given range. QueryRange(ctx context.Context, query string, r Range, opts ...Option) (model.Value, Warnings, error) // QueryExemplars performs a query for exemplars by the given query and time range. QueryExemplars(ctx context.Context, query string, startTime, endTime time.Time) ([]ExemplarQueryResult, error) // Buildinfo returns various build information properties about the Prometheus server Buildinfo(ctx context.Context) (BuildinfoResult, error) // Runtimeinfo returns the various runtime information properties about the Prometheus server. Runtimeinfo(ctx context.Context) (RuntimeinfoResult, error) // Series finds series by label matchers. Series(ctx context.Context, matches []string, startTime, endTime time.Time) ([]model.LabelSet, Warnings, error) // Snapshot creates a snapshot of all current data into snapshots/- // under the TSDB's data directory and returns the directory as response. Snapshot(ctx context.Context, skipHead bool) (SnapshotResult, error) // Rules returns a list of alerting and recording rules that are currently loaded. Rules(ctx context.Context) (RulesResult, error) // Targets returns an overview of the current state of the Prometheus target discovery. Targets(ctx context.Context) (TargetsResult, error) // TargetsMetadata returns metadata about metrics currently scraped by the target. TargetsMetadata(ctx context.Context, matchTarget, metric, limit string) ([]MetricMetadata, error) // Metadata returns metadata about metrics currently scraped by the metric name. Metadata(ctx context.Context, metric, limit string) (map[string][]Metadata, error) // TSDB returns the cardinality statistics. TSDB(ctx context.Context) (TSDBResult, error) // WalReplay returns the current replay status of the wal. WalReplay(ctx context.Context) (WalReplayStatus, error) } // AlertsResult contains the result from querying the alerts endpoint. type AlertsResult struct { Alerts []Alert `json:"alerts"` } // AlertManagersResult contains the result from querying the alertmanagers endpoint. type AlertManagersResult struct { Active []AlertManager `json:"activeAlertManagers"` Dropped []AlertManager `json:"droppedAlertManagers"` } // AlertManager models a configured Alert Manager. type AlertManager struct { URL string `json:"url"` } // ConfigResult contains the result from querying the config endpoint. type ConfigResult struct { YAML string `json:"yaml"` } // FlagsResult contains the result from querying the flag endpoint. type FlagsResult map[string]string // BuildinfoResult contains the results from querying the buildinfo endpoint. type BuildinfoResult struct { Version string `json:"version"` Revision string `json:"revision"` Branch string `json:"branch"` BuildUser string `json:"buildUser"` BuildDate string `json:"buildDate"` GoVersion string `json:"goVersion"` } // RuntimeinfoResult contains the result from querying the runtimeinfo endpoint. type RuntimeinfoResult struct { StartTime time.Time `json:"startTime"` CWD string `json:"CWD"` ReloadConfigSuccess bool `json:"reloadConfigSuccess"` LastConfigTime time.Time `json:"lastConfigTime"` CorruptionCount int `json:"corruptionCount"` GoroutineCount int `json:"goroutineCount"` GOMAXPROCS int `json:"GOMAXPROCS"` GOGC string `json:"GOGC"` GODEBUG string `json:"GODEBUG"` StorageRetention string `json:"storageRetention"` } // SnapshotResult contains the result from querying the snapshot endpoint. type SnapshotResult struct { Name string `json:"name"` } // RulesResult contains the result from querying the rules endpoint. type RulesResult struct { Groups []RuleGroup `json:"groups"` } // RuleGroup models a rule group that contains a set of recording and alerting rules. type RuleGroup struct { Name string `json:"name"` File string `json:"file"` Interval float64 `json:"interval"` Rules Rules `json:"rules"` } // Recording and alerting rules are stored in the same slice to preserve the order // that rules are returned in by the API. // // Rule types can be determined using a type switch: // // switch v := rule.(type) { // case RecordingRule: // fmt.Print("got a recording rule") // case AlertingRule: // fmt.Print("got a alerting rule") // default: // fmt.Printf("unknown rule type %s", v) // } type Rules []interface{} // AlertingRule models a alerting rule. type AlertingRule struct { Name string `json:"name"` Query string `json:"query"` Duration float64 `json:"duration"` Labels model.LabelSet `json:"labels"` Annotations model.LabelSet `json:"annotations"` Alerts []*Alert `json:"alerts"` Health RuleHealth `json:"health"` LastError string `json:"lastError,omitempty"` EvaluationTime float64 `json:"evaluationTime"` LastEvaluation time.Time `json:"lastEvaluation"` State string `json:"state"` } // RecordingRule models a recording rule. type RecordingRule struct { Name string `json:"name"` Query string `json:"query"` Labels model.LabelSet `json:"labels,omitempty"` Health RuleHealth `json:"health"` LastError string `json:"lastError,omitempty"` EvaluationTime float64 `json:"evaluationTime"` LastEvaluation time.Time `json:"lastEvaluation"` } // Alert models an active alert. type Alert struct { ActiveAt time.Time `json:"activeAt"` Annotations model.LabelSet Labels model.LabelSet State AlertState Value string } // TargetsResult contains the result from querying the targets endpoint. type TargetsResult struct { Active []ActiveTarget `json:"activeTargets"` Dropped []DroppedTarget `json:"droppedTargets"` } // ActiveTarget models an active Prometheus scrape target. type ActiveTarget struct { DiscoveredLabels map[string]string `json:"discoveredLabels"` Labels model.LabelSet `json:"labels"` ScrapePool string `json:"scrapePool"` ScrapeURL string `json:"scrapeUrl"` GlobalURL string `json:"globalUrl"` LastError string `json:"lastError"` LastScrape time.Time `json:"lastScrape"` LastScrapeDuration float64 `json:"lastScrapeDuration"` Health HealthStatus `json:"health"` } // DroppedTarget models a dropped Prometheus scrape target. type DroppedTarget struct { DiscoveredLabels map[string]string `json:"discoveredLabels"` } // MetricMetadata models the metadata of a metric with its scrape target and name. type MetricMetadata struct { Target map[string]string `json:"target"` Metric string `json:"metric,omitempty"` Type MetricType `json:"type"` Help string `json:"help"` Unit string `json:"unit"` } // Metadata models the metadata of a metric. type Metadata struct { Type MetricType `json:"type"` Help string `json:"help"` Unit string `json:"unit"` } // queryResult contains result data for a query. type queryResult struct { Type model.ValueType `json:"resultType"` Result interface{} `json:"result"` // The decoded value. v model.Value } // TSDBResult contains the result from querying the tsdb endpoint. type TSDBResult struct { HeadStats TSDBHeadStats `json:"headStats"` SeriesCountByMetricName []Stat `json:"seriesCountByMetricName"` LabelValueCountByLabelName []Stat `json:"labelValueCountByLabelName"` MemoryInBytesByLabelName []Stat `json:"memoryInBytesByLabelName"` SeriesCountByLabelValuePair []Stat `json:"seriesCountByLabelValuePair"` } // TSDBHeadStats contains TSDB stats type TSDBHeadStats struct { NumSeries int `json:"numSeries"` NumLabelPairs int `json:"numLabelPairs"` ChunkCount int `json:"chunkCount"` MinTime int `json:"minTime"` MaxTime int `json:"maxTime"` } // WalReplayStatus represents the wal replay status. type WalReplayStatus struct { Min int `json:"min"` Max int `json:"max"` Current int `json:"current"` } // Stat models information about statistic value. type Stat struct { Name string `json:"name"` Value uint64 `json:"value"` } func (rg *RuleGroup) UnmarshalJSON(b []byte) error { v := struct { Name string `json:"name"` File string `json:"file"` Interval float64 `json:"interval"` Rules []json.RawMessage `json:"rules"` }{} if err := json.Unmarshal(b, &v); err != nil { return err } rg.Name = v.Name rg.File = v.File rg.Interval = v.Interval for _, rule := range v.Rules { alertingRule := AlertingRule{} if err := json.Unmarshal(rule, &alertingRule); err == nil { rg.Rules = append(rg.Rules, alertingRule) continue } recordingRule := RecordingRule{} if err := json.Unmarshal(rule, &recordingRule); err == nil { rg.Rules = append(rg.Rules, recordingRule) continue } return errors.New("failed to decode JSON into an alerting or recording rule") } return nil } func (r *AlertingRule) UnmarshalJSON(b []byte) error { v := struct { Type string `json:"type"` }{} if err := json.Unmarshal(b, &v); err != nil { return err } if v.Type == "" { return errors.New("type field not present in rule") } if v.Type != string(RuleTypeAlerting) { return fmt.Errorf("expected rule of type %s but got %s", string(RuleTypeAlerting), v.Type) } rule := struct { Name string `json:"name"` Query string `json:"query"` Duration float64 `json:"duration"` Labels model.LabelSet `json:"labels"` Annotations model.LabelSet `json:"annotations"` Alerts []*Alert `json:"alerts"` Health RuleHealth `json:"health"` LastError string `json:"lastError,omitempty"` EvaluationTime float64 `json:"evaluationTime"` LastEvaluation time.Time `json:"lastEvaluation"` State string `json:"state"` }{} if err := json.Unmarshal(b, &rule); err != nil { return err } r.Health = rule.Health r.Annotations = rule.Annotations r.Name = rule.Name r.Query = rule.Query r.Alerts = rule.Alerts r.Duration = rule.Duration r.Labels = rule.Labels r.LastError = rule.LastError r.EvaluationTime = rule.EvaluationTime r.LastEvaluation = rule.LastEvaluation r.State = rule.State return nil } func (r *RecordingRule) UnmarshalJSON(b []byte) error { v := struct { Type string `json:"type"` }{} if err := json.Unmarshal(b, &v); err != nil { return err } if v.Type == "" { return errors.New("type field not present in rule") } if v.Type != string(RuleTypeRecording) { return fmt.Errorf("expected rule of type %s but got %s", string(RuleTypeRecording), v.Type) } rule := struct { Name string `json:"name"` Query string `json:"query"` Labels model.LabelSet `json:"labels,omitempty"` Health RuleHealth `json:"health"` LastError string `json:"lastError,omitempty"` EvaluationTime float64 `json:"evaluationTime"` LastEvaluation time.Time `json:"lastEvaluation"` }{} if err := json.Unmarshal(b, &rule); err != nil { return err } r.Health = rule.Health r.Labels = rule.Labels r.Name = rule.Name r.LastError = rule.LastError r.Query = rule.Query r.EvaluationTime = rule.EvaluationTime r.LastEvaluation = rule.LastEvaluation return nil } func (qr *queryResult) UnmarshalJSON(b []byte) error { v := struct { Type model.ValueType `json:"resultType"` Result json.RawMessage `json:"result"` }{} err := json.Unmarshal(b, &v) if err != nil { return err } switch v.Type { case model.ValScalar: var sv model.Scalar err = json.Unmarshal(v.Result, &sv) qr.v = &sv case model.ValVector: var vv model.Vector err = json.Unmarshal(v.Result, &vv) qr.v = vv case model.ValMatrix: var mv model.Matrix err = json.Unmarshal(v.Result, &mv) qr.v = mv default: err = fmt.Errorf("unexpected value type %q", v.Type) } return err } // Exemplar is additional information associated with a time series. type Exemplar struct { Labels model.LabelSet `json:"labels"` Value model.SampleValue `json:"value"` Timestamp model.Time `json:"timestamp"` } type ExemplarQueryResult struct { SeriesLabels model.LabelSet `json:"seriesLabels"` Exemplars []Exemplar `json:"exemplars"` } // NewAPI returns a new API for the client. // // It is safe to use the returned API from multiple goroutines. func NewAPI(c api.Client) API { return &httpAPI{ client: &apiClientImpl{ client: c, }, } } type httpAPI struct { client apiClient } func (h *httpAPI) Alerts(ctx context.Context) (AlertsResult, error) { u := h.client.URL(epAlerts, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return AlertsResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return AlertsResult{}, err } var res AlertsResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) AlertManagers(ctx context.Context) (AlertManagersResult, error) { u := h.client.URL(epAlertManagers, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return AlertManagersResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return AlertManagersResult{}, err } var res AlertManagersResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) CleanTombstones(ctx context.Context) error { u := h.client.URL(epCleanTombstones, nil) req, err := http.NewRequest(http.MethodPost, u.String(), nil) if err != nil { return err } _, _, _, err = h.client.Do(ctx, req) return err } func (h *httpAPI) Config(ctx context.Context) (ConfigResult, error) { u := h.client.URL(epConfig, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return ConfigResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return ConfigResult{}, err } var res ConfigResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) DeleteSeries(ctx context.Context, matches []string, startTime, endTime time.Time) error { u := h.client.URL(epDeleteSeries, nil) q := u.Query() for _, m := range matches { q.Add("match[]", m) } q.Set("start", formatTime(startTime)) q.Set("end", formatTime(endTime)) u.RawQuery = q.Encode() req, err := http.NewRequest(http.MethodPost, u.String(), nil) if err != nil { return err } _, _, _, err = h.client.Do(ctx, req) return err } func (h *httpAPI) Flags(ctx context.Context) (FlagsResult, error) { u := h.client.URL(epFlags, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return FlagsResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return FlagsResult{}, err } var res FlagsResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) Buildinfo(ctx context.Context) (BuildinfoResult, error) { u := h.client.URL(epBuildinfo, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return BuildinfoResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return BuildinfoResult{}, err } var res BuildinfoResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) Runtimeinfo(ctx context.Context) (RuntimeinfoResult, error) { u := h.client.URL(epRuntimeinfo, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return RuntimeinfoResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return RuntimeinfoResult{}, err } var res RuntimeinfoResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) LabelNames(ctx context.Context, matches []string, startTime, endTime time.Time) ([]string, Warnings, error) { u := h.client.URL(epLabels, nil) q := u.Query() q.Set("start", formatTime(startTime)) q.Set("end", formatTime(endTime)) for _, m := range matches { q.Add("match[]", m) } u.RawQuery = q.Encode() req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return nil, nil, err } _, body, w, err := h.client.Do(ctx, req) if err != nil { return nil, w, err } var labelNames []string return labelNames, w, json.Unmarshal(body, &labelNames) } func (h *httpAPI) LabelValues(ctx context.Context, label string, matches []string, startTime, endTime time.Time) (model.LabelValues, Warnings, error) { u := h.client.URL(epLabelValues, map[string]string{"name": label}) q := u.Query() q.Set("start", formatTime(startTime)) q.Set("end", formatTime(endTime)) for _, m := range matches { q.Add("match[]", m) } u.RawQuery = q.Encode() req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return nil, nil, err } _, body, w, err := h.client.Do(ctx, req) if err != nil { return nil, w, err } var labelValues model.LabelValues return labelValues, w, json.Unmarshal(body, &labelValues) } type apiOptions struct { timeout time.Duration } type Option func(c *apiOptions) // WithTimeout can be used to provide an optional query evaluation timeout for Query and QueryRange. // https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries func WithTimeout(timeout time.Duration) Option { return func(o *apiOptions) { o.timeout = timeout } } func (h *httpAPI) Query(ctx context.Context, query string, ts time.Time, opts ...Option) (model.Value, Warnings, error) { u := h.client.URL(epQuery, nil) q := u.Query() opt := &apiOptions{} for _, o := range opts { o(opt) } d := opt.timeout if d > 0 { q.Set("timeout", d.String()) } q.Set("query", query) if !ts.IsZero() { q.Set("time", formatTime(ts)) } _, body, warnings, err := h.client.DoGetFallback(ctx, u, q) if err != nil { return nil, warnings, err } var qres queryResult return qres.v, warnings, json.Unmarshal(body, &qres) } func (h *httpAPI) QueryRange(ctx context.Context, query string, r Range, opts ...Option) (model.Value, Warnings, error) { u := h.client.URL(epQueryRange, nil) q := u.Query() q.Set("query", query) q.Set("start", formatTime(r.Start)) q.Set("end", formatTime(r.End)) q.Set("step", strconv.FormatFloat(r.Step.Seconds(), 'f', -1, 64)) opt := &apiOptions{} for _, o := range opts { o(opt) } d := opt.timeout if d > 0 { q.Set("timeout", d.String()) } _, body, warnings, err := h.client.DoGetFallback(ctx, u, q) if err != nil { return nil, warnings, err } var qres queryResult return qres.v, warnings, json.Unmarshal(body, &qres) } func (h *httpAPI) Series(ctx context.Context, matches []string, startTime, endTime time.Time) ([]model.LabelSet, Warnings, error) { u := h.client.URL(epSeries, nil) q := u.Query() for _, m := range matches { q.Add("match[]", m) } q.Set("start", formatTime(startTime)) q.Set("end", formatTime(endTime)) u.RawQuery = q.Encode() req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return nil, nil, err } _, body, warnings, err := h.client.Do(ctx, req) if err != nil { return nil, warnings, err } var mset []model.LabelSet return mset, warnings, json.Unmarshal(body, &mset) } func (h *httpAPI) Snapshot(ctx context.Context, skipHead bool) (SnapshotResult, error) { u := h.client.URL(epSnapshot, nil) q := u.Query() q.Set("skip_head", strconv.FormatBool(skipHead)) u.RawQuery = q.Encode() req, err := http.NewRequest(http.MethodPost, u.String(), nil) if err != nil { return SnapshotResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return SnapshotResult{}, err } var res SnapshotResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) Rules(ctx context.Context) (RulesResult, error) { u := h.client.URL(epRules, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return RulesResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return RulesResult{}, err } var res RulesResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) Targets(ctx context.Context) (TargetsResult, error) { u := h.client.URL(epTargets, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return TargetsResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return TargetsResult{}, err } var res TargetsResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) TargetsMetadata(ctx context.Context, matchTarget, metric, limit string) ([]MetricMetadata, error) { u := h.client.URL(epTargetsMetadata, nil) q := u.Query() q.Set("match_target", matchTarget) q.Set("metric", metric) q.Set("limit", limit) u.RawQuery = q.Encode() req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return nil, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return nil, err } var res []MetricMetadata return res, json.Unmarshal(body, &res) } func (h *httpAPI) Metadata(ctx context.Context, metric, limit string) (map[string][]Metadata, error) { u := h.client.URL(epMetadata, nil) q := u.Query() q.Set("metric", metric) q.Set("limit", limit) u.RawQuery = q.Encode() req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return nil, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return nil, err } var res map[string][]Metadata return res, json.Unmarshal(body, &res) } func (h *httpAPI) TSDB(ctx context.Context) (TSDBResult, error) { u := h.client.URL(epTSDB, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return TSDBResult{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return TSDBResult{}, err } var res TSDBResult return res, json.Unmarshal(body, &res) } func (h *httpAPI) WalReplay(ctx context.Context) (WalReplayStatus, error) { u := h.client.URL(epWalReplay, nil) req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return WalReplayStatus{}, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return WalReplayStatus{}, err } var res WalReplayStatus return res, json.Unmarshal(body, &res) } func (h *httpAPI) QueryExemplars(ctx context.Context, query string, startTime, endTime time.Time) ([]ExemplarQueryResult, error) { u := h.client.URL(epQueryExemplars, nil) q := u.Query() q.Set("query", query) q.Set("start", formatTime(startTime)) q.Set("end", formatTime(endTime)) u.RawQuery = q.Encode() req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return nil, err } _, body, _, err := h.client.Do(ctx, req) if err != nil { return nil, err } var res []ExemplarQueryResult return res, json.Unmarshal(body, &res) } // Warnings is an array of non critical errors type Warnings []string // apiClient wraps a regular client and processes successful API responses. // Successful also includes responses that errored at the API level. type apiClient interface { URL(ep string, args map[string]string) *url.URL Do(context.Context, *http.Request) (*http.Response, []byte, Warnings, error) DoGetFallback(ctx context.Context, u *url.URL, args url.Values) (*http.Response, []byte, Warnings, error) } type apiClientImpl struct { client api.Client } type apiResponse struct { Status string `json:"status"` Data json.RawMessage `json:"data"` ErrorType ErrorType `json:"errorType"` Error string `json:"error"` Warnings []string `json:"warnings,omitempty"` } func apiError(code int) bool { // These are the codes that Prometheus sends when it returns an error. return code == http.StatusUnprocessableEntity || code == http.StatusBadRequest } func errorTypeAndMsgFor(resp *http.Response) (ErrorType, string) { switch resp.StatusCode / 100 { case 4: return ErrClient, fmt.Sprintf("client error: %d", resp.StatusCode) case 5: return ErrServer, fmt.Sprintf("server error: %d", resp.StatusCode) } return ErrBadResponse, fmt.Sprintf("bad response code %d", resp.StatusCode) } func (h *apiClientImpl) URL(ep string, args map[string]string) *url.URL { return h.client.URL(ep, args) } func (h *apiClientImpl) Do(ctx context.Context, req *http.Request) (*http.Response, []byte, Warnings, error) { resp, body, err := h.client.Do(ctx, req) if err != nil { return resp, body, nil, err } code := resp.StatusCode if code/100 != 2 && !apiError(code) { errorType, errorMsg := errorTypeAndMsgFor(resp) return resp, body, nil, &Error{ Type: errorType, Msg: errorMsg, Detail: string(body), } } var result apiResponse if http.StatusNoContent != code { if jsonErr := json.Unmarshal(body, &result); jsonErr != nil { return resp, body, nil, &Error{ Type: ErrBadResponse, Msg: jsonErr.Error(), } } } if apiError(code) && result.Status == "success" { err = &Error{ Type: ErrBadResponse, Msg: "inconsistent body for response code", } } if result.Status == "error" { err = &Error{ Type: result.ErrorType, Msg: result.Error, } } return resp, []byte(result.Data), result.Warnings, err } // DoGetFallback will attempt to do the request as-is, and on a 405 or 501 it // will fallback to a GET request. func (h *apiClientImpl) DoGetFallback(ctx context.Context, u *url.URL, args url.Values) (*http.Response, []byte, Warnings, error) { encodedArgs := args.Encode() req, err := http.NewRequest(http.MethodPost, u.String(), strings.NewReader(encodedArgs)) if err != nil { return nil, nil, nil, err } req.Header.Set("Content-Type", "application/x-www-form-urlencoded") // Following comment originates from https://pkg.go.dev/net/http#Transport // Transport only retries a request upon encountering a network error if the request is // idempotent and either has no body or has its Request.GetBody defined. HTTP requests // are considered idempotent if they have HTTP methods GET, HEAD, OPTIONS, or TRACE; or // if their Header map contains an "Idempotency-Key" or "X-Idempotency-Key" entry. If the // idempotency key value is a zero-length slice, the request is treated as idempotent but // the header is not sent on the wire. req.Header["Idempotency-Key"] = nil resp, body, warnings, err := h.Do(ctx, req) if resp != nil && (resp.StatusCode == http.StatusMethodNotAllowed || resp.StatusCode == http.StatusNotImplemented) { u.RawQuery = encodedArgs req, err = http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return nil, nil, warnings, err } return h.Do(ctx, req) } return resp, body, warnings, err } func formatTime(t time.Time) string { return strconv.FormatFloat(float64(t.Unix())+float64(t.Nanosecond())/1e9, 'f', -1, 64) }