forked from weaveworks/grafanalib
-
Notifications
You must be signed in to change notification settings - Fork 2
/
CHANGELOG.rst
568 lines (415 loc) · 17.5 KB
/
CHANGELOG.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
=========
Changelog
=========
0.x.x (?)
* Add `QueryMode` parameter in CloudwatchMetricsTarget
* Added support `alias` via the `legendFormat` option for `Target`
* Added `neutral` option for `GaugePanel` (supported by Grafana 9.3.0 - https://github.com/grafana/grafana/discussions/38273)
* Added support `alias` via the `legendFormat` option for `Target`
* **Breaking change:** Fixed spelling errors for temperature units, corrected 'CELSUIS' to 'CELSIUS' and 'FARENHEIT' to 'FAHRENHEIT'.
* Added ``tooltipSort`` parameter to PieChartv2 panel
* Fix mappings for Table
* Added support for AWS Cross-Account in CloudwatchMetricsTarget
* Added `LokiTarget`
0.7.1 2024-01-12
================
* Extended DashboardLink to support links to dashboards and urls, as per the docs_
.. _`docs`: https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links
* Fix default options for Heatmap
* Add Unit option for Graph panel
* Added Minimum option for Timeseries
* Added Maximum option for Timeseries
* Added Number of decimals displays option for Timeseries
* Added Bar_Chart_ panel support
* Extended SqlTarget to support parsing queries from files
* Fix AlertCondition backwards compatibility (``useNewAlerts`` default to ``False``)
* Added RateMetricAgg_ for ElasticSearch
* added axisSoftMin and axisSoftMax options for TimeSeries
* Added support for Azure Data Explorer datasource plugin (https://github.com/grafana/azure-data-explorer-datasource)
* Added ``sortBy`` parameter to Table panel
* Added ``tooltipSort`` parameter to TimeSeries panel
* Added unit parameter to the Table class in core
* Added a hide parameter to ElasticsearchTarget
* Fix value literal GAUGE_CALC_TOTAL to sum instead of total
* Fix `BarGauge` orientation validation to accept `'auto'`
.. _`Bar_Chart`: https://grafana.com/docs/grafana/latest/panels-visualizations/visualizations/bar-chart/
.. _`RateMetricAgg`: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html
0.7.0 (2022-10-02)
==================
* Added Grafana 8.x new Alert Rule
* Added Grafana 9.x new Alert Rule
* Added ePict_ plugin.
* Added ae3e plotly panel support
* Added datasource parameter to Influxdb targets
* Added missing units for Boolean, Data, Data Rate, Date & Time, Energy, Length,
Mass, and Misc
* Fix typo in unit constant ``GIGA_WATT`` (was ``GAGA_WATT``)
* Fix typo in unit constant ``NORMAL_CUBIC_METER`` (was ``NORMAIL_CUBIC_METER``)
.. _`ePict`: https://grafana.com/grafana/plugins/larona-epict-panel/
0.6.3 (2022-03-30)
==================
* Added Azure Monitor Target
* Added ``legendCalcs`` parameter to TimeSeries Panel
* Added ``hide`` parameter to ElasticsearchTarget
* Added ExpressionTarget support for ElasticSearch data sources
0.6.2 (2022-02-24)
==================
* Added percentage type for thresholds
* Added ``datasource`` parameter to CloudWatch targets
* Added support for auto panels ids to AlertList panel
* Added ``SeriesOverride`` options (dashes and Z-index)
* Added support for fields value in Stat panel
* Added ``alertName`` parameter to AlertList panel
* Added ``thresholdsStyleMode`` parameter to TimeSeries panel
* Added Histogram panel support
* Dashboard upload script updated to support overwriting dashboards
0.6.1 (2021-11-23)
==================
* Added new SqlTarget to core to be able to define SQL queries as well
* Added missing attributes to the Logs panel
* Added Cloudwatch Logs Insights Target
* Added overrides to panels
* Extend ``SeriesOverride`` options
Changes
-------
* Fix Text panel (and add tests)
**ATTENTION:** This might break panels generated for Grafana <8.0.6
0.6.0 (2021-10-26)
===================
* Added Discrete panel (https://grafana.com/grafana/plugins/natel-discrete-panel/)
* Added support for colors in stat mapping panel with StatValueMappings & StatRangeMappings
* Added missing auto interval properties in Template
* Added param to RowPanel to collapse the row
* Added StateTimeline panel which was added in Grafana v8
* Added support for timeseries panel added in Grafana v8
* Added MinMetricAgg and PercentilesMetricAgg to Elasticsearch
* Added support for News panel
* Added support for Pie Chart v2 from Grafana v8
Changes
-------
* Refine expectations of is_color_code
* Deprecated StatMapping, StatValueMapping & StatRangeMapping
* Change YAxis min value default from 0 to None
* Support for Table panel for Grafana v8 may have broken backwards compatibility in old Table panel
* Breaking change, support for styled columns in tables removed, no longer used in Grafana v8 new Table
* Move development to ``main`` branch on GitHub. If you have work tracking the ``master`` you will need to update this.
0.5.14 (2021-09-14)
==================
* Added colour overrides to pie chart panel
* Added missing attributes from xAxis class
* Added transformations for the Panel class (https://grafana.com/docs/grafana/latest/panels/reference-transformation-functions/)
* Added Worldmap panel (https://grafana.com/grafana/plugins/grafana-worldmap-panel/)
* Added missing fill gradient to Graph panel
* Added missing align to graph panel
* Added missing show percentage attribute to Pie chart panel
* Added ``extraJson`` attribute to the Panel class for overriding the panel with raw JSON
* Added inline script support for Elasticsearch metrics
* Selected needs to be set as a bool value for templating to work.
0.5.13 (2021-05-17)
===================
* Added a test for the Alert class.
Changes
-------
* Bugfix: changed 'target' validator in AlertNotification to accept CloudwatchMetricsTarget
* Moved the alertRuleTag field from Graph to Alert.
0.5.12 (2021-04-24)
===================
* Added hide parameter to CloudwatchMetricsTarget class
* Added table-driven example dashboard and upload script
Changes
-------
* bugfix load_dashboard add support for old python version 2.x, 3.3 and 3.4
* Fix default target datasource to work with newer versions of Grafana
* Removed re-defined maxDataPoints field from multiple panels
* Fix the AlertList class and add a test for it
Thanks to all those who have contributed to this release.
0.5.11 (2021-04-06)
===================
* Added timeField field for the Elasticsearch target to allow the alert to change its state
* Added nameFilter field for the AlertList panel
* Added dashboardTags field for the AlertList panel
Thanks a lot for your contributions to this release, @dafna-starkware
0.5.10 (2021-03-21)
===================
* Added Logs panel (https://grafana.com/docs/grafana/latest/panels/visualizations/logs-panel/)
* Added Cloudwatch metrics datasource (https://grafana.com/docs/grafana/latest/datasources/cloudwatch/)
* Added option to hide dashboard time picker
* Added Notification for Alert
* Added alertRuleTags field to the graph panel
* Added support for thresholds to graph panel
* Added support for Elasticsearch alert condition
* Added support for using gridPos for dashboard panels
* Added support for Humio Data Source. (https://grafana.com/grafana/plugins/humio-datasource/)
Changes
-------
* Replace deprecated attr.assoc with attr.evolve
0.5.9 (2020-12-18)
==================
* Added Alert Threshold enabled/disabled to Graphs.
* Added constants for all Grafana value formats
* Added support for repetitions to Stat Panels
* Added textMode option to Stat Panels
* Add Panel object for all panels to inherit from
* Add Dashboard list panel (https://grafana.com/docs/grafana/latest/panels/visualizations/dashboard-list-panel/)
Changes
-------
* Change supported python versions from 3.6 to 3.9
* Added hide parameter to Target
* Updated dependencies (docs, build, CI)
* Consistent coding style
0.5.8 (2020-11-02)
==================
This release adds quite a few new classes to grafanalib, ElasticSearch support was improved and support for InfluxDB data sources was added.
We would also very much like to welcome James Gibson as new maintainer of grafanalib. Thanks a lot for stepping up to this role!
Changes
-------
* Added more YAxis formats, added Threshold and SeriesOverride types
* dataLinks support in graphs
* Add Elasticsearch bucket script pipeline aggregator
* Added ability to hide metrics for Elasticsearch MetricAggs
* Add derivative metric aggregation for Elasticsearch
* Add ``Stat`` class (and ``StatMapping``, ``StatValueMapping``, ``StatRangeMapping``) to support the Stat panel
* Add ``Svg`` class to support the SVG panel
* Add ``PieChart`` class for creating Pie Chart panels
* Add `transparent` setting to classes that were missing it (Heatmap, PieChart)
* Add InfluxDB data source
* Add ``auto_ref_ids`` to ``Graph``
Thanks a lot for your contributions to this release, @DWalker487, @JamesGibo, @daveworth, @dholbach, @fauust, @larsderidder, @matthewmrichter.
0.5.7 (2020-05-11)
==================
Changes
-------
* Fix crasher instatiating elasticsearch panels.
* Remove unused ``tools/`` directory.
Thanks a lot for your contributions to this release, @DWalker487, @dholbach and @matthewmrichter.
0.5.6 (2020-05-05)
==================
Changes
-------
* Add ``Heatmap`` class (and ``HeatmapColor``) to support the Heatmap panel (#170)
* Add ``BarGuage`` for creating bar guages panels in grafana 6
* Add ``GuagePanel`` for creating guages in grafana 6
* Add data links support to ``Graph``, ``BarGuage``, and ``GuagePanel`` panels
* Removed gfdatasource - feature is built in to Grafana since v5.
* Generate API docs for readthedocs.org
* Fix AlertList panel generation
* Add both upper and lower case `"time"` pattern for time_series column format in Table class
* Drop testing of Python 2.7, it has been EOL'ed and CI was broken
due to this.
* Automatically test documentation examples.
* Point to dev meeting resources.
* Add description attribute to Dashboard.
* Add support for custom variables.
* Point out documentation on readthedocs more clearly.
* Add average metric aggregation for elastic search
* Bugfix to query ordering in Elasticsearch TermsGroupBy
* Added all parameters for StringColumnStyle
* Add Elasticsearch Sum metric aggregator
* Add ``Statusmap`` class (and ``StatusmapColor``) to support the Statusmap panel plugin
* Bugfix to update default ``Threshold`` values for ``GaugePanel`` and ``BarGauge``
* Use Github Actions for CI.
* Fix test warnings.
* Update ``BarGauge`` and ``GaugePanel`` default Threshold values.
* Update release instructions.
Thanks a lot to the contributions from @DWalker487, @bboreham, @butlerx, @dholbach, @franzs, @jaychitalia95, @matthewmrichter and @number492 for this release!
0.5.5 (2020-02-17)
==================
It's been a while since the last release and we are happy to get this one into your hands.
0.5.5 is a maintenance release, most importantly it adds support for Python >= 3.5.
We are very delighted to welcome Matt Richter on board as maintainer.
Changes
-------
* Automate publishing to PyPI with GitHub Actions
* Update README.rst to make the example work
* Bump Dockerfile to use Alpine 3.10 as base
* Fix up ``load_source()`` call which doesn't exist in Python 3.5
* Update versions of Python tested
* Repair tests
* pin to attrs 19.2 and fix deprecated arguments
Many thanks to contributors @bboreham, @dholbach, @ducksecops, @kevingessner, @matthewmrichter, @uritau.
0.5.4 (2019-08-30)
==================
Changes
-------
* Add 'diff', 'percent_diff' and 'count_non_null' as RTYPE
* Support for changing sort value in Template Variables.
* Sort tooltips by value in Weave/Stacked-Charts
* Add ``for`` parameter for alerts on Grafana 6.X
* Add ``STATE_OK`` for alerts
* Add named values for the Template.hide parameter
* Add cardinality metric aggregator for ElasticSearch
* Add Threshold and Series Override types
* Add more YAxis formats
Many thanks to contributors @kevingessner, @2easy, @vicmarbev, @butlerx.
0.5.3 (2018-07-19)
==================
Changes
-------
* Minor markup tweaks to the README
0.5.9 (2019-05-12)
0.5.10 (2020-04-14)
===================
=======
>>>>>>> main
0.6.1 (2020-04-23)
==================
* Set default refresh to 1m instead of 10s to reduce load on metric sources.
* Set sharedCrosshair to default=true.
0.6.0
===================
* Fix tests
0.5.9 (2019-05-21)
==================
Fixes
-----
* Change Tooltip valueType default from CUMULATIVE to INDIVIDUAL for stacked graphs.
0.5.8 (2019-04-09)
==================
Fixes
-----
* Add 'decimals' field to the Graph class to dictate significant digits in Grafana legend
0.5.7 (2019-04-01)
==================
Fixes
-----
* Add `Annotation` model for defining dashboard annotations
0.5.6 (2019-02-21)
==================
Fixes
-----
* Set row.title to "" instead of None to get row behavior.
0.5.5 (2019-02-13)
==================
Fixes
-----
* Merged in https://github.com/weaveworks/grafanalib/pull/143 to support custom variables
0.5.4 (2019-02-08)
==================
Fixes
-----
* Added more base units
New features
------------
* Added an AJAX panel plugin object
0.5.2 (2018-07-19)
==================
Fixes
-----
* ``PromGraph`` was losing all its legends. It doesn't any more. (`#130`_)
.. _`#130`: https://github.com/weaveworks/grafanalib/pull/130
Changes
-------
* Add ``AlertList`` panel support
* Add support for mixed data sources
* Add ``ExternalLink`` class for dashboard-level links to other pages
* Template now supports 'type' and 'hide' attributes
* Legend now supports ``sort`` and ``sortDesc`` attributes
* Tables now support ``timeFrom`` attribute
* Update README.rst with information on how to get help.
0.5.1 (2018-02-27)
==================
Fixes
-----
* Fix for crasher bug that broke ``SingleStat``, introduced by `#114`_
.. _`#114`: https://github.com/weaveworks/grafanalib/pull/114
0.5.0 (2018-02-26)
==================
New features
------------
* grafanalib now supports Python 2.7. This enables it to be used within `Bazel <https://bazel.build>`_.
* Partial support for graphs against Elasticsearch datasources (https://github.com/weaveworks/grafanalib/pull/99)
Extensions
----------
* Constants for days, hours, and minutes (https://github.com/weaveworks/grafanalib/pull/98)
* Groups and tags can now be used with templates (https://github.com/weaveworks/grafanalib/pull/97)
0.4.0 (2017-11-23)
==================
Massive release!
It's Thanksgiving today, so more than ever I want to express my gratitude to
all the people who have contributed to this release!
* @aknuds1
* @atopuzov
* @bboreham
* @fho
* @filippog
* @gaelL
* @lalinsky
* @leth
* @lexfrei
* @mikebryant
New features
------------
* Support for ``Text`` panels
(https://github.com/weaveworks/grafanalib/pull/63)
* ``PromGraph`` is now more powerful.
If you want to pass extra parameters like ``intervalFactor`` to your
targets, you can do so by listing targets as dictionaries,
rather than tuples.
(https://github.com/weaveworks/grafanalib/pull/66)
* Support for absolute links to drill-down in graphs
(https://github.com/weaveworks/grafanalib/pull/86)
Changes
-------
* Breaking change to ``weave.QPSGraph()`` - added ``data_source``
parameter and removed old hard-coded setting.
(https://github.com/weaveworks/grafanalib/pull/77)
Extensions
----------
Generally adding more parameters to existing things:
* Graphs can now have descriptions or be transparent
(https://github.com/weaveworks/grafanalib/pull/62 https://github.com/weaveworks/grafanalib/pull/89)
* New formats: "bps" and "Bps"
(https://github.com/weaveworks/grafanalib/pull/68)
* Specify the "Min step" for a ``Target``
using the ``interval`` attribute.
* Specify the number of decimals shown on the ``YAxis``
with the ``decimals`` attribute
* Specify multiple ``Dashboard`` inputs,
allowing dashboards to be parametrized by data source.
(https://github.com/weaveworks/grafanalib/pull/83)
* Templates
* ``label`` is now optional (https://github.com/weaveworks/grafanalib/pull/92)
* ``allValue`` and ``includeAll`` attributes now available (https://github.com/weaveworks/grafanalib/pull/67)
* ``regex`` and ``multi`` attributes now available (https://github.com/weaveworks/grafanalib/pull/82)
* Rows can now repeat (https://github.com/weaveworks/grafanalib/pull/82)
* Add missing ``NULL_AS_NULL`` constant
* Specify the "Instant" for a ``Target`` using the ``instant`` attribute.
Fixes
-----
* The ``showTitle`` parameter in ``Row`` is now respected
(https://github.com/weaveworks/grafanalib/pull/80)
0.3.0 (2017-07-27)
==================
New features
------------
* OpenTSDB datasource support (https://github.com/weaveworks/grafanalib/pull/27)
* Grafana Zabbix plugin support
(https://github.com/weaveworks/grafanalib/pull/31, https://github.com/weaveworks/grafanalib/pull/36)
* ``Dashboard`` objects now have an ``auto_panel_id`` method which will
automatically supply unique panel (i.e. graph) IDs for any panels that don't
have one set. Dashboard config files no longer need to track their own
``GRAPH_ID`` counter.
* Support for ``SingleStat`` panels
(https://github.com/weaveworks/grafanalib/pull/22)
* ``single_y_axis`` helper for the common case of a graph that has only one Y axis
Improvements
------------
* ``PromGraph`` now lives in ``grafanalib.prometheus``, and takes a
``data_source`` parameter
* Additional fields for ``Legend`` (https://github.com/weaveworks/grafanalib/pull/25)
* Additional fields for ``XAxis``
(https://github.com/weaveworks/grafanalib/pull/28)
* Get an error when you specify the wrong number of Y axes
Changes
-------
* New ``YAxes`` type for specifying Y axes. Using a list of two ``YAxis``
objects is deprecated.
0.1.2 (2017-01-02)
==================
* Add support for Grafana Templates (https://github.com/weaveworks/grafanalib/pull/9)
0.1.1 (2016-12-02)
==================
* Include README on PyPI page
0.1.0 (2016-12-02)
==================
Initial release.