mhoppa commented on a change in pull request #3758: Rewrote deliveryservice_stats to Go URL: https://github.com/apache/trafficcontrol/pull/3758#discussion_r328805194
########## File path: traffic_ops/traffic_ops_golang/trafficstats/trafficstats.go ########## @@ -0,0 +1,691 @@ +package trafficstats + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import "database/sql" +import "encoding/json" +import "errors" +import "fmt" +import "net/http" +import "strconv" +import "strings" +import "time" + +import "github.com/apache/trafficcontrol/lib/go-tc" +import "github.com/apache/trafficcontrol/lib/go-rfc" +import "github.com/apache/trafficcontrol/lib/go-log" +import "github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/api" +import "github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/tenant" + +import influx "github.com/influxdata/influxdb1-client/v2" + +const DEFAULT_INTERVAL = tc.TrafficStatsDuration("1m") + +var metricTypes = map[string]interface{}{ + "kbps": struct{}{}, + "tps_total": struct{}{}, + "tps_2xx": struct{}{}, + "tps_3xx": struct{}{}, + "tps_4xx": struct{}{}, + "tps_5xx": struct{}{}, +} + +var jsonWithRFCTimestamps = rfc.MimeType{ + "application/json", + map[string]string{"timestamp": "rfc"}, +} + +var jsonWithUnixTimestamps = rfc.MimeType{ + "application/json", + map[string]string{"timestamp": "unix"}, +} + +type APIResponse struct { + Response tc.TrafficStatsResponse `json:"response"` +} + +const dsTenantIDFromXMLIDQuery = ` + SELECT tenant_id + FROM deliveryservice + WHERE xml_id = $1` + +const xmlidFromIDQuery = ` + SELECT xml_id + FROM deliveryservice + WHERE id = $1` + +// TODO: Pretty sure all of this could actually be calculated using the fetched data (assuming an +// interval is given). Check to see if that's faster than doing another synchronous HTTP request. +const summaryQuery = ` + SELECT mean(value) AS "average", + percentile(value, 5) AS "fifthPercentile", + percentile(value, 95) AS "ninetyFifthPercentile", + percentile(value, 98) AS "ninetyEighthPercentile", + min(value) AS "min", + max(value) AS "max", + count(value) AS "count" + FROM "%s"."monthly"."%s.ds.1min" + WHERE time >= $start + AND time <= $end + AND cachegroup = 'total' + AND deliveryservice = $xmlid` + +const seriesQuery = ` + SELECT mean(value) AS "value" + FROM "%s"."monthly"."%s.ds.1min" + WHERE cachegroup = 'total' + AND deliveryservice = $xmlid + AND time >= $start + AND time <= $end + GROUP BY time(%s, %s), cachegroup%s` + +type orderable string + +const ( + timeOrder orderable = "time" + valueOrder orderable = "value" +) + +func orderableFromString(v string) *orderable { + var o orderable + switch v { + case "time": + o = timeOrder + case "value": + o = valueOrder + default: + return nil + } + return &o +} + +type config struct { + DeliveryService string + End time.Time + ExcludeSeries bool + ExcludeSummary bool + Interval tc.TrafficStatsDuration + Limit *uint64 + MetricType string + Offset *uint64 + OrderBy *orderable + Start time.Time + Unix bool +} + +func configFromRequest(r *http.Request, i *api.APIInfo) (c config, e error, code int) { + code = http.StatusBadRequest // this is so common I may as well do it right away + + if accept := r.Header.Get("Accept"); accept != "" { + + mimes, err := rfc.MimeTypesFromAccept(accept) + if err != nil { + log.Warnf("Failed to negotiate content, Accept line '%s', error: %v", accept, err) + } else { + + found := false + for _, m := range mimes { + if jsonWithRFCTimestamps.Equal(m) { + found = true + break + } + + if jsonWithUnixTimestamps.Equal(m) { + found = true + c.Unix = true + break + } + } + + if !found { + e = fmt.Errorf("Failed to negotiate content; cannot produce output satisfying %s", accept) + code = http.StatusNotAcceptable + return + } + } + } + + if limit, ok := i.Params["limit"]; ok { + lim, err := strconv.ParseUint(limit, 10, 64) + if err != nil { + e = errors.New("Invalid limit!") + return + } + c.Limit = &lim + } + + if offset, ok := i.Params["offset"]; ok { + off, err := strconv.ParseUint(offset, 10, 64) + if err != nil { + e = errors.New("Invalid offset!") + return + } + c.Offset = &off + } + + if orderby, ok := i.Params["orderby"]; ok { + if c.OrderBy = orderableFromString(orderby); c.OrderBy == nil { + e = errors.New("Invalid orderby!") + return + } + } + + if c.Start, e = parseTime(i.Params["startDate"]); e != nil { + log.Errorf("Parsing startDate: %v", e) + e = errors.New("Invalid startDate!") + return + } + + if c.End, e = parseTime(i.Params["endDate"]); e != nil { + log.Errorf("Parsing endDate: %v", e) + e = errors.New("Invalid endDate!") + return + } + + if interval, ok := i.Params["interval"]; !ok { + c.Interval = DEFAULT_INTERVAL + } else if c.Interval = tc.TrafficStatsDurationFromString(interval); c.Interval == tc.InvalidDuration { + log.Errorf("Error parsing 'interval' query parameter: %v", e) + e = errors.New("Invalid interval!") + return + } + + if ex, ok := i.Params["exclude"]; ok { + switch ex { + case "series": + c.ExcludeSeries = true + case "summary": + c.ExcludeSummary = true + default: + e = errors.New("Invalid exclude! Must be 'series' or 'summary'") + return + } + } + + c.MetricType = i.Params["metricType"] + if _, ok := metricTypes[c.MetricType]; !ok { + e = fmt.Errorf("Unknown metric type: %s", c.MetricType) + return + } + + var ok bool + if c.DeliveryService, ok = i.Params["deliveryServiceName"]; !ok { + if c.DeliveryService, ok = i.Params["deliveryService"]; !ok { + e = errors.New("You must specify deliveryService or deliveryServiceName!") + return + } + + if dsID, err := strconv.ParseUint(c.DeliveryService, 10, 64); err != nil { + // sql.ErrNoRows does not *necessarily* mean the DS doesn't exist - an XMLID can simply + // be numeric, and so it was wrong to treat it as an ID in the first place. + xmlid := c.DeliveryService + if c.DeliveryService, err = getXMLIDFromID(dsID, i.Tx.Tx); err != nil && err != sql.ErrNoRows { + log.Errorf("Converting DSID to XMLID: %v", err) + e = errors.New("Internal Server Error") + code = http.StatusInternalServerError + return + } else if err == sql.ErrNoRows { + c.DeliveryService = xmlid + } + } + } + + code = http.StatusOK + return +} + +func GetDSStats(w http.ResponseWriter, r *http.Request) { + // Perl didn't require "interval", but it would only return summary data if it was not given + inf, userErr, sysErr, errCode := api.NewInfo(r, []string{"metricType", "startDate", "endDate"}, nil) + tx := inf.Tx.Tx + if userErr != nil || sysErr != nil { + api.HandleErr(w, r, tx, errCode, userErr, sysErr) + return + } + defer inf.Close() + + var c config + if c, userErr, errCode = configFromRequest(r, inf); userErr != nil { + sysErr = fmt.Errorf("Unable to process deliveryservice_stats request: %v", userErr) + api.HandleErr(w, r, tx, errCode, userErr, sysErr) + return + } + + client, err := inf.CreateInfluxClient() + if err != nil { + if err == sql.ErrNoRows { + errCode = http.StatusServiceUnavailable + userErr = errors.New("No InfluxDB servers available!") + sysErr = userErr + } else { + errCode = http.StatusInternalServerError + userErr = nil + sysErr = err + } + api.HandleErr(w, r, tx, errCode, userErr, sysErr) + return + } else if client == nil { + userErr = errors.New("Traffic Stats is not configured!") + sysErr = userErr + errCode = http.StatusServiceUnavailable + api.HandleErr(w, r, tx, errCode, userErr, sysErr) + return + } + defer (*client).Close() + + var dsTenant uint + if dsTenant, err = dsTenantIDFromXMLID(c.DeliveryService, tx); err != nil { + sysErr = err + + if err == sql.ErrNoRows { + userErr = fmt.Errorf("No such Delivery Service: %s", c.DeliveryService) + errCode = http.StatusNotFound + } else { + errCode = http.StatusInternalServerError + } + + api.HandleErr(w, r, tx, errCode, userErr, sysErr) + return + } + + authorized, err := tenant.IsResourceAuthorizedToUserTx(int(dsTenant), inf.User, tx) + if err != nil { + api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) + return + } else if !authorized { + // If the Tenant is not authorized to use the resource, then we DON'T tell them that. + // Instead, we don't disclose that such a Delivery Service exists at all - in keeping with + // the behavior of /deliveryservices + // This is different from what Perl used to do, but then again Perl didn't check tenancy at + // all. + userErr = fmt.Errorf("No such Delivery Service: %s", c.DeliveryService) + sysErr = fmt.Errorf("GetDSStats: unauthorized Tenant (#%d) access", inf.User.TenantID) + errCode = http.StatusNotFound + api.HandleErr(w, r, tx, errCode, userErr, sysErr) + return + } + + var errBuilder strings.Builder + resp := APIResponse{ + tc.TrafficStatsResponse{ + Source: tc.TRAFFIC_STATS_SOURCE, + Version: tc.TRAFFIC_STATS_VERSION, + Series: nil, + Summary: nil, + }, + } + + // TODO: as above, this could be done on TO itself, thus sending only one synchronous request + // per hit on this endpoint, rather than the current two. Not sure if that's worth it for large + // data sets, though. + if !c.ExcludeSummary { + summary, messages, err := getSummary(client, &c, inf.Config.ConfigInflux.DSDBName) + + errBuilder := strings.Builder{} + if messages != nil && len(messages) > 0 { + errBuilder.Write([]byte("Messages: [")) + for _, m := range messages { + errBuilder.WriteString(m.Level) + errBuilder.WriteRune(':') + errBuilder.WriteString(m.Text) + errBuilder.Write([]byte(", ")) + } + errBuilder.WriteRune(']') + } + + if err != nil { + sysErr = fmt.Errorf("Getting summary response from Influx: %v - %s", err, errBuilder.String()) + api.HandleErr(w, r, tx, http.StatusBadGateway, nil, sysErr) Review comment: is it ? do we return 502 on mysql errors? The user is not really asking you to proxy the request anywhere or understand if you are or not. Per the API contract the user is just asking for stats on delivery services and expects a certain return structure. I have not worked with or on an API when it returns a 502 when it gets a bad response or can not connect to a backend db ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
