@grafana/viz-contract 1.1.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 (173) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/LICENSE +201 -0
  3. package/README.md +140 -0
  4. package/fixtures/epoch-range/args.json +14 -0
  5. package/fixtures/epoch-range/meta.json +4 -0
  6. package/fixtures/epoch-range/request.json +17 -0
  7. package/fixtures/epoch-range/response.json +114 -0
  8. package/fixtures/epoch-range/result.json +252 -0
  9. package/fixtures/epoch-range/spec.json +141 -0
  10. package/fixtures/epoch-range/state.json +4 -0
  11. package/fixtures/error-all-queries-failed/spec.json +45 -0
  12. package/fixtures/error-all-queries-failed/state.json +8 -0
  13. package/fixtures/error-invalid-spec/spec.json +25 -0
  14. package/fixtures/error-invalid-spec/state.json +8 -0
  15. package/fixtures/error-unsupported-panel-type/spec.json +1372 -0
  16. package/fixtures/error-unsupported-panel-type/state.json +8 -0
  17. package/fixtures/error-unsupported-spec-version/spec.json +1372 -0
  18. package/fixtures/error-unsupported-spec-version/state.json +8 -0
  19. package/fixtures/hostile-label/args.json +14 -0
  20. package/fixtures/hostile-label/meta.json +4 -0
  21. package/fixtures/hostile-label/request.json +17 -0
  22. package/fixtures/hostile-label/response.json +420 -0
  23. package/fixtures/hostile-label/result.json +558 -0
  24. package/fixtures/hostile-label/spec.json +447 -0
  25. package/fixtures/hostile-label/state.json +4 -0
  26. package/fixtures/no-data/args.json +14 -0
  27. package/fixtures/no-data/meta.json +4 -0
  28. package/fixtures/no-data/request.json +17 -0
  29. package/fixtures/no-data/response.json +40 -0
  30. package/fixtures/no-data/result.json +178 -0
  31. package/fixtures/no-data/spec.json +67 -0
  32. package/fixtures/no-data/state.json +4 -0
  33. package/fixtures/partial-error/args.json +20 -0
  34. package/fixtures/partial-error/meta.json +4 -0
  35. package/fixtures/partial-error/request.json +28 -0
  36. package/fixtures/partial-error/response.json +220 -0
  37. package/fixtures/partial-error/result.json +358 -0
  38. package/fixtures/partial-error/spec.json +253 -0
  39. package/fixtures/partial-error/state.json +9 -0
  40. package/fixtures/pick-annotations-only/args.json +10 -0
  41. package/fixtures/pick-annotations-only/meta.json +4 -0
  42. package/fixtures/pick-annotations-only/response.json +41 -0
  43. package/fixtures/pick-annotations-only/result.json +53 -0
  44. package/fixtures/pick-categories/args.json +10 -0
  45. package/fixtures/pick-categories/meta.json +4 -0
  46. package/fixtures/pick-categories/response.json +58 -0
  47. package/fixtures/pick-categories/result.json +116 -0
  48. package/fixtures/pick-empty-result/args.json +10 -0
  49. package/fixtures/pick-empty-result/meta.json +4 -0
  50. package/fixtures/pick-empty-result/response.json +11 -0
  51. package/fixtures/pick-empty-result/result.json +23 -0
  52. package/fixtures/pick-failed-query-with-frames/args.json +10 -0
  53. package/fixtures/pick-failed-query-with-frames/meta.json +4 -0
  54. package/fixtures/pick-failed-query-with-frames/response.json +43 -0
  55. package/fixtures/pick-failed-query-with-frames/result.json +131 -0
  56. package/fixtures/pick-few-parts/args.json +10 -0
  57. package/fixtures/pick-few-parts/meta.json +4 -0
  58. package/fixtures/pick-few-parts/response.json +40 -0
  59. package/fixtures/pick-few-parts/result.json +98 -0
  60. package/fixtures/pick-heatmap-cells/args.json +10 -0
  61. package/fixtures/pick-heatmap-cells/meta.json +4 -0
  62. package/fixtures/pick-heatmap-cells/response.json +55 -0
  63. package/fixtures/pick-heatmap-cells/result.json +143 -0
  64. package/fixtures/pick-log-lines/args.json +10 -0
  65. package/fixtures/pick-log-lines/meta.json +4 -0
  66. package/fixtures/pick-log-lines/response.json +49 -0
  67. package/fixtures/pick-log-lines/result.json +76 -0
  68. package/fixtures/pick-no-rows/args.json +10 -0
  69. package/fixtures/pick-no-rows/meta.json +4 -0
  70. package/fixtures/pick-no-rows/response.json +32 -0
  71. package/fixtures/pick-no-rows/result.json +120 -0
  72. package/fixtures/pick-node-graph/args.json +10 -0
  73. package/fixtures/pick-node-graph/meta.json +4 -0
  74. package/fixtures/pick-node-graph/response.json +77 -0
  75. package/fixtures/pick-node-graph/result.json +89 -0
  76. package/fixtures/pick-numeric-only/args.json +10 -0
  77. package/fixtures/pick-numeric-only/meta.json +4 -0
  78. package/fixtures/pick-numeric-only/response.json +40 -0
  79. package/fixtures/pick-numeric-only/result.json +89 -0
  80. package/fixtures/pick-single-stat/args.json +10 -0
  81. package/fixtures/pick-single-stat/meta.json +4 -0
  82. package/fixtures/pick-single-stat/response.json +29 -0
  83. package/fixtures/pick-single-stat/result.json +69 -0
  84. package/fixtures/pick-time-series-instant/args.json +10 -0
  85. package/fixtures/pick-time-series-instant/meta.json +4 -0
  86. package/fixtures/pick-time-series-instant/response.json +40 -0
  87. package/fixtures/pick-time-series-instant/result.json +128 -0
  88. package/fixtures/pick-time-series-long/args.json +10 -0
  89. package/fixtures/pick-time-series-long/meta.json +4 -0
  90. package/fixtures/pick-time-series-long/response.json +61 -0
  91. package/fixtures/pick-time-series-long/result.json +167 -0
  92. package/fixtures/pick-time-series-multi-frame/args.json +10 -0
  93. package/fixtures/pick-time-series-multi-frame/meta.json +4 -0
  94. package/fixtures/pick-time-series-multi-frame/response.json +74 -0
  95. package/fixtures/pick-time-series-multi-frame/result.json +162 -0
  96. package/fixtures/pick-time-series-null-time/args.json +10 -0
  97. package/fixtures/pick-time-series-null-time/meta.json +4 -0
  98. package/fixtures/pick-time-series-null-time/response.json +40 -0
  99. package/fixtures/pick-time-series-null-time/result.json +128 -0
  100. package/fixtures/pick-time-series-single/args.json +10 -0
  101. package/fixtures/pick-time-series-single/meta.json +4 -0
  102. package/fixtures/pick-time-series-single/response.json +40 -0
  103. package/fixtures/pick-time-series-single/result.json +128 -0
  104. package/fixtures/pick-time-series-wide/args.json +10 -0
  105. package/fixtures/pick-time-series-wide/meta.json +4 -0
  106. package/fixtures/pick-time-series-wide/response.json +61 -0
  107. package/fixtures/pick-time-series-wide/result.json +149 -0
  108. package/fixtures/prometheus-line/args.json +14 -0
  109. package/fixtures/prometheus-line/meta.json +4 -0
  110. package/fixtures/prometheus-line/request.json +17 -0
  111. package/fixtures/prometheus-line/response.json +1344 -0
  112. package/fixtures/prometheus-line/result.json +1483 -0
  113. package/fixtures/prometheus-line/spec.json +1372 -0
  114. package/fixtures/prometheus-line/state.json +4 -0
  115. package/fixtures/smoke-barchart/spec.json +64 -0
  116. package/fixtures/smoke-barchart/state.json +4 -0
  117. package/fixtures/smoke-boxplot/spec.json +96 -0
  118. package/fixtures/smoke-boxplot/state.json +4 -0
  119. package/fixtures/smoke-bubble/spec.json +229 -0
  120. package/fixtures/smoke-bubble/state.json +4 -0
  121. package/fixtures/smoke-candlestick/spec.json +97 -0
  122. package/fixtures/smoke-candlestick/state.json +4 -0
  123. package/fixtures/smoke-chord/spec.json +72 -0
  124. package/fixtures/smoke-chord/state.json +4 -0
  125. package/fixtures/smoke-funnel/spec.json +62 -0
  126. package/fixtures/smoke-funnel/state.json +4 -0
  127. package/fixtures/smoke-geomap/spec.json +76 -0
  128. package/fixtures/smoke-geomap/state.json +4 -0
  129. package/fixtures/smoke-heatmap/spec.json +103 -0
  130. package/fixtures/smoke-heatmap/state.json +4 -0
  131. package/fixtures/smoke-histogram/spec.json +63 -0
  132. package/fixtures/smoke-histogram/state.json +4 -0
  133. package/fixtures/smoke-nodeGraph/spec.json +101 -0
  134. package/fixtures/smoke-nodeGraph/state.json +4 -0
  135. package/fixtures/smoke-parallel/spec.json +78 -0
  136. package/fixtures/smoke-parallel/state.json +4 -0
  137. package/fixtures/smoke-piechart/spec.json +62 -0
  138. package/fixtures/smoke-piechart/state.json +4 -0
  139. package/fixtures/smoke-radar/spec.json +82 -0
  140. package/fixtures/smoke-radar/state.json +4 -0
  141. package/fixtures/smoke-sankey/spec.json +72 -0
  142. package/fixtures/smoke-sankey/state.json +4 -0
  143. package/fixtures/smoke-state-timeline/spec.json +64 -0
  144. package/fixtures/smoke-state-timeline/state.json +4 -0
  145. package/fixtures/smoke-status-history/spec.json +64 -0
  146. package/fixtures/smoke-status-history/state.json +4 -0
  147. package/fixtures/smoke-streamgraph/spec.json +229 -0
  148. package/fixtures/smoke-streamgraph/state.json +4 -0
  149. package/fixtures/smoke-sunburst/spec.json +72 -0
  150. package/fixtures/smoke-sunburst/state.json +4 -0
  151. package/fixtures/smoke-timeseries/spec.json +163 -0
  152. package/fixtures/smoke-timeseries/state.json +4 -0
  153. package/fixtures/smoke-treemap/spec.json +72 -0
  154. package/fixtures/smoke-treemap/state.json +4 -0
  155. package/fixtures/too-large/args.json +14 -0
  156. package/fixtures/too-large/meta.json +4 -0
  157. package/fixtures/type-mismatch/args.json +15 -0
  158. package/fixtures/type-mismatch/meta.json +4 -0
  159. package/fixtures/type-mismatch/request.json +17 -0
  160. package/fixtures/type-mismatch/response.json +1344 -0
  161. package/fixtures/type-mismatch/result.json +9 -0
  162. package/package.json +32 -0
  163. package/registry/chart-types.json +170 -0
  164. package/registry/constants.json +14 -0
  165. package/registry/notices.json +40 -0
  166. package/registry/panel-types.json +14 -0
  167. package/registry/pick.json +46 -0
  168. package/registry/states.json +85 -0
  169. package/renderer-api.d.ts +70 -0
  170. package/schemas/bundled/query-datasource-args.schema.json +86 -0
  171. package/schemas/bundled/registry.schema.json +375 -0
  172. package/schemas/bundled/tool-result.schema.json +245 -0
  173. package/schemas/bundled/viz-spec.schema.json +261 -0
@@ -0,0 +1,252 @@
1
+ {
2
+ "chart": "timeseries",
3
+ "panel": {
4
+ "type": "grafana-echartscartesian-panel",
5
+ "options": {
6
+ "seriesType": "line"
7
+ },
8
+ "fieldConfig": {
9
+ "defaults": {
10
+ "unit": "reqps"
11
+ }
12
+ }
13
+ },
14
+ "alternatives": [
15
+ {
16
+ "chart": "barchart",
17
+ "panel": {
18
+ "type": "grafana-echartscartesian-panel",
19
+ "options": {
20
+ "seriesType": "bar"
21
+ },
22
+ "fieldConfig": {
23
+ "defaults": {
24
+ "unit": "reqps"
25
+ }
26
+ }
27
+ }
28
+ },
29
+ {
30
+ "chart": "histogram",
31
+ "panel": {
32
+ "type": "grafana-echartscartesian-panel",
33
+ "options": {
34
+ "histogram": true
35
+ },
36
+ "fieldConfig": {
37
+ "defaults": {
38
+ "unit": "reqps"
39
+ }
40
+ }
41
+ }
42
+ },
43
+ {
44
+ "chart": "piechart",
45
+ "panel": {
46
+ "type": "grafana-echartsparttowhole-panel",
47
+ "options": {
48
+ "seriesType": "pie"
49
+ },
50
+ "fieldConfig": {
51
+ "defaults": {
52
+ "unit": "reqps"
53
+ }
54
+ }
55
+ }
56
+ },
57
+ {
58
+ "chart": "funnel",
59
+ "panel": {
60
+ "type": "grafana-echartsparttowhole-panel",
61
+ "options": {
62
+ "seriesType": "funnel"
63
+ },
64
+ "fieldConfig": {
65
+ "defaults": {
66
+ "unit": "reqps"
67
+ }
68
+ }
69
+ }
70
+ },
71
+ {
72
+ "chart": "heatmap",
73
+ "panel": {
74
+ "type": "grafana-echartsheatmap-panel",
75
+ "options": {},
76
+ "fieldConfig": {
77
+ "defaults": {
78
+ "unit": "reqps"
79
+ }
80
+ }
81
+ }
82
+ },
83
+ {
84
+ "chart": "state-timeline",
85
+ "panel": {
86
+ "type": "grafana-echartsstatetimeline-panel",
87
+ "options": {},
88
+ "fieldConfig": {
89
+ "defaults": {
90
+ "unit": "reqps"
91
+ }
92
+ }
93
+ }
94
+ },
95
+ {
96
+ "chart": "status-history",
97
+ "panel": {
98
+ "type": "grafana-echartsstatushistory-panel",
99
+ "options": {},
100
+ "fieldConfig": {
101
+ "defaults": {
102
+ "unit": "reqps"
103
+ }
104
+ }
105
+ }
106
+ },
107
+ {
108
+ "chart": "streamgraph",
109
+ "panel": {
110
+ "type": "grafana-echartsstream-panel",
111
+ "options": {
112
+ "streamChartType": "river"
113
+ },
114
+ "fieldConfig": {
115
+ "defaults": {
116
+ "unit": "reqps"
117
+ }
118
+ }
119
+ }
120
+ },
121
+ {
122
+ "chart": "bubble",
123
+ "panel": {
124
+ "type": "grafana-echartsstream-panel",
125
+ "options": {
126
+ "streamChartType": "bubble"
127
+ },
128
+ "fieldConfig": {
129
+ "defaults": {
130
+ "unit": "reqps"
131
+ }
132
+ }
133
+ }
134
+ }
135
+ ],
136
+ "data": {
137
+ "range": {
138
+ "from": 1790349877294,
139
+ "to": 1790353477294
140
+ },
141
+ "capturedAt": 1790353477806,
142
+ "results": {
143
+ "A": {
144
+ "status": 200,
145
+ "frames": [
146
+ {
147
+ "schema": {
148
+ "refId": "A",
149
+ "meta": {
150
+ "type": "timeseries-multi",
151
+ "typeVersion": [
152
+ 0,
153
+ 1
154
+ ]
155
+ },
156
+ "fields": [
157
+ {
158
+ "name": "Time",
159
+ "type": "time",
160
+ "typeInfo": {
161
+ "frame": "time.Time"
162
+ }
163
+ },
164
+ {
165
+ "name": "Value",
166
+ "type": "number",
167
+ "typeInfo": {
168
+ "frame": "float64"
169
+ },
170
+ "labels": {
171
+ "handler": "/api/ds/query"
172
+ },
173
+ "config": {
174
+ "displayNameFromDS": "/api/ds/query"
175
+ }
176
+ }
177
+ ]
178
+ },
179
+ "data": {
180
+ "values": [
181
+ [
182
+ 1790351737294,
183
+ 1790351797294,
184
+ 1790351857294,
185
+ 1790351917294,
186
+ 1790351977294,
187
+ 1790352037294,
188
+ 1790352097294,
189
+ 1790352157294,
190
+ 1790352217294,
191
+ 1790352277294,
192
+ 1790352337294,
193
+ 1790352397294,
194
+ 1790352457294,
195
+ 1790352517294,
196
+ 1790352577294,
197
+ 1790352637294,
198
+ 1790352697294,
199
+ 1790352757294,
200
+ 1790352817294,
201
+ 1790352877294,
202
+ 1790352937294,
203
+ 1790352997294,
204
+ 1790353057294,
205
+ 1790353117294,
206
+ 1790353177294,
207
+ 1790353237294,
208
+ 1790353297294,
209
+ 1790353357294,
210
+ 1790353417294,
211
+ 1790353477294
212
+ ],
213
+ [
214
+ 12,
215
+ 12.65,
216
+ 13.24,
217
+ 13.68,
218
+ 13.94,
219
+ 13.99,
220
+ 13.82,
221
+ 13.45,
222
+ 12.91,
223
+ 12.28,
224
+ 11.62,
225
+ 11,
226
+ 10.49,
227
+ 10.14,
228
+ 10,
229
+ 10.08,
230
+ 10.37,
231
+ 10.84,
232
+ 11.44,
233
+ 12.1,
234
+ 12.75,
235
+ 13.31,
236
+ 13.73,
237
+ 13.97,
238
+ 13.98,
239
+ 13.77,
240
+ 13.38,
241
+ 12.82,
242
+ 12.18,
243
+ 11.52
244
+ ]
245
+ ]
246
+ }
247
+ }
248
+ ]
249
+ }
250
+ }
251
+ }
252
+ }
@@ -0,0 +1,141 @@
1
+ {
2
+ "specVersion": 1,
3
+ "panel": {
4
+ "type": "grafana-echartscartesian-panel",
5
+ "options": {
6
+ "seriesType": "line"
7
+ },
8
+ "fieldConfig": {
9
+ "defaults": {
10
+ "unit": "reqps"
11
+ }
12
+ },
13
+ "datasource": {
14
+ "uid": "lgtm-prometheus"
15
+ },
16
+ "targets": [
17
+ {
18
+ "refId": "A",
19
+ "expr": "sum by (handler) (rate(grafana_http_request_duration_seconds_count[5m]))",
20
+ "legendFormat": "{{handler}}",
21
+ "format": "time_series"
22
+ }
23
+ ]
24
+ },
25
+ "data": {
26
+ "range": {
27
+ "from": 1790349877294,
28
+ "to": 1790353477294
29
+ },
30
+ "capturedAt": 1790353477806,
31
+ "results": {
32
+ "A": {
33
+ "status": 200,
34
+ "frames": [
35
+ {
36
+ "schema": {
37
+ "refId": "A",
38
+ "meta": {
39
+ "type": "timeseries-multi",
40
+ "typeVersion": [
41
+ 0,
42
+ 1
43
+ ]
44
+ },
45
+ "fields": [
46
+ {
47
+ "name": "Time",
48
+ "type": "time",
49
+ "typeInfo": {
50
+ "frame": "time.Time"
51
+ }
52
+ },
53
+ {
54
+ "name": "Value",
55
+ "type": "number",
56
+ "typeInfo": {
57
+ "frame": "float64"
58
+ },
59
+ "labels": {
60
+ "handler": "/api/ds/query"
61
+ },
62
+ "config": {
63
+ "displayNameFromDS": "/api/ds/query"
64
+ }
65
+ }
66
+ ]
67
+ },
68
+ "data": {
69
+ "values": [
70
+ [
71
+ 1790351737294,
72
+ 1790351797294,
73
+ 1790351857294,
74
+ 1790351917294,
75
+ 1790351977294,
76
+ 1790352037294,
77
+ 1790352097294,
78
+ 1790352157294,
79
+ 1790352217294,
80
+ 1790352277294,
81
+ 1790352337294,
82
+ 1790352397294,
83
+ 1790352457294,
84
+ 1790352517294,
85
+ 1790352577294,
86
+ 1790352637294,
87
+ 1790352697294,
88
+ 1790352757294,
89
+ 1790352817294,
90
+ 1790352877294,
91
+ 1790352937294,
92
+ 1790352997294,
93
+ 1790353057294,
94
+ 1790353117294,
95
+ 1790353177294,
96
+ 1790353237294,
97
+ 1790353297294,
98
+ 1790353357294,
99
+ 1790353417294,
100
+ 1790353477294
101
+ ],
102
+ [
103
+ 12,
104
+ 12.65,
105
+ 13.24,
106
+ 13.68,
107
+ 13.94,
108
+ 13.99,
109
+ 13.82,
110
+ 13.45,
111
+ 12.91,
112
+ 12.28,
113
+ 11.62,
114
+ 11,
115
+ 10.49,
116
+ 10.14,
117
+ 10,
118
+ 10.08,
119
+ 10.37,
120
+ 10.84,
121
+ 11.44,
122
+ 12.1,
123
+ 12.75,
124
+ 13.31,
125
+ 13.73,
126
+ 13.97,
127
+ 13.98,
128
+ 13.77,
129
+ 13.38,
130
+ 12.82,
131
+ 12.18,
132
+ 11.52
133
+ ]
134
+ ]
135
+ }
136
+ }
137
+ ]
138
+ }
139
+ }
140
+ }
141
+ }
@@ -0,0 +1,4 @@
1
+ {
2
+ "state": "ready",
3
+ "notices": []
4
+ }
@@ -0,0 +1,45 @@
1
+ {
2
+ "specVersion": 1,
3
+ "panel": {
4
+ "type": "grafana-echartscartesian-panel",
5
+ "options": {
6
+ "seriesType": "line"
7
+ },
8
+ "fieldConfig": {
9
+ "defaults": {
10
+ "unit": "reqps"
11
+ }
12
+ },
13
+ "datasource": {
14
+ "uid": "lgtm-prometheus"
15
+ },
16
+ "targets": [
17
+ {
18
+ "refId": "A",
19
+ "expr": "rate(x[5m]"
20
+ },
21
+ {
22
+ "refId": "B",
23
+ "expr": "sum(y)"
24
+ }
25
+ ]
26
+ },
27
+ "data": {
28
+ "range": {
29
+ "from": 1790267077294,
30
+ "to": 1790353477294
31
+ },
32
+ "capturedAt": 1790353477806,
33
+ "results": {
34
+ "A": {
35
+ "status": 400,
36
+ "error": "bad_data: invalid parameter \"query\": 1:10: parse error: unexpected end of input"
37
+ },
38
+ "B": {
39
+ "status": 504,
40
+ "error": "context deadline exceeded"
41
+ }
42
+ }
43
+ },
44
+ "grafanaUrl": "http://localhost:3000"
45
+ }
@@ -0,0 +1,8 @@
1
+ {
2
+ "state": "error",
3
+ "error": {
4
+ "code": "all-queries-failed",
5
+ "message": "Query A failed: bad_data: invalid parameter \"query\": 1:10: parse error: unexpected end of input\nQuery B failed: context deadline exceeded"
6
+ },
7
+ "notices": []
8
+ }
@@ -0,0 +1,25 @@
1
+ {
2
+ "specVersion": 1,
3
+ "panel": {
4
+ "type": "grafana-echartscartesian-panel",
5
+ "options": {
6
+ "seriesType": "line"
7
+ },
8
+ "fieldConfig": {
9
+ "defaults": {
10
+ "unit": "reqps"
11
+ }
12
+ },
13
+ "datasource": {
14
+ "uid": "lgtm-prometheus"
15
+ },
16
+ "targets": [
17
+ {
18
+ "refId": "A",
19
+ "expr": "sum by (handler) (rate(grafana_http_request_duration_seconds_count[5m]))",
20
+ "legendFormat": "{{handler}}",
21
+ "format": "time_series"
22
+ }
23
+ ]
24
+ }
25
+ }
@@ -0,0 +1,8 @@
1
+ {
2
+ "state": "error",
3
+ "error": {
4
+ "code": "invalid-spec",
5
+ "message": "The viz spec is not correct: data is missing."
6
+ },
7
+ "notices": []
8
+ }