Reduce cyclomatic complexity of TimescaleDB export module#3463
Open
zfh468 wants to merge 8 commits intonicolargo:developfrom
Open
Reduce cyclomatic complexity of TimescaleDB export module#3463zfh468 wants to merge 8 commits intonicolargo:developfrom
zfh468 wants to merge 8 commits intonicolargo:developfrom
Conversation
…5 in overriding 'Export.export' method
nicolargo
requested changes
Mar 1, 2026
| from glances.logger import logger | ||
|
|
||
| # Define the type conversions for TimescaleDB | ||
| # https://www.postgresql.org/docs/current/datatype.html |
Owner
There was a problem hiding this comment.
Please do not remove this link, it can help maintainer to add new field in the plugin.
| """This class manages the TimescaleDB export module.""" | ||
|
|
||
| def __init__(self, config=None, args=None): | ||
| """Init the TimescaleDB export IF.""" |
| except Exception as e: | ||
| logger.critical(f"Cannot connect to TimescaleDB server {self.host}:{self.port} ({e})") | ||
| sys.exit(2) | ||
| else: |
Owner
There was a problem hiding this comment.
This information message should not be removed
| """Init the TimescaleDB export IF.""" | ||
| super().__init__(config=config, args=args) | ||
|
|
||
| # Mandatory configuration keys (additional to host and port) |
| self.password = None | ||
| self.hostname = None | ||
|
|
||
| # Load the configuration file |
| logger.critical("Missing TimescaleDB config") | ||
| return | ||
|
|
||
| # The hostname is always add as an identifier in the TimescaleDB table |
| # so we can filter the stats by hostname | ||
| self.hostname = self.hostname or node().split(".")[0] | ||
|
|
||
| # Init the TimescaleDB client |
| return None | ||
|
|
||
| try: | ||
| # See https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING |
Owner
There was a problem hiding this comment.
Do not remove this link, options should be tweaked and this link will help maintainer to do it.
| return False | ||
|
|
||
| # Get all the stats & limits | ||
| # @TODO: Current limitation with sensors, fs and diskio plugins because fields list is not the same |
Author
There was a problem hiding this comment.
Thank you for your guidance and instructions! I have made the modifications according to your requirements. Could you please take a look and see if there are any problems?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reduces the cyclomatic complexity of the TimescaleDB export module (glances/exports/glances_timescaledb/init.py) by simplifying control flow and extracting clearer logic boundaries.
Relates to #3460
Problem
The update() method contained duplicated logic for dict-based and list-based plugin stats handling, nested conditional branches, and inline preprocessing steps mixed with SQL preparation logic.
This resulted in increased cyclomatic complexity and reduced readability, making future maintenance more difficult.
Solution
Refactored the module to:
The refactor preserves the existing SQL generation logic, table schema structure, segmentation behavior, and normalization rules.
Changes
glances/exports/glances_timescaledb/init.py:
Testing
Note: Full pytest suite was partially limited locally due to environmental dependencies, but module integrity was verified via manual import.
Checklist