Skip to content

Commit

Permalink
Merge pull request #15 from strava/poconnor/merge_upstream
Browse files Browse the repository at this point in the history
Bring our branch up to date with upstream
  • Loading branch information
pauloconnor committed Jun 30, 2023
2 parents 82b18a9 + 372d286 commit 2508870
Show file tree
Hide file tree
Showing 144 changed files with 7,787 additions and 6,517 deletions.
3 changes: 3 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length = 120
ignore = E501
11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

22 changes: 0 additions & 22 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,14 @@ build/
dist/
.uptodate
/.env
/junit-*.xml
test-results/junit-*.xml
/.cache
.ensure-*
/.tox
/.coverage
/venv*/
/.idea/
/.vscode/

# Documentation
docs/build
30 changes: 30 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.10"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
- method: setuptools
path: .
307 changes: 307 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,313 @@
Changelog
=========

<<<<<<< HEAD
0.x.x (?)
==================

* Added ...
* 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

.. _`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.
Expand Down
Loading

0 comments on commit 2508870

Please sign in to comment.