stackdriver.go 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. package stackdriver
  2. import (
  3. "context"
  4. "encoding/json"
  5. "errors"
  6. "fmt"
  7. "io/ioutil"
  8. "math"
  9. "net/http"
  10. "net/url"
  11. "path"
  12. "regexp"
  13. "strconv"
  14. "strings"
  15. "time"
  16. "golang.org/x/net/context/ctxhttp"
  17. "github.com/grafana/grafana/pkg/api/pluginproxy"
  18. "github.com/grafana/grafana/pkg/components/null"
  19. "github.com/grafana/grafana/pkg/components/simplejson"
  20. "github.com/grafana/grafana/pkg/log"
  21. "github.com/grafana/grafana/pkg/models"
  22. "github.com/grafana/grafana/pkg/plugins"
  23. "github.com/grafana/grafana/pkg/setting"
  24. "github.com/grafana/grafana/pkg/tsdb"
  25. "github.com/opentracing/opentracing-go"
  26. )
  27. var slog log.Logger
  28. // StackdriverExecutor executes queries for the Stackdriver datasource
  29. type StackdriverExecutor struct {
  30. httpClient *http.Client
  31. dsInfo *models.DataSource
  32. }
  33. // NewStackdriverExecutor initializes a http client
  34. func NewStackdriverExecutor(dsInfo *models.DataSource) (tsdb.TsdbQueryEndpoint, error) {
  35. httpClient, err := dsInfo.GetHttpClient()
  36. if err != nil {
  37. return nil, err
  38. }
  39. return &StackdriverExecutor{
  40. httpClient: httpClient,
  41. dsInfo: dsInfo,
  42. }, nil
  43. }
  44. func init() {
  45. slog = log.New("tsdb.stackdriver")
  46. tsdb.RegisterTsdbQueryEndpoint("stackdriver", NewStackdriverExecutor)
  47. }
  48. // Query takes in the frontend queries, parses them into the Stackdriver query format
  49. // executes the queries against the Stackdriver API and parses the response into
  50. // the time series or table format
  51. func (e *StackdriverExecutor) Query(ctx context.Context, dsInfo *models.DataSource, tsdbQuery *tsdb.TsdbQuery) (*tsdb.Response, error) {
  52. result := &tsdb.Response{
  53. Results: make(map[string]*tsdb.QueryResult),
  54. }
  55. queries, err := e.buildQueries(tsdbQuery)
  56. if err != nil {
  57. return nil, err
  58. }
  59. for _, query := range queries {
  60. queryRes, err := e.executeQuery(ctx, query, tsdbQuery)
  61. if err != nil {
  62. return nil, err
  63. }
  64. result.Results[query.RefID] = queryRes
  65. }
  66. return result, nil
  67. }
  68. func (e *StackdriverExecutor) buildQueries(tsdbQuery *tsdb.TsdbQuery) ([]*StackdriverQuery, error) {
  69. stackdriverQueries := []*StackdriverQuery{}
  70. startTime, err := tsdbQuery.TimeRange.ParseFrom()
  71. if err != nil {
  72. return nil, err
  73. }
  74. endTime, err := tsdbQuery.TimeRange.ParseTo()
  75. if err != nil {
  76. return nil, err
  77. }
  78. for _, query := range tsdbQuery.Queries {
  79. var target string
  80. if fullTarget, err := query.Model.Get("targetFull").String(); err == nil {
  81. target = fixIntervalFormat(fullTarget)
  82. } else {
  83. target = fixIntervalFormat(query.Model.Get("target").MustString())
  84. }
  85. metricType := query.Model.Get("metricType").MustString()
  86. filterParts := query.Model.Get("filters").MustArray()
  87. filterString := ""
  88. for i, part := range filterParts {
  89. mod := i % 4
  90. if part == "AND" {
  91. filterString += " "
  92. } else if mod == 2 {
  93. filterString += fmt.Sprintf(`"%s"`, part)
  94. } else {
  95. filterString += part.(string)
  96. }
  97. }
  98. params := url.Values{}
  99. params.Add("interval.startTime", startTime.UTC().Format(time.RFC3339))
  100. params.Add("interval.endTime", endTime.UTC().Format(time.RFC3339))
  101. params.Add("filter", strings.Trim(fmt.Sprintf(`metric.type="%s" %s`, metricType, filterString), " "))
  102. params.Add("view", query.Model.Get("view").MustString())
  103. setAggParams(&params, query)
  104. if setting.Env == setting.DEV {
  105. slog.Debug("Stackdriver request", "params", params)
  106. }
  107. groupBys := query.Model.Get("groupBys").MustArray()
  108. groupBysAsStrings := make([]string, 0)
  109. for _, groupBy := range groupBys {
  110. groupBysAsStrings = append(groupBysAsStrings, groupBy.(string))
  111. }
  112. stackdriverQueries = append(stackdriverQueries, &StackdriverQuery{
  113. Target: target,
  114. Params: params,
  115. RefID: query.RefId,
  116. GroupBys: groupBysAsStrings,
  117. })
  118. }
  119. return stackdriverQueries, nil
  120. }
  121. func setAggParams(params *url.Values, query *tsdb.Query) {
  122. primaryAggregation := query.Model.Get("primaryAggregation").MustString()
  123. perSeriesAligner := query.Model.Get("perSeriesAligner").MustString()
  124. alignmentPeriod := query.Model.Get("alignmentPeriod").MustString()
  125. if primaryAggregation == "" {
  126. primaryAggregation = "REDUCE_NONE"
  127. }
  128. if perSeriesAligner == "" {
  129. perSeriesAligner = "ALIGN_MEAN"
  130. }
  131. if alignmentPeriod == "auto" || alignmentPeriod == "" {
  132. alignmentPeriodValue := int(math.Max(float64(query.IntervalMs), 60.0))
  133. alignmentPeriod = "+" + strconv.Itoa(alignmentPeriodValue) + "s"
  134. }
  135. re := regexp.MustCompile("[0-9]+")
  136. aa, err := strconv.ParseInt(re.FindString(alignmentPeriod), 10, 64)
  137. if err != nil || aa > 3600 {
  138. alignmentPeriod = "+3600s"
  139. }
  140. params.Add("aggregation.crossSeriesReducer", primaryAggregation)
  141. params.Add("aggregation.perSeriesAligner", perSeriesAligner)
  142. params.Add("aggregation.alignmentPeriod", alignmentPeriod)
  143. groupBys := query.Model.Get("groupBys").MustArray()
  144. if len(groupBys) > 0 {
  145. for i := 0; i < len(groupBys); i++ {
  146. params.Add("aggregation.groupByFields", groupBys[i].(string))
  147. }
  148. }
  149. }
  150. func (e *StackdriverExecutor) executeQuery(ctx context.Context, query *StackdriverQuery, tsdbQuery *tsdb.TsdbQuery) (*tsdb.QueryResult, error) {
  151. queryResult := &tsdb.QueryResult{Meta: simplejson.New(), RefId: query.RefID}
  152. req, err := e.createRequest(ctx, e.dsInfo)
  153. if err != nil {
  154. queryResult.Error = err
  155. return queryResult, nil
  156. }
  157. req.URL.RawQuery = query.Params.Encode()
  158. queryResult.Meta.Set("rawQuery", req.URL.RawQuery)
  159. span, ctx := opentracing.StartSpanFromContext(ctx, "stackdriver query")
  160. span.SetTag("target", query.Target)
  161. span.SetTag("from", tsdbQuery.TimeRange.From)
  162. span.SetTag("until", tsdbQuery.TimeRange.To)
  163. span.SetTag("datasource_id", e.dsInfo.Id)
  164. span.SetTag("org_id", e.dsInfo.OrgId)
  165. defer span.Finish()
  166. opentracing.GlobalTracer().Inject(
  167. span.Context(),
  168. opentracing.HTTPHeaders,
  169. opentracing.HTTPHeadersCarrier(req.Header))
  170. res, err := ctxhttp.Do(ctx, e.httpClient, req)
  171. if err != nil {
  172. queryResult.Error = err
  173. return queryResult, nil
  174. }
  175. data, err := e.unmarshalResponse(res)
  176. if err != nil {
  177. queryResult.Error = err
  178. return queryResult, nil
  179. }
  180. err = e.parseResponse(queryResult, data, query)
  181. if err != nil {
  182. queryResult.Error = err
  183. return queryResult, nil
  184. }
  185. return queryResult, nil
  186. }
  187. func (e *StackdriverExecutor) unmarshalResponse(res *http.Response) (StackdriverResponse, error) {
  188. body, err := ioutil.ReadAll(res.Body)
  189. defer res.Body.Close()
  190. if err != nil {
  191. return StackdriverResponse{}, err
  192. }
  193. if res.StatusCode/100 != 2 {
  194. slog.Error("Request failed", "status", res.Status, "body", string(body))
  195. return StackdriverResponse{}, fmt.Errorf(string(body))
  196. }
  197. var data StackdriverResponse
  198. err = json.Unmarshal(body, &data)
  199. if err != nil {
  200. slog.Error("Failed to unmarshal Stackdriver response", "error", err, "status", res.Status, "body", string(body))
  201. return StackdriverResponse{}, err
  202. }
  203. return data, nil
  204. }
  205. func (e *StackdriverExecutor) parseResponse(queryRes *tsdb.QueryResult, data StackdriverResponse, query *StackdriverQuery) error {
  206. metricLabels := make(map[string][]string)
  207. resourceLabels := make(map[string][]string)
  208. for _, series := range data.TimeSeries {
  209. points := make([]tsdb.TimePoint, 0)
  210. // reverse the order to be ascending
  211. for i := len(series.Points) - 1; i >= 0; i-- {
  212. point := series.Points[i]
  213. points = append(points, tsdb.NewTimePoint(null.FloatFrom(point.Value.DoubleValue), float64((point.Interval.EndTime).Unix())*1000))
  214. }
  215. metricName := series.Metric.Type
  216. for key, value := range series.Metric.Labels {
  217. if !containsLabel(metricLabels[key], value) {
  218. metricLabels[key] = append(metricLabels[key], value)
  219. }
  220. if len(query.GroupBys) == 0 || containsLabel(query.GroupBys, "metric.label."+key) {
  221. metricName += " " + value
  222. }
  223. }
  224. for key, value := range series.Resource.Labels {
  225. if !containsLabel(resourceLabels[key], value) {
  226. resourceLabels[key] = append(resourceLabels[key], value)
  227. }
  228. if containsLabel(query.GroupBys, "resource.label."+key) {
  229. metricName += " " + value
  230. }
  231. }
  232. queryRes.Series = append(queryRes.Series, &tsdb.TimeSeries{
  233. Name: metricName,
  234. Points: points,
  235. })
  236. }
  237. queryRes.Meta.Set("resourceLabels", resourceLabels)
  238. queryRes.Meta.Set("metricLabels", metricLabels)
  239. queryRes.Meta.Set("groupBys", query.GroupBys)
  240. return nil
  241. }
  242. func containsLabel(labels []string, newLabel string) bool {
  243. for _, val := range labels {
  244. if val == newLabel {
  245. return true
  246. }
  247. }
  248. return false
  249. }
  250. func (e *StackdriverExecutor) createRequest(ctx context.Context, dsInfo *models.DataSource) (*http.Request, error) {
  251. u, _ := url.Parse(dsInfo.Url)
  252. u.Path = path.Join(u.Path, "render")
  253. req, err := http.NewRequest(http.MethodGet, "https://monitoring.googleapis.com/", nil)
  254. if err != nil {
  255. slog.Info("Failed to create request", "error", err)
  256. return nil, fmt.Errorf("Failed to create request. error: %v", err)
  257. }
  258. req.Header.Set("Content-Type", "application/json")
  259. req.Header.Set("User-Agent", fmt.Sprintf("Grafana/%s", setting.BuildVersion))
  260. // find plugin
  261. plugin, ok := plugins.DataSources[dsInfo.Type]
  262. if !ok {
  263. return nil, errors.New("Unable to find datasource plugin Stackdriver")
  264. }
  265. projectName := dsInfo.JsonData.Get("defaultProject").MustString()
  266. proxyPass := fmt.Sprintf("stackdriver%s", "v3/projects/"+projectName+"/timeSeries")
  267. var stackdriverRoute *plugins.AppPluginRoute
  268. for _, route := range plugin.Routes {
  269. if route.Path == "stackdriver" {
  270. stackdriverRoute = route
  271. break
  272. }
  273. }
  274. pluginproxy.ApplyRoute(ctx, req, proxyPass, stackdriverRoute, dsInfo)
  275. return req, nil
  276. }
  277. func fixIntervalFormat(target string) string {
  278. rMinute := regexp.MustCompile(`'(\d+)m'`)
  279. rMin := regexp.MustCompile("m")
  280. target = rMinute.ReplaceAllStringFunc(target, func(m string) string {
  281. return rMin.ReplaceAllString(m, "min")
  282. })
  283. rMonth := regexp.MustCompile(`'(\d+)M'`)
  284. rMon := regexp.MustCompile("M")
  285. target = rMonth.ReplaceAllStringFunc(target, func(M string) string {
  286. return rMon.ReplaceAllString(M, "mon")
  287. })
  288. return target
  289. }