ruby-grafana-reporter 0.1.6 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +0 -0
  3. data/README.md +95 -173
  4. data/bin/ruby-grafana-reporter +5 -0
  5. data/lib/VERSION.rb +5 -3
  6. data/lib/grafana/abstract_panel_query.rb +22 -20
  7. data/lib/grafana/abstract_query.rb +132 -127
  8. data/lib/grafana/abstract_sql_query.rb +51 -42
  9. data/lib/grafana/dashboard.rb +77 -66
  10. data/lib/grafana/errors.rb +66 -61
  11. data/lib/grafana/grafana.rb +133 -131
  12. data/lib/grafana/panel.rb +41 -39
  13. data/lib/grafana/panel_image_query.rb +52 -49
  14. data/lib/grafana/variable.rb +217 -259
  15. data/lib/grafana_reporter/abstract_report.rb +112 -109
  16. data/lib/grafana_reporter/application/application.rb +158 -229
  17. data/lib/grafana_reporter/application/errors.rb +33 -30
  18. data/lib/grafana_reporter/application/webservice.rb +230 -0
  19. data/lib/grafana_reporter/asciidoctor/alerts_table_query.rb +101 -99
  20. data/lib/grafana_reporter/asciidoctor/annotations_table_query.rb +96 -96
  21. data/lib/grafana_reporter/asciidoctor/errors.rb +40 -37
  22. data/lib/grafana_reporter/asciidoctor/extensions/alerts_table_include_processor.rb +92 -86
  23. data/lib/grafana_reporter/asciidoctor/extensions/annotations_table_include_processor.rb +91 -86
  24. data/lib/grafana_reporter/asciidoctor/extensions/panel_image_block_macro.rb +69 -67
  25. data/lib/grafana_reporter/asciidoctor/extensions/panel_image_inline_macro.rb +68 -65
  26. data/lib/grafana_reporter/asciidoctor/extensions/panel_property_inline_macro.rb +61 -58
  27. data/lib/grafana_reporter/asciidoctor/extensions/panel_query_table_include_processor.rb +78 -75
  28. data/lib/grafana_reporter/asciidoctor/extensions/panel_query_value_inline_macro.rb +73 -70
  29. data/lib/grafana_reporter/asciidoctor/extensions/processor_mixin.rb +20 -18
  30. data/lib/grafana_reporter/asciidoctor/extensions/show_environment_include_processor.rb +43 -41
  31. data/lib/grafana_reporter/asciidoctor/extensions/show_help_include_processor.rb +30 -202
  32. data/lib/grafana_reporter/asciidoctor/extensions/sql_table_include_processor.rb +70 -67
  33. data/lib/grafana_reporter/asciidoctor/extensions/sql_value_inline_macro.rb +66 -65
  34. data/lib/grafana_reporter/asciidoctor/extensions/value_as_variable_include_processor.rb +88 -57
  35. data/lib/grafana_reporter/asciidoctor/help.rb +435 -0
  36. data/lib/grafana_reporter/asciidoctor/panel_first_value_query.rb +36 -32
  37. data/lib/grafana_reporter/asciidoctor/panel_image_query.rb +28 -23
  38. data/lib/grafana_reporter/asciidoctor/panel_property_query.rb +44 -43
  39. data/lib/grafana_reporter/asciidoctor/panel_table_query.rb +40 -36
  40. data/lib/grafana_reporter/asciidoctor/query_mixin.rb +312 -309
  41. data/lib/grafana_reporter/asciidoctor/report.rb +179 -159
  42. data/lib/grafana_reporter/asciidoctor/sql_first_value_query.rb +42 -34
  43. data/lib/grafana_reporter/asciidoctor/sql_table_query.rb +44 -32
  44. data/lib/grafana_reporter/configuration.rb +304 -326
  45. data/lib/grafana_reporter/console_configuration_wizard.rb +269 -0
  46. data/lib/grafana_reporter/errors.rb +48 -38
  47. data/lib/grafana_reporter/logger/two_way_logger.rb +58 -52
  48. data/lib/ruby-grafana-reporter.rb +32 -27
  49. metadata +116 -16
@@ -1,32 +1,36 @@
1
- require_relative 'sql_first_value_query'
2
-
3
- module GrafanaReporter
4
- module Asciidoctor
5
- # (see SqlFirstValueQuery)
6
- #
7
- # The SQL query as well as the datasource configuration are thereby captured from a
8
- # {Grafana::Panel}.
9
- class PanelFirstValueQuery < SqlFirstValueQuery
10
- include QueryMixin
11
-
12
- # (see PanelTableQuery#initialize)
13
- def initialize(panel, query_letter)
14
- super(nil, nil)
15
- @panel = panel
16
- @query_letter = query_letter
17
- extract_dashboard_variables(@panel.dashboard)
18
- end
19
-
20
- # (see PanelTableQuery#pre_process)
21
- def pre_process(grafana)
22
- @sql = @panel.query(@query_letter)
23
- # resolve datasource name
24
- @datasource = @panel.field('datasource')
25
- @datasource_id = grafana.datasource_id(@datasource)
26
- super(grafana)
27
- @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
28
- @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
29
- end
30
- end
31
- end
32
- end
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'sql_first_value_query'
4
+
5
+ module GrafanaReporter
6
+ module Asciidoctor
7
+ # (see SqlFirstValueQuery)
8
+ #
9
+ # The SQL query as well as the datasource configuration are thereby captured from a
10
+ # {Grafana::Panel}.
11
+ class PanelFirstValueQuery < SqlFirstValueQuery
12
+ include QueryMixin
13
+
14
+ # (see PanelTableQuery#initialize)
15
+ def initialize(panel, query_letter)
16
+ super(nil, nil)
17
+ @panel = panel
18
+ @query_letter = query_letter
19
+ extract_dashboard_variables(@panel.dashboard)
20
+ end
21
+
22
+ # (see PanelTableQuery#pre_process)
23
+ def pre_process(grafana)
24
+ @sql = @panel.query(@query_letter)
25
+ # resolve datasource name
26
+ @datasource = @panel.field('datasource')
27
+ @datasource_id = grafana.datasource_id(@datasource)
28
+ super(grafana)
29
+ @from = translate_date(@from, @variables['grafana-report-timestamp'], false, @variables['from_timezone'] ||
30
+ @variables['grafana_default_from_timezone'])
31
+ @to = translate_date(@to, @variables['grafana-report-timestamp'], true, @variables['to_timezone'] ||
32
+ @variables['grafana_default_to_timezone'])
33
+ end
34
+ end
35
+ end
36
+ end
@@ -1,23 +1,28 @@
1
- module GrafanaReporter
2
- module Asciidoctor
3
- # This class is used to create an image out of a {Grafana::Panel}.
4
- class PanelImageQuery < Grafana::PanelImageQuery
5
- include QueryMixin
6
-
7
- # Sets the proper render variables.
8
- def pre_process(grafana)
9
- super
10
- @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
11
- @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
12
- # rename "render-" variables
13
- @variables.transform_keys! { |k| k.gsub(/^render-/, '') }
14
- end
15
-
16
- # Returns the body of the http query, which contains the raw image.
17
- def post_process
18
- super
19
- @result = @result.body
20
- end
21
- end
22
- end
23
- end
1
+ # frozen_string_literal: true
2
+
3
+ module GrafanaReporter
4
+ module Asciidoctor
5
+ # This class is used to create an image out of a {Grafana::Panel}.
6
+ class PanelImageQuery < Grafana::PanelImageQuery
7
+ include QueryMixin
8
+
9
+ # Sets the proper render variables.
10
+ def pre_process(grafana)
11
+ super
12
+ @from = translate_date(@from, @variables['grafana-report-timestamp'], false, @variables['from_timezone'] ||
13
+ @variables['grafana_default_from_timezone'])
14
+ @to = translate_date(@to, @variables['grafana-report-timestamp'], true, @variables['to_timezone'] ||
15
+ @variables['grafana_default_to_timezone'])
16
+ # TODO: ensure that in case of timezones are specified, that they are also forwarded to the image renderer
17
+ # rename "render-" variables
18
+ @variables = @variables.each_with_object({}) { |(k, v), h| h[k.gsub(/^render-/, '')] = v }
19
+ end
20
+
21
+ # Returns the body of the http query, which contains the raw image.
22
+ def post_process
23
+ super
24
+ @result = @result.body
25
+ end
26
+ end
27
+ end
28
+ end
@@ -1,43 +1,44 @@
1
- module GrafanaReporter
2
- module Asciidoctor
3
- # This class is used to query properties from a {Grafana::Panel}, such as +description+,
4
- # +title+ etc.
5
- class PanelPropertyQuery < ::Grafana::AbstractPanelQuery
6
- include QueryMixin
7
-
8
- # @param panel [Grafana::Panel] panel object, for which the property shall be retrieved
9
- # @param property [String] queried property, e.g. +title+
10
- def initialize(panel, property)
11
- super(panel)
12
- @property = property
13
- end
14
-
15
-
16
- # Overrides the default method, as the query does not have to run against a SQL table,
17
- # but rather against the panel model.
18
- # @param grafana [Grafana::Grafana] grafana instance against which the panel property is queried
19
- # @return [String] fetched property
20
- def execute(grafana)
21
- return @result unless @result.nil?
22
-
23
- pre_process(grafana)
24
- @result = panel.field(@property)
25
- post_process
26
- @result
27
-
28
- # TODO handle text (markdown and similar) properly
29
- end
30
-
31
- # Prepare query. Mainly here nothing special has to take place.
32
- def pre_process(_grafana)
33
- @from = nil
34
- @to = nil
35
- end
36
-
37
- # Replaces variables in the property field, if any are available.
38
- def post_process
39
- @result = replace_variables(@result, grafana_variables)
40
- end
41
- end
42
- end
43
- end
1
+ # frozen_string_literal: true
2
+
3
+ module GrafanaReporter
4
+ module Asciidoctor
5
+ # This class is used to query properties from a {Grafana::Panel}, such as +description+,
6
+ # +title+ etc.
7
+ class PanelPropertyQuery < ::Grafana::AbstractPanelQuery
8
+ include QueryMixin
9
+
10
+ # @param panel [Grafana::Panel] panel object, for which the property shall be retrieved
11
+ # @param property [String] queried property, e.g. +title+
12
+ def initialize(panel, property)
13
+ super(panel)
14
+ @property = property
15
+ end
16
+
17
+ # Overrides the default method, as the query does not have to run against a SQL table,
18
+ # but rather against the panel model.
19
+ # @param grafana [Grafana::Grafana] grafana instance against which the panel property is queried
20
+ # @return [String] fetched property
21
+ def execute(grafana)
22
+ return @result unless @result.nil?
23
+
24
+ pre_process(grafana)
25
+ @result = panel.field(@property)
26
+ post_process
27
+ @result
28
+
29
+ # TODO: handle text (markdown and similar) properly
30
+ end
31
+
32
+ # Prepare query. Mainly here nothing special has to take place.
33
+ def pre_process(_grafana)
34
+ @from = nil
35
+ @to = nil
36
+ end
37
+
38
+ # Replaces variables in the property field, if any are available.
39
+ def post_process
40
+ @result = replace_variables(@result, grafana_variables)
41
+ end
42
+ end
43
+ end
44
+ end
@@ -1,36 +1,40 @@
1
- require_relative 'sql_table_query'
2
-
3
- module GrafanaReporter
4
- module Asciidoctor
5
- # (see SqlTableQuery)
6
- #
7
- # The SQL query as well as the datasource configuration are thereby captured from a
8
- # {Grafana::Panel}.
9
- class PanelTableQuery < SqlTableQuery
10
- include QueryMixin
11
-
12
- # @param panel [Grafana::Panel] panel which contains the query
13
- # @param query_letter [String] letter of the query within the panel, which shall be used, e.g. +C+
14
- def initialize(panel, query_letter)
15
- super(nil, nil)
16
- @panel = panel
17
- @query_letter = query_letter
18
- extract_dashboard_variables(@panel.dashboard)
19
- end
20
-
21
- # Retrieves the SQL query and the configured datasource from the panel.
22
- # @see Grafana::AbstractSqlQuery#pre_process
23
- # @param grafana [Grafana::Grafana] grafana instance against which the query shall be executed
24
- # @return [void]
25
- def pre_process(grafana)
26
- @sql = @panel.query(@query_letter)
27
- # resolve datasource name
28
- @datasource = @panel.field('datasource')
29
- @datasource_id = grafana.datasource_id(@datasource)
30
- super(grafana)
31
- @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
32
- @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
33
- end
34
- end
35
- end
36
- end
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'sql_table_query'
4
+
5
+ module GrafanaReporter
6
+ module Asciidoctor
7
+ # (see SqlTableQuery)
8
+ #
9
+ # The SQL query as well as the datasource configuration are thereby captured from a
10
+ # {Grafana::Panel}.
11
+ class PanelTableQuery < SqlTableQuery
12
+ include QueryMixin
13
+
14
+ # @param panel [Grafana::Panel] panel which contains the query
15
+ # @param query_letter [String] letter of the query within the panel, which shall be used, e.g. +C+
16
+ def initialize(panel, query_letter)
17
+ super(nil, nil)
18
+ @panel = panel
19
+ @query_letter = query_letter
20
+ extract_dashboard_variables(@panel.dashboard)
21
+ end
22
+
23
+ # Retrieves the SQL query and the configured datasource from the panel.
24
+ # @see Grafana::AbstractSqlQuery#pre_process
25
+ # @param grafana [Grafana::Grafana] grafana instance against which the query shall be executed
26
+ # @return [void]
27
+ def pre_process(grafana)
28
+ @sql = @panel.query(@query_letter)
29
+ # resolve datasource name
30
+ @datasource = @panel.field('datasource')
31
+ @datasource_id = grafana.datasource_id(@datasource)
32
+ super(grafana)
33
+ @from = translate_date(@from, @variables['grafana-report-timestamp'], false, @variables['from_timezone'] ||
34
+ @variables['grafana_default_from_timezone'])
35
+ @to = translate_date(@to, @variables['grafana-report-timestamp'], true, @variables['to_timezone'] ||
36
+ @variables['grafana_default_to_timezone'])
37
+ end
38
+ end
39
+ end
40
+ end
@@ -1,309 +1,312 @@
1
- module GrafanaReporter
2
- module Asciidoctor
3
- # This mixin contains several common methods, which can be used within the queries.
4
- module QueryMixin
5
- # Merges the given hashes to the current object by using the {Grafana::AbstractQuery#merge_variables} method.
6
- # It respects the priorities of the hashes and the object and allows only valid variables to be passed.
7
- # @param document_hash [Hash] variables from report template level
8
- # @param item_hash [Hash] variables from item configuration level, i.e. specific call, which may override document
9
- # @return [void]
10
- def merge_hash_variables(document_hash, item_hash)
11
- merge_variables(document_hash.select { |k, _v| k =~ /^var-/ || k == 'grafana-report-timestamp' }.transform_values { |item| ::Grafana::Variable.new(item) })
12
- # TODO: add documentation for transpose, column_divider and row_divider
13
- merge_variables(item_hash.select { |k, _v| k =~ /^var-/ || k =~ /^render-/ || k =~ /filter_columns|format|replace_values_.*|transpose|column_divider|row_divider/ }.transform_values { |item| ::Grafana::Variable.new(item) })
14
- # TODO: add documentation for timeout and grafana-default-timeout
15
- self.timeout = item_hash['timeout'] || document_hash['grafana-default-timeout'] || timeout
16
- self.from = item_hash['from'] || document_hash['from'] || from
17
- self.to = item_hash['to'] || document_hash['to'] || to
18
- end
19
-
20
- # Formats the SQL results returned from grafana to an easier to use format.
21
- #
22
- # The result is being formatted as stated below:
23
- #
24
- # {
25
- # :header => [column_title_1, column_title_2],
26
- # :content => [
27
- # [row_1_column_1, row_1_column_2],
28
- # [row_2_column_1, row_2_column_2]
29
- # ]
30
- # }
31
- # @param raw_result [Hash] query result hash from grafana
32
- # @return [Hash] sql result formatted as stated above
33
- # TODO: support series query results properly
34
- def preformat_sql_result(raw_result)
35
- results = {}
36
- results.default = []
37
-
38
- JSON.parse(raw_result)['results'].values.each do |query_result|
39
- if query_result.key?('error')
40
- results[:header] = results[:header] << ['SQL Error']
41
- results[:content] = [[query_result['error']]]
42
- elsif query_result['tables']
43
- query_result['tables'].each do |table|
44
- results[:header] = results[:header] << table['columns'].map { |header| header['text'] }
45
- results[:content] = table['rows']
46
- end
47
- else
48
- # TODO: add test for series results
49
- results[:header] = 'time'
50
- query_result['series'].each do |table|
51
- results[:header] << table[:name]
52
- results[:content] = []
53
- content_position = results[:header].length - 1
54
- table[:points].each do |point|
55
- result = []
56
- result << point[1]
57
- (content_position - 1).times {result << nil}
58
- result << point[0]
59
- results[:content][0] << result
60
- end
61
- end
62
- end
63
- end
64
-
65
- results
66
- end
67
-
68
- # Transposes the given result.
69
- #
70
- # NOTE: Only the +:content+ of the given result hash is transposed. The +:header+ is ignored.
71
- #
72
- # @param result [Hash] preformatted sql hash, (see {#preformat_sql_result})
73
- # @param transpose_variable [Grafana::Variable] true, if the result hash shall be transposed
74
- # @return [Hash] transposed query result
75
- def transpose(result, transpose_variable)
76
- return result unless transpose_variable
77
- return result unless transpose_variable.raw_value == 'true'
78
-
79
- result[:content] = result[:content].transpose
80
-
81
- result
82
- end
83
-
84
- # Filters columns out of the query result.
85
- #
86
- # Multiple columns may be filtered. Therefore the column titles have to be named in the
87
- # {Grafana::Variable#raw_value} and have to be separated by +,+ (comma).
88
- # @param result [Hash] preformatted sql hash, (see {#preformat_sql_result})
89
- # @param filter_columns_variable [Grafana::Variable] column names, which shall be removed in the query result
90
- # @return [Hash] filtered query result
91
- def filter_columns(result, filter_columns_variable)
92
- return result unless filter_columns_variable
93
-
94
- filter_columns = filter_columns_variable.raw_value
95
- filter_columns.split(',').each do |filter_column|
96
- pos = result[:header][0].index(filter_column)
97
-
98
- unless pos.nil?
99
- result[:header][0].delete_at(pos)
100
- result[:content].each { |row| row.delete_at(pos) }
101
- end
102
- end
103
-
104
- result
105
- end
106
-
107
- # Uses the {Kernel#format} method to format values in the query results.
108
- #
109
- # The formatting will be applied separately for every column. Therefore the column formats have to be named
110
- # in the {Grafana::Variable#raw_value} and have to be separated by +,+ (comma). If no value is specified for
111
- # a column, no change will happen.
112
- # @param result [Hash] preformatted sql hash, (see {#preformat_sql_result})
113
- # @param formats [Grafana::Variable] formats, which shall be applied to the columns in the query result
114
- # @return [Hash] formatted query result
115
- # TODO: make sure that caught errors are also visible in logger
116
- def format_columns(result, formats)
117
- return result unless formats
118
-
119
- formats.text.split(',').each_index do |i|
120
- format = formats.text.split(',')[i]
121
- next if format.empty?
122
-
123
- result[:content].map do |row|
124
- next unless row.length > i
125
-
126
- begin
127
- row[i] = format % row[i] if row[i]
128
- rescue StandardError => e
129
- row[i] = e.message
130
- end
131
- end
132
- end
133
- result
134
- end
135
-
136
- # Used to replace values in a query result according given configurations.
137
- #
138
- # The given variables will be applied to an appropriate column, depending
139
- # on the naming of the variable. The variable name ending specifies the column,
140
- # e.g. a variable named +replace_values_2+ will be applied to the second column.
141
- #
142
- # The {Grafana::Variable#text} needs to contain the replace specification.
143
- # Multiple replacements can be specified by separating them with +,+. If a
144
- # literal comma is needed, it can be escaped with a backslash: +\\,+.
145
- #
146
- # The rule will be separated from the replacement text with a colon +:+.
147
- # If a literal colon is wanted, it can be escaped with a backslash: +\\:+.
148
- #
149
- # Examples:
150
- # - Basic string replacement
151
- # MyTest:ThisValue
152
- # will replace all occurences of the text 'MyTest' with 'ThisValue'.
153
- # - Number comparison
154
- # <=10:OK
155
- # will replace all values smaller or equal to 10 with 'OK'.
156
- # - Regular expression
157
- # ^[^ ]\\+ (\d+)$:\1 is the answer
158
- # will replace all values matching the pattern, e.g. 'answerToAllQuestions 42' to
159
- # '42 is the answer'. Important to know: the regular expressions always have to start
160
- # with +^+ and end with +$+, i.e. the expression itself always has to match
161
- # the whole content in one field.
162
- # @param result [Hash] preformatted query result (see {#preformat_sql_result}.
163
- # @param configs [Array<Grafana::Variable>] one variable for replacing values in one column
164
- # @return [Hash] query result with replaced values
165
- # TODO: make sure that caught errors are also visible in logger
166
- def replace_values(result, configs)
167
- return result if configs.empty?
168
-
169
- configs.each do |key, formats|
170
- cols = key.split('_')[2..-1].map(&:to_i)
171
-
172
- formats.text.split(/(?<!\\),/).each_index do |j|
173
- format = formats.text.split(/(?<!\\),/)[j]
174
-
175
- arr = format.split(/(?<!\\):/)
176
- raise MalformedReplaceValuesStatementError, format if arr.length != 2
177
-
178
- k = arr[0]
179
- v = arr[1]
180
- k.gsub!(/\\([:,])/, '\1')
181
- v.gsub!(/\\([:,])/, '\1')
182
- result[:content].map do |row|
183
- (row.length - 1).downto 0 do |i|
184
- if cols.include?(i + 1) || cols.empty?
185
-
186
- # handle regular expressions
187
- if k.start_with?('^') && k.end_with?('$')
188
- begin
189
- row[i] = row[i].to_s.gsub(/#{k}/, v) if row[i].to_s =~ /#{k}/
190
- rescue StandardError => e
191
- row[i] = e.message
192
- end
193
-
194
- # handle value comparisons
195
- elsif match = k.match(/^ *(?<operator>[<>]=?|<>|=) *(?<number>[+-]?\d+(?:\.\d+)?)$/)
196
- skip = false
197
- begin
198
- val = Float(row[i])
199
- rescue
200
- # value cannot be converted to number, simply ignore it as the comparison does not fit here
201
- skip = true
202
- end
203
-
204
- if not skip
205
- begin
206
- op = match[:operator].gsub(/^=$/, '==').gsub(/^<>$/, '!=')
207
- if val.public_send(op.to_sym, Float(match[:number]))
208
- row[i] = if v.include?('\\1')
209
- v.gsub(/\\1/, row[i].to_s)
210
- else
211
- v
212
- end
213
- end
214
- rescue StandardError => e
215
- row[i] = e.message
216
- end
217
- end
218
-
219
- # handle as normal comparison
220
- else
221
- row[i] = v if row[i].to_s == k
222
- end
223
- end
224
- end
225
- end
226
- end
227
- end
228
-
229
- result
230
- end
231
-
232
- # Used to translate the relative date strings used by grafana, e.g. +now-5d/w+ to the
233
- # correct timestamp. Reason is that grafana does this in the frontend, which we have
234
- # to emulate here for the reporter.
235
- #
236
- # Additionally providing this function the +report_time+ assures that all queries
237
- # rendered within one report will use _exactly_ the same timestamp in those relative
238
- # times, i.e. there shouldn't appear any time differences, no matter how long the
239
- # report is running.
240
- # @param orig_date [String] time string provided by grafana, usually +from+ or +to+.
241
- # @param report_time [Grafana::Variable] report start time
242
- # @param is_to_time [Boolean] true, if the time should be calculated for +to+, false if it shall be calculated for +from+
243
- # @return [String] translated date as timestamp string
244
- def translate_date(orig_date, report_time, is_to_time)
245
- report_time ||= Variable.new(Time.now.to_s)
246
- return (DateTime.parse(report_time.raw_value).to_time.to_i * 1000).to_s unless orig_date
247
- return orig_date if orig_date =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/
248
- return orig_date if orig_date =~ /^\d+$/
249
-
250
- # replace grafana from and to values using now, now-2d etc.
251
- date_splitted = orig_date.match(%r{^(?<now>now)(?:-(?<sub_count>\d+)?(?<sub_unit>[smhdwMy]?))?(?:/(?<fit>[smhdwMy]))?$})
252
- raise TimeRangeUnknownError, orig_date unless date_splitted
253
-
254
- date = DateTime.parse(report_time.raw_value)
255
- # substract specified time
256
- count = 1
257
- count = date_splitted[:sub_count].to_i if date_splitted[:sub_count]
258
- case date_splitted[:sub_unit]
259
- when 's'
260
- date = (date.to_time - (count * 1)).to_datetime
261
- when 'm'
262
- date = (date.to_time - (count * 60)).to_datetime
263
- when 'h'
264
- date = (date.to_time - (count * 60 * 60)).to_datetime
265
- when 'd'
266
- date = date.prev_day(count)
267
- when 'w'
268
- date = date.prev_day(count * 7)
269
- when 'M'
270
- date = date.prev_month(count)
271
- when 'y'
272
- date = date.prev_year(count)
273
- end
274
-
275
- # fit to specified time frame
276
- case date_splitted[:fit]
277
- when 's'
278
- date = DateTime.new(date.year, date.month, date.day, date.hour, date.min, date.sec, date.zone)
279
- date = (date.to_time + 1).to_datetime if is_to_time
280
- when 'm'
281
- date = DateTime.new(date.year, date.month, date.day, date.hour, date.min, 0, date.zone)
282
- date = (date.to_time + 60).to_datetime if is_to_time
283
- when 'h'
284
- date = DateTime.new(date.year, date.month, date.day, date.hour, 0, 0, date.zone)
285
- date = (date.to_time + 60 * 60).to_datetime if is_to_time
286
- when 'd'
287
- date = DateTime.new(date.year, date.month, date.day, 0, 0, 0, date.zone)
288
- date = date.next_day(1) if is_to_time
289
- when 'w'
290
- date = DateTime.new(date.year, date.month, date.day, 0, 0, 0, date.zone)
291
- date = if date.wday.zero?
292
- date.prev_day(7)
293
- else
294
- date.prev_day(date.wday - 1)
295
- end
296
- date = date.next_day(7) if is_to_time
297
- when 'M'
298
- date = DateTime.new(date.year, date.month, 1, 0, 0, 0, date.zone)
299
- date = date.next_month if is_to_time
300
- when 'y'
301
- date = DateTime.new(date.year, 1, 1, 0, 0, 0, date.zone)
302
- date = date.next_year if is_to_time
303
- end
304
-
305
- (date.to_time.to_i * 1000).to_s
306
- end
307
- end
308
- end
309
- end
1
+ # frozen_string_literal: true
2
+
3
+ module GrafanaReporter
4
+ module Asciidoctor
5
+ # This mixin contains several common methods, which can be used within the queries.
6
+ module QueryMixin
7
+ # Merges the given hashes to the current object by using the {Grafana::AbstractQuery#merge_variables} method.
8
+ # It respects the priorities of the hashes and the object and allows only valid variables to be passed.
9
+ # @param document_hash [Hash] variables from report template level
10
+ # @param item_hash [Hash] variables from item configuration level, i.e. specific call, which may override document
11
+ # @return [void]
12
+ def merge_hash_variables(document_hash, item_hash)
13
+ sel_doc_items = document_hash.select do |k, _v|
14
+ k =~ /^var-/ || k == 'grafana-report-timestamp' || k =~ /grafana_default_(?:from|to)_timezone/
15
+ end
16
+ merge_variables(sel_doc_items.each_with_object({}) { |(k, v), h| h[k] = ::Grafana::Variable.new(v) })
17
+
18
+ sel_items = item_hash.select do |k, _v|
19
+ k =~ /^var-/ || k =~ /^render-/ || k =~ /filter_columns|format|replace_values_.*|transpose|column_divider|
20
+ row_divider|from_timezone|to_timezone/x
21
+ end
22
+ merge_variables(sel_items.each_with_object({}) { |(k, v), h| h[k] = ::Grafana::Variable.new(v) })
23
+
24
+ self.timeout = item_hash['timeout'] || document_hash['grafana-default-timeout'] || timeout
25
+ self.from = item_hash['from'] || document_hash['from'] || from
26
+ self.to = item_hash['to'] || document_hash['to'] || to
27
+ end
28
+
29
+ # Formats the SQL results returned from grafana to an easier to use format.
30
+ #
31
+ # The result is being formatted as stated below:
32
+ #
33
+ # {
34
+ # :header => [column_title_1, column_title_2],
35
+ # :content => [
36
+ # [row_1_column_1, row_1_column_2],
37
+ # [row_2_column_1, row_2_column_2]
38
+ # ]
39
+ # }
40
+ # @param raw_result [Hash] query result hash from grafana
41
+ # @return [Hash] sql result formatted as stated above
42
+ def preformat_sql_result(raw_result)
43
+ results = {}
44
+ results.default = []
45
+
46
+ JSON.parse(raw_result)['results'].each_value do |query_result|
47
+ if query_result.key?('error')
48
+ results[:header] = results[:header] << ['SQL Error']
49
+ results[:content] = [[query_result['error']]]
50
+
51
+ elsif query_result['tables']
52
+ query_result['tables'].each do |table|
53
+ results[:header] = results[:header] << table['columns'].map { |header| header['text'] }
54
+ results[:content] = table['rows']
55
+ end
56
+
57
+ end
58
+ end
59
+
60
+ results
61
+ end
62
+
63
+ # Transposes the given result.
64
+ #
65
+ # NOTE: Only the +:content+ of the given result hash is transposed. The +:header+ is ignored.
66
+ #
67
+ # @param result [Hash] preformatted sql hash, (see {#preformat_sql_result})
68
+ # @param transpose_variable [Grafana::Variable] true, if the result hash shall be transposed
69
+ # @return [Hash] transposed query result
70
+ def transpose(result, transpose_variable)
71
+ return result unless transpose_variable
72
+ return result unless transpose_variable.raw_value == 'true'
73
+
74
+ result[:content] = result[:content].transpose
75
+
76
+ result
77
+ end
78
+
79
+ # Filters columns out of the query result.
80
+ #
81
+ # Multiple columns may be filtered. Therefore the column titles have to be named in the
82
+ # {Grafana::Variable#raw_value} and have to be separated by +,+ (comma).
83
+ # @param result [Hash] preformatted sql hash, (see {#preformat_sql_result})
84
+ # @param filter_columns_variable [Grafana::Variable] column names, which shall be removed in the query result
85
+ # @return [Hash] filtered query result
86
+ def filter_columns(result, filter_columns_variable)
87
+ return result unless filter_columns_variable
88
+
89
+ filter_columns = filter_columns_variable.raw_value
90
+ filter_columns.split(',').each do |filter_column|
91
+ pos = result[:header][0].index(filter_column)
92
+
93
+ unless pos.nil?
94
+ result[:header][0].delete_at(pos)
95
+ result[:content].each { |row| row.delete_at(pos) }
96
+ end
97
+ end
98
+
99
+ result
100
+ end
101
+
102
+ # Uses the {Kernel#format} method to format values in the query results.
103
+ #
104
+ # The formatting will be applied separately for every column. Therefore the column formats have to be named
105
+ # in the {Grafana::Variable#raw_value} and have to be separated by +,+ (comma). If no value is specified for
106
+ # a column, no change will happen.
107
+ # @param result [Hash] preformatted sql hash, (see {#preformat_sql_result})
108
+ # @param formats [Grafana::Variable] formats, which shall be applied to the columns in the query result
109
+ # @return [Hash] formatted query result
110
+ # TODO: make sure that caught errors are also visible in logger
111
+ def format_columns(result, formats)
112
+ return result unless formats
113
+
114
+ formats.text.split(',').each_index do |i|
115
+ format = formats.text.split(',')[i]
116
+ next if format.empty?
117
+
118
+ result[:content].map do |row|
119
+ next unless row.length > i
120
+
121
+ begin
122
+ row[i] = format % row[i] if row[i]
123
+ rescue StandardError => e
124
+ row[i] = e.message
125
+ end
126
+ end
127
+ end
128
+ result
129
+ end
130
+
131
+ # Used to replace values in a query result according given configurations.
132
+ #
133
+ # The given variables will be applied to an appropriate column, depending
134
+ # on the naming of the variable. The variable name ending specifies the column,
135
+ # e.g. a variable named +replace_values_2+ will be applied to the second column.
136
+ #
137
+ # The {Grafana::Variable#text} needs to contain the replace specification.
138
+ # Multiple replacements can be specified by separating them with +,+. If a
139
+ # literal comma is needed, it can be escaped with a backslash: +\\,+.
140
+ #
141
+ # The rule will be separated from the replacement text with a colon +:+.
142
+ # If a literal colon is wanted, it can be escaped with a backslash: +\\:+.
143
+ #
144
+ # Examples:
145
+ # - Basic string replacement
146
+ # MyTest:ThisValue
147
+ # will replace all occurences of the text 'MyTest' with 'ThisValue'.
148
+ # - Number comparison
149
+ # <=10:OK
150
+ # will replace all values smaller or equal to 10 with 'OK'.
151
+ # - Regular expression
152
+ # ^[^ ]\\+ (\d+)$:\1 is the answer
153
+ # will replace all values matching the pattern, e.g. 'answerToAllQuestions 42' to
154
+ # '42 is the answer'. Important to know: the regular expressions always have to start
155
+ # with +^+ and end with +$+, i.e. the expression itself always has to match
156
+ # the whole content in one field.
157
+ # @param result [Hash] preformatted query result (see {#preformat_sql_result}.
158
+ # @param configs [Array<Grafana::Variable>] one variable for replacing values in one column
159
+ # @return [Hash] query result with replaced values
160
+ # TODO: make sure that caught errors are also visible in logger
161
+ def replace_values(result, configs)
162
+ return result if configs.empty?
163
+
164
+ configs.each do |key, formats|
165
+ cols = key.split('_')[2..-1].map(&:to_i)
166
+
167
+ formats.text.split(/(?<!\\),/).each_index do |j|
168
+ format = formats.text.split(/(?<!\\),/)[j]
169
+
170
+ arr = format.split(/(?<!\\):/)
171
+ raise MalformedReplaceValuesStatementError, format if arr.length != 2
172
+
173
+ k = arr[0]
174
+ v = arr[1]
175
+ k.gsub!(/\\([:,])/, '\1')
176
+ v.gsub!(/\\([:,])/, '\1')
177
+ result[:content].map do |row|
178
+ (row.length - 1).downto 0 do |i|
179
+ if cols.include?(i + 1) || cols.empty?
180
+
181
+ # handle regular expressions
182
+ if k.start_with?('^') && k.end_with?('$')
183
+ begin
184
+ row[i] = row[i].to_s.gsub(/#{k}/, v) if row[i].to_s =~ /#{k}/
185
+ rescue StandardError => e
186
+ row[i] = e.message
187
+ end
188
+
189
+ # handle value comparisons
190
+ elsif (match = k.match(/^ *(?<operator>[<>]=?|<>|=) *(?<number>[+-]?\d+(?:\.\d+)?)$/))
191
+ skip = false
192
+ begin
193
+ val = Float(row[i])
194
+ rescue StandardError
195
+ # value cannot be converted to number, simply ignore it as the comparison does not fit here
196
+ skip = true
197
+ end
198
+
199
+ unless skip
200
+ begin
201
+ op = match[:operator].gsub(/^=$/, '==').gsub(/^<>$/, '!=')
202
+ if val.public_send(op.to_sym, Float(match[:number]))
203
+ row[i] = if v.include?('\\1')
204
+ v.gsub(/\\1/, row[i].to_s)
205
+ else
206
+ v
207
+ end
208
+ end
209
+ rescue StandardError => e
210
+ row[i] = e.message
211
+ end
212
+ end
213
+
214
+ # handle as normal comparison
215
+ elsif row[i].to_s == k
216
+ row[i] = v
217
+ end
218
+ end
219
+ end
220
+ end
221
+ end
222
+ end
223
+
224
+ result
225
+ end
226
+
227
+ # Used to translate the relative date strings used by grafana, e.g. +now-5d/w+ to the
228
+ # correct timestamp. Reason is that grafana does this in the frontend, which we have
229
+ # to emulate here for the reporter.
230
+ #
231
+ # Additionally providing this function the +report_time+ assures that all queries
232
+ # rendered within one report will use _exactly_ the same timestamp in those relative
233
+ # times, i.e. there shouldn't appear any time differences, no matter how long the
234
+ # report is running.
235
+ # @param orig_date [String] time string provided by grafana, usually +from+ or +to+.
236
+ # @param report_time [Grafana::Variable] report start time
237
+ # @param is_to_time [Boolean] true, if the time should be calculated for +to+, false if it shall be
238
+ # calculated for +from+
239
+ # @param timezone [Grafana::Variable] timezone to use, if not system timezone
240
+ # @return [String] translated date as timestamp string
241
+ def translate_date(orig_date, report_time, is_to_time, timezone = nil)
242
+ report_time ||= Variable.new(Time.now.to_s)
243
+ return (DateTime.parse(report_time.raw_value).to_time.to_i * 1000).to_s unless orig_date
244
+ return orig_date if orig_date =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/
245
+ return orig_date if orig_date =~ /^\d+$/
246
+
247
+ # replace grafana from and to values using now, now-2d etc.
248
+ date_splitted = orig_date.match(%r{^(?<now>now)(?:-(?<sub_count>\d+)?(?<sub_unit>[smhdwMy]?))?(?:/(?<fit>[smhdwMy]))?$})
249
+ raise TimeRangeUnknownError, orig_date unless date_splitted
250
+
251
+ date = DateTime.parse(report_time.raw_value)
252
+ # TODO: allow from_translated or similar in ADOC template
253
+ date = date.new_offset(timezone.raw_value) if timezone
254
+
255
+ # substract specified time
256
+ count = 1
257
+ count = date_splitted[:sub_count].to_i if date_splitted[:sub_count]
258
+ case date_splitted[:sub_unit]
259
+ when 's'
260
+ date = (date.to_time - (count * 1)).to_datetime
261
+ when 'm'
262
+ date = (date.to_time - (count * 60)).to_datetime
263
+ when 'h'
264
+ date = (date.to_time - (count * 60 * 60)).to_datetime
265
+ when 'd'
266
+ date = date.prev_day(count)
267
+ when 'w'
268
+ date = date.prev_day(count * 7)
269
+ when 'M'
270
+ date = date.prev_month(count)
271
+ when 'y'
272
+ date = date.prev_year(count)
273
+ end
274
+
275
+ # fit to specified time frame
276
+ case date_splitted[:fit]
277
+ when 's'
278
+ date = DateTime.new(date.year, date.month, date.day, date.hour, date.min, date.sec, date.zone)
279
+ date = (date.to_time + 1).to_datetime if is_to_time
280
+ when 'm'
281
+ date = DateTime.new(date.year, date.month, date.day, date.hour, date.min, 0, date.zone)
282
+ date = (date.to_time + 60).to_datetime if is_to_time
283
+ when 'h'
284
+ date = DateTime.new(date.year, date.month, date.day, date.hour, 0, 0, date.zone)
285
+ date = (date.to_time + 60 * 60).to_datetime if is_to_time
286
+ when 'd'
287
+ date = DateTime.new(date.year, date.month, date.day, 0, 0, 0, date.zone)
288
+ date = date.next_day(1) if is_to_time
289
+ when 'w'
290
+ date = DateTime.new(date.year, date.month, date.day, 0, 0, 0, date.zone)
291
+ date = if date.wday.zero?
292
+ date.prev_day(7)
293
+ else
294
+ date.prev_day(date.wday - 1)
295
+ end
296
+ date = date.next_day(7) if is_to_time
297
+ when 'M'
298
+ date = DateTime.new(date.year, date.month, 1, 0, 0, 0, date.zone)
299
+ date = date.next_month if is_to_time
300
+ when 'y'
301
+ date = DateTime.new(date.year, 1, 1, 0, 0, 0, date.zone)
302
+ date = date.next_year if is_to_time
303
+ end
304
+
305
+ # step back one second, if this is the 'to' time
306
+ date = (date.to_time - 1).to_datetime if is_to_time
307
+
308
+ (Time.at(date.to_time.to_i).to_i * 1000).to_s
309
+ end
310
+ end
311
+ end
312
+ end