cloudwatch.go 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  1. package cloudwatch
  2. import (
  3. "context"
  4. "errors"
  5. "regexp"
  6. "sort"
  7. "strconv"
  8. "strings"
  9. "time"
  10. "github.com/grafana/grafana/pkg/log"
  11. "github.com/grafana/grafana/pkg/models"
  12. "github.com/grafana/grafana/pkg/setting"
  13. "github.com/grafana/grafana/pkg/tsdb"
  14. "github.com/aws/aws-sdk-go/aws"
  15. "github.com/aws/aws-sdk-go/aws/request"
  16. "github.com/aws/aws-sdk-go/service/cloudwatch"
  17. "github.com/aws/aws-sdk-go/service/ec2/ec2iface"
  18. "github.com/grafana/grafana/pkg/components/null"
  19. "github.com/grafana/grafana/pkg/components/simplejson"
  20. "github.com/grafana/grafana/pkg/metrics"
  21. )
  22. type CloudWatchExecutor struct {
  23. *models.DataSource
  24. ec2Svc ec2iface.EC2API
  25. }
  26. type DatasourceInfo struct {
  27. Profile string
  28. Region string
  29. AuthType string
  30. AssumeRoleArn string
  31. Namespace string
  32. AccessKey string
  33. SecretKey string
  34. }
  35. func NewCloudWatchExecutor(dsInfo *models.DataSource) (tsdb.TsdbQueryEndpoint, error) {
  36. return &CloudWatchExecutor{}, nil
  37. }
  38. var (
  39. plog log.Logger
  40. standardStatistics map[string]bool
  41. aliasFormat *regexp.Regexp
  42. )
  43. func init() {
  44. plog = log.New("tsdb.cloudwatch")
  45. tsdb.RegisterTsdbQueryEndpoint("cloudwatch", NewCloudWatchExecutor)
  46. standardStatistics = map[string]bool{
  47. "Average": true,
  48. "Maximum": true,
  49. "Minimum": true,
  50. "Sum": true,
  51. "SampleCount": true,
  52. }
  53. aliasFormat = regexp.MustCompile(`\{\{\s*(.+?)\s*\}\}`)
  54. }
  55. func (e *CloudWatchExecutor) Query(ctx context.Context, dsInfo *models.DataSource, queryContext *tsdb.TsdbQuery) (*tsdb.Response, error) {
  56. var result *tsdb.Response
  57. e.DataSource = dsInfo
  58. queryType := queryContext.Queries[0].Model.Get("type").MustString("")
  59. var err error
  60. switch queryType {
  61. case "metricFindQuery":
  62. result, err = e.executeMetricFindQuery(ctx, queryContext)
  63. break
  64. case "annotationQuery":
  65. result, err = e.executeAnnotationQuery(ctx, queryContext)
  66. break
  67. case "timeSeriesQuery":
  68. fallthrough
  69. default:
  70. result, err = e.executeTimeSeriesQuery(ctx, queryContext)
  71. break
  72. }
  73. return result, err
  74. }
  75. func (e *CloudWatchExecutor) executeTimeSeriesQuery(ctx context.Context, queryContext *tsdb.TsdbQuery) (*tsdb.Response, error) {
  76. result := &tsdb.Response{
  77. Results: make(map[string]*tsdb.QueryResult),
  78. }
  79. errCh := make(chan error, 1)
  80. resCh := make(chan *tsdb.QueryResult, 1)
  81. currentlyExecuting := 0
  82. for i, model := range queryContext.Queries {
  83. queryType := model.Model.Get("type").MustString()
  84. if queryType != "timeSeriesQuery" && queryType != "" {
  85. continue
  86. }
  87. currentlyExecuting++
  88. go func(refId string, index int) {
  89. queryRes, err := e.executeQuery(ctx, queryContext.Queries[index].Model, queryContext)
  90. currentlyExecuting--
  91. if err != nil {
  92. errCh <- err
  93. } else {
  94. queryRes.RefId = refId
  95. resCh <- queryRes
  96. }
  97. }(model.RefId, i)
  98. }
  99. for currentlyExecuting != 0 {
  100. select {
  101. case res := <-resCh:
  102. result.Results[res.RefId] = res
  103. case err := <-errCh:
  104. return result, err
  105. case <-ctx.Done():
  106. return result, ctx.Err()
  107. }
  108. }
  109. return result, nil
  110. }
  111. func (e *CloudWatchExecutor) executeQuery(ctx context.Context, parameters *simplejson.Json, queryContext *tsdb.TsdbQuery) (*tsdb.QueryResult, error) {
  112. query, err := parseQuery(parameters)
  113. if err != nil {
  114. return nil, err
  115. }
  116. client, err := e.getClient(query.Region)
  117. if err != nil {
  118. return nil, err
  119. }
  120. startTime, err := queryContext.TimeRange.ParseFrom()
  121. if err != nil {
  122. return nil, err
  123. }
  124. endTime, err := queryContext.TimeRange.ParseTo()
  125. if err != nil {
  126. return nil, err
  127. }
  128. params := &cloudwatch.GetMetricStatisticsInput{
  129. Namespace: aws.String(query.Namespace),
  130. MetricName: aws.String(query.MetricName),
  131. Dimensions: query.Dimensions,
  132. Period: aws.Int64(int64(query.Period)),
  133. }
  134. if len(query.Statistics) > 0 {
  135. params.Statistics = query.Statistics
  136. }
  137. if len(query.ExtendedStatistics) > 0 {
  138. params.ExtendedStatistics = query.ExtendedStatistics
  139. }
  140. // 1 minutes resolutin metrics is stored for 15 days, 15 * 24 * 60 = 21600
  141. if query.HighResolution && (((endTime.Unix() - startTime.Unix()) / int64(query.Period)) > 21600) {
  142. return nil, errors.New("too long query period")
  143. }
  144. var resp *cloudwatch.GetMetricStatisticsOutput
  145. for startTime.Before(endTime) {
  146. params.StartTime = aws.Time(startTime)
  147. if query.HighResolution {
  148. startTime = startTime.Add(time.Duration(1440*query.Period) * time.Second)
  149. } else {
  150. startTime = endTime
  151. }
  152. params.EndTime = aws.Time(startTime)
  153. if setting.Env == setting.DEV {
  154. plog.Debug("CloudWatch query", "raw query", params)
  155. }
  156. partResp, err := client.GetMetricStatisticsWithContext(ctx, params, request.WithResponseReadTimeout(10*time.Second))
  157. if err != nil {
  158. return nil, err
  159. }
  160. if resp != nil {
  161. resp.Datapoints = append(resp.Datapoints, partResp.Datapoints...)
  162. } else {
  163. resp = partResp
  164. }
  165. metrics.M_Aws_CloudWatch_GetMetricStatistics.Inc()
  166. }
  167. queryRes, err := parseResponse(resp, query)
  168. if err != nil {
  169. return nil, err
  170. }
  171. return queryRes, nil
  172. }
  173. func parseDimensions(model *simplejson.Json) ([]*cloudwatch.Dimension, error) {
  174. var result []*cloudwatch.Dimension
  175. for k, v := range model.Get("dimensions").MustMap() {
  176. kk := k
  177. if vv, ok := v.(string); ok {
  178. result = append(result, &cloudwatch.Dimension{
  179. Name: &kk,
  180. Value: &vv,
  181. })
  182. } else {
  183. return nil, errors.New("failed to parse")
  184. }
  185. }
  186. sort.Slice(result, func(i, j int) bool {
  187. return *result[i].Name < *result[j].Name
  188. })
  189. return result, nil
  190. }
  191. func parseStatistics(model *simplejson.Json) ([]string, []string, error) {
  192. var statistics []string
  193. var extendedStatistics []string
  194. for _, s := range model.Get("statistics").MustArray() {
  195. if ss, ok := s.(string); ok {
  196. if _, isStandard := standardStatistics[ss]; isStandard {
  197. statistics = append(statistics, ss)
  198. } else {
  199. extendedStatistics = append(extendedStatistics, ss)
  200. }
  201. } else {
  202. return nil, nil, errors.New("failed to parse")
  203. }
  204. }
  205. return statistics, extendedStatistics, nil
  206. }
  207. func parseQuery(model *simplejson.Json) (*CloudWatchQuery, error) {
  208. region, err := model.Get("region").String()
  209. if err != nil {
  210. return nil, err
  211. }
  212. namespace, err := model.Get("namespace").String()
  213. if err != nil {
  214. return nil, err
  215. }
  216. metricName, err := model.Get("metricName").String()
  217. if err != nil {
  218. return nil, err
  219. }
  220. dimensions, err := parseDimensions(model)
  221. if err != nil {
  222. return nil, err
  223. }
  224. statistics, extendedStatistics, err := parseStatistics(model)
  225. if err != nil {
  226. return nil, err
  227. }
  228. p := model.Get("period").MustString("")
  229. if p == "" {
  230. if namespace == "AWS/EC2" {
  231. p = "300"
  232. } else {
  233. p = "60"
  234. }
  235. }
  236. period := 300
  237. if regexp.MustCompile(`^\d+$`).Match([]byte(p)) {
  238. period, err = strconv.Atoi(p)
  239. if err != nil {
  240. return nil, err
  241. }
  242. } else {
  243. d, err := time.ParseDuration(p)
  244. if err != nil {
  245. return nil, err
  246. }
  247. period = int(d.Seconds())
  248. }
  249. alias := model.Get("alias").MustString()
  250. if alias == "" {
  251. alias = "{{metric}}_{{stat}}"
  252. }
  253. highResolution := model.Get("highResolution").MustBool(false)
  254. return &CloudWatchQuery{
  255. Region: region,
  256. Namespace: namespace,
  257. MetricName: metricName,
  258. Dimensions: dimensions,
  259. Statistics: aws.StringSlice(statistics),
  260. ExtendedStatistics: aws.StringSlice(extendedStatistics),
  261. Period: period,
  262. Alias: alias,
  263. HighResolution: highResolution,
  264. }, nil
  265. }
  266. func formatAlias(query *CloudWatchQuery, stat string, dimensions map[string]string) string {
  267. data := map[string]string{}
  268. data["region"] = query.Region
  269. data["namespace"] = query.Namespace
  270. data["metric"] = query.MetricName
  271. data["stat"] = stat
  272. data["period"] = strconv.Itoa(query.Period)
  273. for k, v := range dimensions {
  274. data[k] = v
  275. }
  276. result := aliasFormat.ReplaceAllFunc([]byte(query.Alias), func(in []byte) []byte {
  277. labelName := strings.Replace(string(in), "{{", "", 1)
  278. labelName = strings.Replace(labelName, "}}", "", 1)
  279. labelName = strings.TrimSpace(labelName)
  280. if val, exists := data[labelName]; exists {
  281. return []byte(val)
  282. }
  283. return in
  284. })
  285. return string(result)
  286. }
  287. func parseResponse(resp *cloudwatch.GetMetricStatisticsOutput, query *CloudWatchQuery) (*tsdb.QueryResult, error) {
  288. queryRes := tsdb.NewQueryResult()
  289. var value float64
  290. for _, s := range append(query.Statistics, query.ExtendedStatistics...) {
  291. series := tsdb.TimeSeries{
  292. Tags: map[string]string{},
  293. Points: make([]tsdb.TimePoint, 0),
  294. }
  295. for _, d := range query.Dimensions {
  296. series.Tags[*d.Name] = *d.Value
  297. }
  298. series.Name = formatAlias(query, *s, series.Tags)
  299. lastTimestamp := make(map[string]time.Time)
  300. sort.Slice(resp.Datapoints, func(i, j int) bool {
  301. return (*resp.Datapoints[i].Timestamp).Before(*resp.Datapoints[j].Timestamp)
  302. })
  303. for _, v := range resp.Datapoints {
  304. switch *s {
  305. case "Average":
  306. value = *v.Average
  307. case "Maximum":
  308. value = *v.Maximum
  309. case "Minimum":
  310. value = *v.Minimum
  311. case "Sum":
  312. value = *v.Sum
  313. case "SampleCount":
  314. value = *v.SampleCount
  315. default:
  316. if strings.Index(*s, "p") == 0 && v.ExtendedStatistics[*s] != nil {
  317. value = *v.ExtendedStatistics[*s]
  318. }
  319. }
  320. // terminate gap of data points
  321. timestamp := *v.Timestamp
  322. if _, ok := lastTimestamp[*s]; ok {
  323. nextTimestampFromLast := lastTimestamp[*s].Add(time.Duration(query.Period) * time.Second)
  324. for timestamp.After(nextTimestampFromLast) {
  325. series.Points = append(series.Points, tsdb.NewTimePoint(null.FloatFromPtr(nil), float64(nextTimestampFromLast.Unix()*1000)))
  326. nextTimestampFromLast = nextTimestampFromLast.Add(time.Duration(query.Period) * time.Second)
  327. }
  328. }
  329. lastTimestamp[*s] = timestamp
  330. series.Points = append(series.Points, tsdb.NewTimePoint(null.FloatFrom(value), float64(timestamp.Unix()*1000)))
  331. }
  332. queryRes.Series = append(queryRes.Series, &series)
  333. }
  334. return queryRes, nil
  335. }