feat(doctor): add readiness checks - #182
Open
djgormley wants to merge 3 commits into
Open
Conversation
djgormley
marked this pull request as ready for review
August 25, 2026 17:31
djgormley
changed the title
tjzegmott
reviewed
Sep 8, 2026
tjzegmott
left a comment
tjzegmott
left a comment
Contributor
There was a problem hiding this comment.
Some comments I wrote last week. I haven't been able to get back to this, but wanted to post what I had so far.
Comment on lines
+28
to
+35
| def _load_config() -> Optional[Dict[str, Any]]: | ||
| """Load the configuration without printing its contents.""" | ||
| try: | ||
| with open(CONFIG) as stream: | ||
| config = yaml.safe_load(stream) | ||
| except (OSError, UnicodeError, yaml.YAMLError): | ||
| return None | ||
| return config if isinstance(config, dict) else None |
Contributor
There was a problem hiding this comment.
A function to read the config already exists in config.py, it is called procure. It returns the entire dictionary, or if a key is given, the value of that key only. The specific exception checks can be added there.
Comment on lines
+38
to
+57
| def _check_config() -> Tuple[Dict[str, Any], Optional[Dict[str, Any]]]: | ||
| """Load and validate the configuration.""" | ||
| config = _load_config() | ||
| if config is None: | ||
| return _result(False, "Configuration could not be loaded."), None | ||
|
|
||
| server = config.get("server") | ||
| certificate = config.get("vospace_certfile") | ||
| site = config.get("site") | ||
| root_mounts = config.get("root_mounts") | ||
| parsed = urlparse(server) if isinstance(server, str) else None | ||
| valid_server = bool(parsed and parsed.scheme in ("http", "https") and parsed.netloc) | ||
| valid_mount = ( | ||
| isinstance(site, str) | ||
| and isinstance(root_mounts, dict) | ||
| and isinstance(root_mounts.get(site), str) | ||
| ) | ||
| if not valid_server or not isinstance(certificate, str) or not valid_mount: | ||
| return _result(False, "Configuration is missing required values."), None | ||
| return _result(True, "Configuration is ready."), config |
Contributor
There was a problem hiding this comment.
This should be broken up: the validation of the config file should exist in config.py. Moulding that into the shape that doctor needs can remain here.
Comment on lines
+63
to
+66
| response = requests.get( | ||
| server.rstrip("/") + "/query/dataset/scopes", | ||
| timeout=REQUEST_TIMEOUT, | ||
| ) |
Contributor
There was a problem hiding this comment.
There is a health check endpoint that might be better for this, it returns the following json:
❯ http get https://frb.chimenet.ca/datatrail/health/check
╭────────────────────────┬────────────────────────────────────────────╮
│ status │ ok │
│ │ ╭──────────┬─────────────────────────────╮ │
│ checks │ │ │ ╭──────────────────┬──────╮ │ │
│ │ │ database │ │ status │ ok │ │ │
│ │ │ │ │ response_time_ms │ 7.58 │ │ │
│ │ │ │ ╰──────────────────┴──────╯ │ │
│ │ │ │ ╭──────────────────┬──────╮ │ │
│ │ │ api │ │ status │ ok │ │ │
│ │ │ │ │ response_time_ms │ 8.25 │ │ │
│ │ │ │ ╰──────────────────┴──────╯ │ │
│ │ ╰──────────┴─────────────────────────────╯ │
│ timestamp │ 2026-08-31T19:57:21.140372+00:00 │
│ total_response_time_ms │ 8.25 │
╰────────────────────────┴────────────────────────────────────────────╯
Contributor
Author
Dope thanks. |
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.
Adds human and JSON readiness checks for configuration, server responses, certificates, Minoc, and Luskan without printing sensitive values.