dprevot/check-patroni
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
check-patroni/CHANGELOG.md

98 lines
3.2 KiB
Markdown
Raw Permalink Normal View History

Add CHANGELOG.md
2023-08-21 14:34:10 +02:00
# Change log
Release V2.0.0
2024-04-09 16:45:11 +02:00
## check_patroni 2.0.0 - 2024-04-09
Add CHANGELOG.md
2023-08-21 14:34:10 +02:00
Fix cluster_node_count's management of replication states The service now supports the `streaming` state. Since we dont check for lag or timeline in this service, a healthy node is : * leader : in a running state * standby_leader : running (pre Patroni 3.0.4), streaming otherwise * standby & sync_standby : running (pre Patroni 3.0.4), streaming otherwise Updated the tests for this service.
2023-11-14 12:17:36 +01:00
### Changed
* In `cluster_node_count`, a healthy standby, sync replica or standby leaders cannot be "in
archive recovery" because this service doesn't check for lag and timelines.
Add CHANGELOG.md
2023-08-21 14:34:10 +02:00
### Added
cluster_has_replica: fix the way a healthy replica is detected For patroni >= version 3.0.4: * the role is `replica` or `sync_standby` * the state is `streaming` or `in archive recovery` * the timeline is the same as the leader * the lag is lower or equal to `max_lag` For prio versions of patroni: * the role is `replica` or `sync_standby` * the state is `running` * the timeline is the same as the leader * the lag is lower or equal to `max_lag` Additionnally, we now display the timeline in the perfstats. We also try to display the perf stats of unhealthy replica as much as possible. Update tests for cluster_has_replica: * Fix the tests to make them work with the new algotithm * Add a specific test for tl divergences
2023-09-27 16:37:40 +02:00
* Add the timeline in the `cluster_has_replica` perfstats. (#50)
Mention that shell completion support is dependant on the shell version
2023-11-16 13:42:42 +01:00
* Add a mention about shell completion support and shell versions in the doc. (#53)
Fix the cluster_has_leader service for standby clusters Before this patch we checked the expected standby leader state was `running` for all versions of Patroni. With this patch, for: * Patroni < 3.0.4, standby leaders are in `running` state. * Patroni >= 3.0.4, standby leaders can be in `streaming` or `in archive recovey` state. We will raise a warning for the latter. The tests where modified to account for this. Co-authored-by: Denis Laxalde <denis@laxalde.org>
2023-11-08 17:50:32 +01:00
* Add the leader type and whether it's archiving to the `cluster_has_leader` perfstats. (#58)
cluster_has_replica: fix the way a healthy replica is detected For patroni >= version 3.0.4: * the role is `replica` or `sync_standby` * the state is `streaming` or `in archive recovery` * the timeline is the same as the leader * the lag is lower or equal to `max_lag` For prio versions of patroni: * the role is `replica` or `sync_standby` * the state is `running` * the timeline is the same as the leader * the lag is lower or equal to `max_lag` Additionnally, we now display the timeline in the perfstats. We also try to display the perf stats of unhealthy replica as much as possible. Update tests for cluster_has_replica: * Fix the tests to make them work with the new algotithm * Add a specific test for tl divergences
2023-09-27 16:37:40 +02:00
Release 1.0.0
2023-08-28 12:09:16 +02:00
### Fixed
Avoid using requests's JSONDecodeError This exception is only present in "recent" version of requests, typically not in the version distributed by Debian bullseye. Since requests' JSONDecodeError is in general a subclass of json.JSONDecodeError, we use the latter, but also handle the plain ValueError (which json.JSONDecodeError is a subclass of) because requests might use simplejson (which uses its own JSONDecodeError, also a subclass of ValueError).
2023-10-06 14:02:24 +02:00
* Add compatibility with [requests](https://requests.readthedocs.io)
version 2.25 and higher.
cluster_has_replica: fix the way a healthy replica is detected For patroni >= version 3.0.4: * the role is `replica` or `sync_standby` * the state is `streaming` or `in archive recovery` * the timeline is the same as the leader * the lag is lower or equal to `max_lag` For prio versions of patroni: * the role is `replica` or `sync_standby` * the state is `running` * the timeline is the same as the leader * the lag is lower or equal to `max_lag` Additionnally, we now display the timeline in the perfstats. We also try to display the perf stats of unhealthy replica as much as possible. Update tests for cluster_has_replica: * Fix the tests to make them work with the new algotithm * Add a specific test for tl divergences
2023-09-27 16:37:40 +02:00
* Fix what `cluster_has_replica` deems a healthy replica. (#50, reported by @mbanck)
* Fix `cluster_has_replica` to display perfstats for replicas whenever it's possible (healthy or not). (#50)
Fix the cluster_has_leader service for standby clusters Before this patch we checked the expected standby leader state was `running` for all versions of Patroni. With this patch, for: * Patroni < 3.0.4, standby leaders are in `running` state. * Patroni >= 3.0.4, standby leaders can be in `streaming` or `in archive recovey` state. We will raise a warning for the latter. The tests where modified to account for this. Co-authored-by: Denis Laxalde <denis@laxalde.org>
2023-11-08 17:50:32 +01:00
* Fix `cluster_has_leader` to correctly check for standby leaders. (#58, reported by @mbanck)
Fix cluster_node_count's management of replication states The service now supports the `streaming` state. Since we dont check for lag or timeline in this service, a healthy node is : * leader : in a running state * standby_leader : running (pre Patroni 3.0.4), streaming otherwise * standby & sync_standby : running (pre Patroni 3.0.4), streaming otherwise Updated the tests for this service.
2023-11-14 12:17:36 +01:00
* Fix `cluster_node_count` to correctly manage replication states. (#50, reported by @mbanck)
Avoid using requests's JSONDecodeError This exception is only present in "recent" version of requests, typically not in the version distributed by Debian bullseye. Since requests' JSONDecodeError is in general a subclass of json.JSONDecodeError, we use the latter, but also handle the plain ValueError (which json.JSONDecodeError is a subclass of) because requests might use simplejson (which uses its own JSONDecodeError, also a subclass of ValueError).
2023-10-06 14:02:24 +02:00
Release 1.0.0
2023-08-28 12:09:16 +02:00
### Misc
Release V2.0.0
2024-04-09 16:45:11 +02:00
* Improve the documentation for `node_is_replica`.
Use fake HTTP server for the Patroni API in tests We introduce a patroni_api fixture, defined in tests/conftest.py, which sets up an HTTP server serving files in a temporary directory. The server is itself defined by the PatroniAPI class; it has a 'routes()' context manager method to be used in actual tests to setup expected responses based on specified JSON files. We set up some logging in order to improve debugging. The direct advantage of this is that PatroniResource.rest_api() method is now covered by the test suite. Coverage before this commit: Name Stmts Miss Cover ----------------------------------------------- check_patroni/__init__.py 3 0 100% check_patroni/cli.py 193 18 91% check_patroni/cluster.py 113 0 100% check_patroni/convert.py 23 5 78% check_patroni/node.py 146 1 99% check_patroni/types.py 50 23 54% ----------------------------------------------- TOTAL 528 47 91% and after this commit: Name Stmts Miss Cover ----------------------------------------------- check_patroni/__init__.py 3 0 100% check_patroni/cli.py 193 18 91% check_patroni/cluster.py 113 0 100% check_patroni/convert.py 23 5 78% check_patroni/node.py 146 1 99% check_patroni/types.py 50 9 82% ----------------------------------------------- TOTAL 528 33 94% In actual test functions, we either invoke patroni_api.routes() to configure which JSON file(s) should be served for each endpoint, or we define dedicated fixtures (e.g. cluster_config_has_changed()) to configure this for several test functions or the whole module. The 'old_replica_state' parametrized fixture is used when needed to adjust such fixtures, e.g. in cluster_has_replica_ok(), to modify the JSON content using cluster_api_set_replica_running() (previously in tests/tools.py, now in tests/__init__.py). The dependency on pytest-mock is no longer needed.
2023-09-28 09:41:33 +02:00
* Improve test coverage by running an HTTP server to fake the Patroni API (#55
by @dlax).
Add compat for old pytest in type hints
2023-10-06 11:45:48 +02:00
* Work around old pytest versions in type annotations in the test suite.
Declare compatibility with click 7.1 or higher We apparently, from the test suite, don't need version 8.x.
2023-10-06 12:04:41 +02:00
* Declare compatibility with click version 7.1 (or higher).
Work around nagiosplugin issue about stdout in tests We basically apply the change from https://github.com/mpounsett/nagiosplugin/issues/24 as a fixture, but only when nagiosplugin's version is old.
2023-10-06 13:46:19 +02:00
* In tests, work around nagiosplugin 1.3.2 not properly handling stdout
redirection.
Use fake HTTP server for the Patroni API in tests We introduce a patroni_api fixture, defined in tests/conftest.py, which sets up an HTTP server serving files in a temporary directory. The server is itself defined by the PatroniAPI class; it has a 'routes()' context manager method to be used in actual tests to setup expected responses based on specified JSON files. We set up some logging in order to improve debugging. The direct advantage of this is that PatroniResource.rest_api() method is now covered by the test suite. Coverage before this commit: Name Stmts Miss Cover ----------------------------------------------- check_patroni/__init__.py 3 0 100% check_patroni/cli.py 193 18 91% check_patroni/cluster.py 113 0 100% check_patroni/convert.py 23 5 78% check_patroni/node.py 146 1 99% check_patroni/types.py 50 23 54% ----------------------------------------------- TOTAL 528 47 91% and after this commit: Name Stmts Miss Cover ----------------------------------------------- check_patroni/__init__.py 3 0 100% check_patroni/cli.py 193 18 91% check_patroni/cluster.py 113 0 100% check_patroni/convert.py 23 5 78% check_patroni/node.py 146 1 99% check_patroni/types.py 50 9 82% ----------------------------------------------- TOTAL 528 33 94% In actual test functions, we either invoke patroni_api.routes() to configure which JSON file(s) should be served for each endpoint, or we define dedicated fixtures (e.g. cluster_config_has_changed()) to configure this for several test functions or the whole module. The 'old_replica_state' parametrized fixture is used when needed to adjust such fixtures, e.g. in cluster_has_replica_ok(), to modify the JSON content using cluster_api_set_replica_running() (previously in tests/tools.py, now in tests/__init__.py). The dependency on pytest-mock is no longer needed.
2023-09-28 09:41:33 +02:00
Release 1.0.0
2023-08-28 12:09:16 +02:00
## check_patroni 1.0.0 - 2023-08-28
Check patroni is now tagged as Production/Stable.
### Added
Add CHANGELOG.md
2023-08-21 14:34:10 +02:00
* Add `sync_standby` as a valid replica type for `cluster_has_replica`. (contributed by @mattpoel)
Add info and options about sync standby to cluster_has_replica * Add `--sync-warning` and `--sync-critical` * Add `sync_replica` to track the number of sync replica in the perf data * Add `MEMBER-sync` to track if a member is a sync replica in the perf data
2023-08-24 15:43:35 +02:00
* Add info and options (`--sync-warning` and `--sync-critical`) about sync replica to `cluster_has_replica`.
Add new service cluster_has_scheduled_action
2023-08-22 17:29:13 +02:00
* Add a new service `cluster_has_scheduled_action` to warn of any scheduled switchover or restart.
CHANGELOG update for node_is_replica
2023-08-23 16:00:40 +02:00
* Add options to `node_is_replica` to check specifically for a synchronous (`--is-sync`) or asynchronous node (`--is-async`).
Add standby-leader as a valid leader type for cluster_has_leader
2023-08-23 16:58:08 +02:00
* Add `standby-leader` as a valid leader type for `cluster_has_leader`.
Add a node_is_leader service to check for the leader states It's possible to check for any kind of leader of specifically for a standby leader.
2023-08-23 17:40:46 +02:00
* Add a new service `node_is_leader` to check if a node is a leader (which includes standby leader nodes)
Add CHANGELOG.md
2023-08-21 14:34:10 +02:00
### Fixed
* Fix the `node_is_alive` check. (#31)
* Fix the `cluster_has_replica` and `cluster_node_count` checks to account for
the new replica state `streaming` introduced in v3.0.4 (#28, reported by @log1-c)
### Misc
* Create CHANGELOG.md
Update CHANGELOG
2023-08-22 18:01:03 +02:00
* Add tests for the output of the scripts in addition to the return code
Release 1.0.0
2023-08-28 12:09:16 +02:00
* Documentation in CONTRIBUTING.md
Add CHANGELOG.md
2023-08-21 14:34:10 +02:00
## check_patroni 0.2.0 - 2023-03-20
### Added
* Add a `--save` option when state files are used
* Modify `-e/--endpoints` to allow a comma separated list of endpoints (#21, reported by @lihnjo)
* Use requests instead of urllib3 (with extensive help from @dlax)
* Change the way logging is handled (with extensive help from @dlax)
### Fix
* Reverse the test for `node_is_pending`
* SSL handling
### Misc
* Several doc Fix and Updates
* Use spellcheck and isort
* Remove tests for python 3.6
* Add python tests for python 3.11
## check_patroni 0.1.1 - 2022-07-15
The initial release covers the following checks :
* check a cluster for
+ configuration change
+ presence of a leader
+ presence of a replica
+ maintenance status
* check a node for
+ liveness
+ pending restart status
+ primary status
+ replica status
+ tl change
+ patroni version
Reference in a new issue Copy permalink