postgres.go 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. package postgres
  2. import (
  3. "container/list"
  4. "context"
  5. "fmt"
  6. "math"
  7. "net/url"
  8. "strconv"
  9. "time"
  10. "github.com/go-xorm/core"
  11. "github.com/grafana/grafana/pkg/components/null"
  12. "github.com/grafana/grafana/pkg/log"
  13. "github.com/grafana/grafana/pkg/models"
  14. "github.com/grafana/grafana/pkg/tsdb"
  15. )
  16. type PostgresQueryEndpoint struct {
  17. sqlEngine tsdb.SqlEngine
  18. log log.Logger
  19. }
  20. func init() {
  21. tsdb.RegisterTsdbQueryEndpoint("postgres", NewPostgresQueryEndpoint)
  22. }
  23. func NewPostgresQueryEndpoint(datasource *models.DataSource) (tsdb.TsdbQueryEndpoint, error) {
  24. endpoint := &PostgresQueryEndpoint{
  25. log: log.New("tsdb.postgres"),
  26. }
  27. endpoint.sqlEngine = &tsdb.DefaultSqlEngine{
  28. MacroEngine: NewPostgresMacroEngine(),
  29. }
  30. cnnstr := generateConnectionString(datasource)
  31. endpoint.log.Debug("getEngine", "connection", cnnstr)
  32. if err := endpoint.sqlEngine.InitEngine("postgres", datasource, cnnstr); err != nil {
  33. return nil, err
  34. }
  35. return endpoint, nil
  36. }
  37. func generateConnectionString(datasource *models.DataSource) string {
  38. password := ""
  39. for key, value := range datasource.SecureJsonData.Decrypt() {
  40. if key == "password" {
  41. password = value
  42. break
  43. }
  44. }
  45. sslmode := datasource.JsonData.Get("sslmode").MustString("verify-full")
  46. u := &url.URL{Scheme: "postgres", User: url.UserPassword(datasource.User, password), Host: datasource.Url, Path: datasource.Database, RawQuery: "sslmode=" + sslmode}
  47. return u.String()
  48. }
  49. func (e *PostgresQueryEndpoint) Query(ctx context.Context, dsInfo *models.DataSource, tsdbQuery *tsdb.TsdbQuery) (*tsdb.Response, error) {
  50. return e.sqlEngine.Query(ctx, dsInfo, tsdbQuery, e.transformToTimeSeries, e.transformToTable)
  51. }
  52. func (e PostgresQueryEndpoint) transformToTable(query *tsdb.Query, rows *core.Rows, result *tsdb.QueryResult, tsdbQuery *tsdb.TsdbQuery) error {
  53. columnNames, err := rows.Columns()
  54. if err != nil {
  55. return err
  56. }
  57. table := &tsdb.Table{
  58. Columns: make([]tsdb.TableColumn, len(columnNames)),
  59. Rows: make([]tsdb.RowValues, 0),
  60. }
  61. for i, name := range columnNames {
  62. table.Columns[i].Text = name
  63. }
  64. rowLimit := 1000000
  65. rowCount := 0
  66. timeIndex := -1
  67. // check if there is a column named time
  68. for i, col := range columnNames {
  69. switch col {
  70. case "time":
  71. timeIndex = i
  72. }
  73. }
  74. for ; rows.Next(); rowCount++ {
  75. if rowCount > rowLimit {
  76. return fmt.Errorf("PostgreSQL query row limit exceeded, limit %d", rowLimit)
  77. }
  78. values, err := e.getTypedRowData(rows)
  79. if err != nil {
  80. return err
  81. }
  82. // converts column named time to unix timestamp in milliseconds to make
  83. // native postgres datetime types and epoch dates work in
  84. // annotation and table queries.
  85. tsdb.ConvertSqlTimeColumnToEpochMs(values, timeIndex)
  86. table.Rows = append(table.Rows, values)
  87. }
  88. result.Tables = append(result.Tables, table)
  89. result.Meta.Set("rowCount", rowCount)
  90. return nil
  91. }
  92. func (e PostgresQueryEndpoint) getTypedRowData(rows *core.Rows) (tsdb.RowValues, error) {
  93. types, err := rows.ColumnTypes()
  94. if err != nil {
  95. return nil, err
  96. }
  97. values := make([]interface{}, len(types))
  98. valuePtrs := make([]interface{}, len(types))
  99. for i := 0; i < len(types); i++ {
  100. valuePtrs[i] = &values[i]
  101. }
  102. if err := rows.Scan(valuePtrs...); err != nil {
  103. return nil, err
  104. }
  105. // convert types not handled by lib/pq
  106. // unhandled types are returned as []byte
  107. for i := 0; i < len(types); i++ {
  108. if value, ok := values[i].([]byte); ok == true {
  109. switch types[i].DatabaseTypeName() {
  110. case "NUMERIC":
  111. if v, err := strconv.ParseFloat(string(value), 64); err == nil {
  112. values[i] = v
  113. } else {
  114. e.log.Debug("Rows", "Error converting numeric to float", value)
  115. }
  116. case "UNKNOWN", "CIDR", "INET", "MACADDR":
  117. // char literals have type UNKNOWN
  118. values[i] = string(value)
  119. default:
  120. e.log.Debug("Rows", "Unknown database type", types[i].DatabaseTypeName(), "value", value)
  121. values[i] = string(value)
  122. }
  123. }
  124. }
  125. return values, nil
  126. }
  127. func (e PostgresQueryEndpoint) transformToTimeSeries(query *tsdb.Query, rows *core.Rows, result *tsdb.QueryResult, tsdbQuery *tsdb.TsdbQuery) error {
  128. pointsBySeries := make(map[string]*tsdb.TimeSeries)
  129. seriesByQueryOrder := list.New()
  130. columnNames, err := rows.Columns()
  131. if err != nil {
  132. return err
  133. }
  134. columnTypes, err := rows.ColumnTypes()
  135. if err != nil {
  136. return err
  137. }
  138. rowLimit := 1000000
  139. rowCount := 0
  140. timeIndex := -1
  141. metricIndex := -1
  142. // check columns of resultset: a column named time is mandatory
  143. // the first text column is treated as metric name unless a column named metric is present
  144. for i, col := range columnNames {
  145. switch col {
  146. case "time":
  147. timeIndex = i
  148. case "metric":
  149. metricIndex = i
  150. default:
  151. if metricIndex == -1 {
  152. switch columnTypes[i].DatabaseTypeName() {
  153. case "UNKNOWN", "TEXT", "VARCHAR", "CHAR":
  154. metricIndex = i
  155. }
  156. }
  157. }
  158. }
  159. if timeIndex == -1 {
  160. return fmt.Errorf("Found no column named time")
  161. }
  162. fillMissing := query.Model.Get("fill").MustBool(false)
  163. var fillInterval float64
  164. fillValue := null.Float{}
  165. if fillMissing {
  166. fillInterval = query.Model.Get("fillInterval").MustFloat64() * 1000
  167. if query.Model.Get("fillNull").MustBool(false) == false {
  168. fillValue.Float64 = query.Model.Get("fillValue").MustFloat64()
  169. fillValue.Valid = true
  170. }
  171. }
  172. for rows.Next() {
  173. var timestamp float64
  174. var value null.Float
  175. var metric string
  176. if rowCount > rowLimit {
  177. return fmt.Errorf("PostgreSQL query row limit exceeded, limit %d", rowLimit)
  178. }
  179. values, err := e.getTypedRowData(rows)
  180. if err != nil {
  181. return err
  182. }
  183. switch columnValue := values[timeIndex].(type) {
  184. case int64:
  185. timestamp = float64(columnValue * 1000)
  186. case float64:
  187. timestamp = columnValue * 1000
  188. case time.Time:
  189. timestamp = float64(columnValue.UnixNano() / 1e6)
  190. default:
  191. return fmt.Errorf("Invalid type for column time, must be of type timestamp or unix timestamp, got: %T %v", columnValue, columnValue)
  192. }
  193. if metricIndex >= 0 {
  194. if columnValue, ok := values[metricIndex].(string); ok == true {
  195. metric = columnValue
  196. } else {
  197. return fmt.Errorf("Column metric must be of type char,varchar or text, got: %T %v", values[metricIndex], values[metricIndex])
  198. }
  199. }
  200. for i, col := range columnNames {
  201. if i == timeIndex || i == metricIndex {
  202. continue
  203. }
  204. switch columnValue := values[i].(type) {
  205. case int64:
  206. value = null.FloatFrom(float64(columnValue))
  207. case float64:
  208. value = null.FloatFrom(columnValue)
  209. case nil:
  210. value.Valid = false
  211. default:
  212. return fmt.Errorf("Value column must have numeric datatype, column: %s type: %T value: %v", col, columnValue, columnValue)
  213. }
  214. if metricIndex == -1 {
  215. metric = col
  216. }
  217. series, exist := pointsBySeries[metric]
  218. if exist == false {
  219. series = &tsdb.TimeSeries{Name: metric}
  220. pointsBySeries[metric] = series
  221. seriesByQueryOrder.PushBack(metric)
  222. }
  223. if fillMissing {
  224. var intervalStart float64
  225. if exist == false {
  226. intervalStart = float64(tsdbQuery.TimeRange.MustGetFrom().UnixNano() / 1e6)
  227. } else {
  228. intervalStart = series.Points[len(series.Points)-1][1].Float64 + fillInterval
  229. }
  230. // align interval start
  231. intervalStart = math.Floor(intervalStart/fillInterval) * fillInterval
  232. for i := intervalStart; i < timestamp; i += fillInterval {
  233. series.Points = append(series.Points, tsdb.TimePoint{fillValue, null.FloatFrom(i)})
  234. rowCount++
  235. }
  236. }
  237. series.Points = append(series.Points, tsdb.TimePoint{value, null.FloatFrom(timestamp)})
  238. e.log.Debug("Rows", "metric", metric, "time", timestamp, "value", value)
  239. rowCount++
  240. }
  241. }
  242. for elem := seriesByQueryOrder.Front(); elem != nil; elem = elem.Next() {
  243. key := elem.Value.(string)
  244. result.Series = append(result.Series, pointsBySeries[key])
  245. if fillMissing {
  246. series := pointsBySeries[key]
  247. // fill in values from last fetched value till interval end
  248. intervalStart := series.Points[len(series.Points)-1][1].Float64
  249. intervalEnd := float64(tsdbQuery.TimeRange.MustGetTo().UnixNano() / 1e6)
  250. // align interval start
  251. intervalStart = math.Floor(intervalStart/fillInterval) * fillInterval
  252. for i := intervalStart + fillInterval; i < intervalEnd; i += fillInterval {
  253. series.Points = append(series.Points, tsdb.TimePoint{fillValue, null.FloatFrom(i)})
  254. rowCount++
  255. }
  256. }
  257. }
  258. result.Meta.Set("rowCount", rowCount)
  259. return nil
  260. }