CHANGELOG.md

Changelog

2.6.0 (2024-02-16)

Features

• add Error Budget Consumed Ratio metric to reports and BigQuery exporter (#416) (3b1f636)

Bug Fixes

• ci: pin safety to v2 as v3 causes unit tests to fail (#423) (5b44bad)
• deps: bump version of pip to avoid known CVE (#397) (b1edb12)
• open_search: change the way range is added to filters (#400) (c221464)

2.5.2 (2023-11-10)

Bug Fixes

• add query_bad option to Datadog backend (#377) (6ecc728)

2.5.1 (2023-10-13)

Bug Fixes

• get_human_time() should not hard-code the human-readable timezone (#350) (1948694)

2.5.0 (2023-10-11)

Features

• add support for OpenSearch backend (#348) (f7bb0d9)
• upgrade google-* packages (#354) (e18fe5d)

Bug Fixes

• avoid CVEs reported by safety check (#353) (fb35d87)

2.4.0 (2023-06-21)

Features

• add support for Splunk backend (#335) (5171318)

Bug Fixes

• bump version of iSort to avoid non-deterministic error during pre-commit checks (5542a06)

2.3.4 (2023-02-27)

Bug Fixes

• convert timestamp to UTC in Cloud Monitoring MQL backend (#331) (0b7cbcc)
• implicit Optional type hints are now forbidden (cf. PEP 484) (#301) (c1351e0)
• lint: replace too generic exceptions (Exception) with more specific ones (ValueError) (d2eadbf)
• wrong environment variable name for --target option in api command (#320) (3303735)

2.3.3 (2022-11-02)

Bug Fixes

• compute the time horizon of MQL requests more accurately so they return the same results as MQF requests (#290) (41b814b)

2.3.2 (2022-10-29)

Bug Fixes

• remove calls to list and create metric descriptors in Cloud Monitoring exporter to prevent Quota Exceeded errors (#286) (0a6a0fb)

Documentation

• update docs and samples with all backends (#283) (61f2f32)

2.3.1 (2022-10-27)

Bug Fixes

• migrate cloud_service_monitoring backend to google-cloud-monitoring v2 (with breaking changes) (#280) (affd157)

Documentation

• document Cloud Monitoring MQL backend (#277) (8c931cd)
• refine development workflow instructions (#275) (2a35754)

2.3.0 (2022-10-24)

Features

• add Cloud Monitoring MQL backend (#245) (159f4d5)
• add Prometheus Self exporter for API mode (#209) (53c0fdf)
• add pytype linting (#249) (b622d09)

Bug Fixes

• add timeFrame to retrieve_slo dynatrace (#212) (2db0140)
• make unit tests pass again with elasticsearch 8.x client (#223) (39dd26c)
• prevent gcloud crash with python 3.10 during release workflow (39a257e)
• remove useless and unknown Pylint options (#247) (5053251)
• support custom exporters (#235) (b72b8f4)
• update "Development Status" classifier (c82eea3)

Documentation

• add missing 'method' field in readme (#213) (5d2a9a0)
• add Python 3.9 classifier (#226) (83c36b9)
• document how to write and configure filters in Cloud Monitoring provider (#266) (29ab2e1)

2.2.0 (2022-02-02)

Features

• add batch mode, better error reporting, cloud run docs (#204) (d305a63)

Bug Fixes

• alerting burn rate threshold null in BQ (#201) (d25f0f3)
• custom backend path for integration tests (#203) (7268dc1)
• dynatrace slo import (#198) (df86234)
• remove row_ids to solve de-duplication issues (#200) (56d9b9b)

Documentation

• clarify API export-only docs (#206) (7c449c3)

2.1.0 (2022-01-19)

Features

• search SLO configs in subdirectories (#181) (575f2f7)

Bug Fixes

• better exception handling and error logging (#187) (0826f11)
• bigquery exporter lint (#183) (9710b06)
• dependency issue with google-cloud-monitoring for the bazillionth time (#191) (1a613f3)
• Set Python version to 3.9 (#179) (c433fb9)

Reverts

• Revert "feat: search SLO configs in subdirectories (#181)" (#189) (08b13e7), closes #181 #189

Documentation

• correct bigquery.md (#182) (3ba32a1)
• How to define a latency SLI-SLO from an exponential distribution metric in Cloud Monitoring (#56) (8346c47)
• improve datastudio md (#54) (4c8e8a2)

2.0.1 (2021-09-29)

Bug Fixes

• yaml loader security issue (#173) (36318be)

Documentation

• add cURL example (4d6c215)
• update badges (b63fac8)
• update readme (50ce1bf)

2.0.0 (2021-09-28)

⚠ BREAKING CHANGES

• Upgrade slo-generator CLI to Click library (#131)
• Support slo-generator config v2 format (core changes) (#126)
• Split dependencies by backend (#129)

Features

• add Dynatrace method to query SLO (#116) (0148e99)
• Add migrator for v1 to v2 migration (#127) (796442e)
• Add slo-generator Functions Framework API (#130) (ab1d57c)
• add slo-generator JSON schemas (#169) (33e461b)
• Split dependencies by backend (#129) (c640a1d)
• Support slo-generator config v2 format (core changes) (#126) (bf5e6b4)
• Upgrade slo-generator CLI to Click library (#131) (5b2635b)

Bug Fixes

• Migrate sample configurations to v2 (#128) (bafaf51)
• Migrator and dependency issues fixes (#160) (51b956b)
• migrator glob catch .yml, .yaml and .json ext (0d44dc6)
• migrator not listing all files (#167) (c34ba68)
• migrator target path locations (#171) (2f7a07d)
• Minor v2 fixes (#142) (2d48d61)
• Support JSON or text data in API (#147) (93a8c9f)
• update migrator to fail softly when invalid YAMLs are found (#154) (507302e)
• v2 deployment fixes (#143) (1f03ee2)

Documentation

• Add Cloudrun docs (#165) (223830b)
• add pointers to v1 docs and v1 to v2 migration (e96c625)
• Update documentation for v2 (#133) (0a9cd38)

1.5.1 (2021-02-12)

Bug Fixes

• broken setuptools (#117) (f1fa346)

1.5.0 (2021-01-12)

Features

• support Datadog monitor-based SLOs (#112) (43a7896)

1.4.1 (2020-11-30)

Bug Fixes

• replace PUT by POST for prometheus exporter (push-gateway) (#109) (0002456)

Documentation

• update readme with metadata info (#107) (6e078f8)

1.4.0 (2020-11-12)

Features

• Add custom metadata to SLO configs (#103) (e53bdda)

Bug Fixes

• Add threshold method to Dynatrace backend (#87) (a36c6eb)
• add post validation of SLI value (#95) (3c75da4)
• default metrics (#97) (34bc2b7)
• Duplicated project_id in Stackdriver exporter metric (#100) (b1c274d)
• metrics bug with multiple exporters (#105) (0ee5e05)
• metrics exporters bugfixes (#106) (bccb407)

1.3.2 (2020-10-23)

Bug Fixes

• Datadog backend for direct SLI calculations (#93) (00fca80)

1.3.1 (2020-10-23)

Bug Fixes

• Datadog count (#88) (65b9312)
• Dynatrace fixes (#89) (ca6c7b2)

Documentation

• Add better custom samples (#90) (c0fcfe5)
• fix metrics blob in exporters docs (#91) (f75663d)

1.3.0 (2020-10-16)

Features

• add support for multiple metrics in metrics exporters (#77) (268058a)

Bug Fixes

• fail gracefully when no data in response (#79) (7265f25)
• Metrics feature bugfix (#84) (9953c1a)
• SLO Report: cast good / bad count to int (#82) (8bbc552)
• strip URL to avoid bad API response [Dynatrace] (#78) (7320f8b)

1.2.0 (2020-10-12)

Features

• Add colored output (#48) (3e79325)
• Add Datadog integration (#14) (702ba18)
• add Dynatrace backend and exporter (#62) (412a0a9)
• Add exc_info to logging. (#33) (6e87d8d)
• Custom backend and exporter classes (#34) (2cf650b)
• Prometheus backend improvements (#35) (9231c9b)
• report template doc (#16) (20856fe)

Bug Fixes

• alerting_burn_rate_threshold should be float (#63) (8eacf7d)
• correct get_human_timestamp (#43) (cbf7ee9)
• Datadog backend ratio as_count() (#61) (82cbd9f)
• isort observed on imports (#36) (3a63e6e)
• Optimize performance on creating schemas when exporting to Big Query (#23) (d125c70)
• pin google dependencies (90b9810) (#68) (9eb887e)
• resolve bug in SSM API for service autodetection (#47) (e050ac1)
• restrict dep google-cloud-monitoring to 1.x.x (#65) (0e92ea3)
• Set min_valid_events to 1 (#66) (cdc9cb1)
• SLO Report validation (#46) (adb8a5c)
• switch Dockerfile Python to 3.7 (#72) (96eeeff)
• timestamp human in UTC format (#70) (f32369a)

Documentation

• Clarify Datadog docs for extra arguments (#64) (3d53e45)
• Fix broken sample links (#55) (b72d936)
• Improve docs (#53) (a8bdb0e)
• remove window from Prometheus sample (automatically added) (#57) (4590908)

1.1.1 (2020-09-25)

Bug Fixes

• Prometheus backend: allow complex expressions (#11) (17c3238)
• unittests failing after 'fstr' style removed from pylint 2.5 (dc4ca36)

1.1.0 (08-21-2020)

Fixes

• Partition table for BigQuery database.

1.0.1 (07-20-2020)

Fixes

• Frequent 500s in Stackdriver timeseries.write

1.0.0 (04-01-2020)

Fixes

• Add unit tests for ElasticSearch
• Add unit tests for Prometheus
• Improve overall documentation
• Add unit tests for Stackdriver Service Monitoring

Features

• Add Stackdriver Service Monitoring backend
• Reformat SLO reporting in a new dataclass
• Add working samples for each backend
• Reformat kwargs blocks in each backend to be less generic

0.2.1 (01-28-2020)

Fixes

• Add Pylint tests and make them all pass
• Add test fixtures for Prometheus metrics backend

Features

• Add support for Prometheus metrics backend
• Add support for ElasticSearch metrics backend
• Add feature to support SLO config folder instead of single file
• Add feature to support parsing environmental variables from YAML file
• Add support for filter_valid in Stackdriver backend
• Rewrite documentation

0.1.0 (08-30-2019)

Features

• feat: Basic SLO monitoring with Stackdriver