New logs #10
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| #!/usr/bin/env python3 | ||
| """ | ||
| Shared, lightweight API call logger. | ||
|
|
||
| This exists so any code path that talks to a LANforge GUI -- the legacy | ||
| py-json/LANforge/LFRequest.py request layer (used via LFCliBase/Realm), or | ||
| lanforge_api.py's own request layer -- can record the same kind of entry | ||
| (url, payload, response code, session id) to the same kind of rotating log | ||
| file, without each path reimplementing rotation/formatting itself. | ||
| """ | ||
| import os | ||
| import json | ||
| import logging | ||
| import logging.handlers | ||
| import datetime | ||
|
|
||
| _api_loggers = {} | ||
|
|
||
|
|
||
| def get_api_logger(filename, max_bytes=10 * 1024 * 1024, backup_count=10): | ||
| """ | ||
| Return a cached, rotating file logger for `filename`. Callers that pass the same | ||
| filename (even from different LFCliBase/Realm instances, or a different request layer | ||
| entirely) share one logger/handler, so log lines are never duplicated and the file | ||
| rotates once instead of racing multiple independent handlers against each other. | ||
| :param filename: path to the api log file | ||
| :param max_bytes: rotate once the active file reaches this size | ||
| :param backup_count: number of rotated backups to keep | ||
| :return: a logging.Logger configured with a RotatingFileHandler | ||
| """ | ||
| key = os.path.abspath(filename) | ||
| if key in _api_loggers: | ||
| return _api_loggers[key] | ||
| api_logger = logging.getLogger("lanforge_client.api_call_logger.%s" % key) | ||
| api_logger.setLevel(logging.INFO) | ||
| api_logger.propagate = False | ||
| handler = logging.handlers.RotatingFileHandler(filename, maxBytes=max_bytes, backupCount=backup_count) | ||
| handler.setFormatter(logging.Formatter("%(message)s")) | ||
| api_logger.addHandler(handler) | ||
| _api_loggers[key] = api_logger | ||
| return api_logger | ||
|
|
||
|
|
||
| def log_api_call(api_logger, method, url, session_id=None, data=None, response_code=None, error=None, | ||
| diagnostics=None): | ||
| """ | ||
| Format and emit one lightweight record of an API call via api_logger. No-op if | ||
| api_logger is None, so callers can pass through a possibly-absent logger without | ||
| guarding every call site themselves. | ||
| :param api_logger: a logger from get_api_logger(), or None to skip silently | ||
| :param method: "GET" | "POST" | "PUT" | "DELETE" | ||
| :param url: requested url | ||
| :param session_id: the lanforge_api session id ("cookie") tying this call to the | ||
| LANforge GUI's own request logs, if available | ||
| :param data: payload sent (POST/PUT only) | ||
| :param response_code: HTTP status code returned by the call, if any | ||
| :param error: exception raised by the call, if any -- marks the entry as ERROR | ||
| :param diagnostics: one-line summary of a caught HTTPError/URLError (reason, | ||
| X-Error-* headers, etc.) | ||
| """ | ||
| if api_logger is None: | ||
| return | ||
| if error is not None: | ||
| status = "ERROR" | ||
| elif response_code is not None: | ||
| status = "OK" if 200 <= response_code < 300 else "ERROR" | ||
| else: | ||
| status = "UNKNOWN" | ||
| lines = ["%s session=%s %s %s [%s]" % | ||
| (datetime.datetime.now().isoformat(), session_id or '-', method, url, status)] | ||
| if data is not None: | ||
| lines.append(" payload: %s" % json.dumps(data, default=str)) | ||
| if error is not None: | ||
| lines.append(" error: %s" % error) | ||
| if response_code is not None: | ||
| lines.append(" response_code: %s" % response_code) | ||
| if diagnostics is not None: | ||
| lines.append(" diagnostics: %s" % diagnostics) | ||
| try: | ||
| api_logger.info("\n".join(lines)) | ||
| except Exception: | ||
| logging.getLogger(__name__).debug("log_api_call: unable to emit log line", exc_info=True) | ||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The request layer explicitly treats several non-2xx responses as acceptable (
BaseLFJsonRequest.OK_STATUSESincludes redirects and 404 for normal polling/missing-resource cases), but this logger marks anything outside 2xx asERROR. In workflows that expect temporary 404s while waiting for resources, the saved API log/report will report normal calls as failures and obscure real errors; align this status calculation with the request layer's accepted status set.Useful? React with 👍 / 👎.