feat(backend): setup logging utilities #10027

Swiftyos · 2025-05-23T20:04:10Z

Summary

initialize backend logging in entry point scripts
document log format and logger usage
add pre-commit hook to warn on plain logger instantiation

Testing

poetry -C autogpt_platform/backend run format
poetry -C autogpt_platform/backend run lint
poetry -C autogpt_platform/backend run test (fails: Error 111 connecting to localhost:6379)

netlify · 2025-05-23T20:04:15Z

✅ Deploy Preview for auto-gpt-docs-dev canceled.

Name	Link
🔨 Latest commit	`defc851`
🔍 Latest deploy log	https://app.netlify.com/projects/auto-gpt-docs-dev/deploys/6830d4bd12113700088475bd

qodo-merge-pro · 2025-05-23T20:04:28Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Error Handling The script detects plain logger usage but only prints errors without returning a non-zero exit code, which means the pre-commit hook might not properly fail when violations are found. if errors: print("Plain logging.getLogger usage detected in:\n" + "\n".join(errors)) Missing Documentation The TruncatedLogger is used but there's no docstring explaining its purpose or how it differs from a standard logger in the visible code. logger = TruncatedLogger(logging.getLogger(__name__), "[App]")

netlify · 2025-05-23T20:04:36Z

✅ Deploy Preview for auto-gpt-docs canceled.

Name	Link
🔨 Latest commit	`defc851`
🔍 Latest deploy log	https://app.netlify.com/projects/auto-gpt-docs/deploys/6830d4bd030a7100080771f0

deepsource-io · 2025-05-23T20:04:44Z

Here's the code health analysis summary for commits dc981b5..defc851. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
JavaScript	✅ Success		View Check ↗
Python	✅ Success	🎯 1 occurence resolved	View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

ntindle · 2025-05-23T20:07:56Z

autogpt_platform/backend/linter.py

@@ -30,6 +30,7 @@ def lint():
        ["ruff", "format", "--diff", "--check", LIBS_DIR],
        ["isort", "--diff", "--check", "--profile", "black", BACKEND_DIR],
        ["black", "--diff", "--check", BACKEND_DIR],
+        ["python", "check_logging.py"],


Add to format step too

github-actions · 2025-06-04T13:09:45Z

This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.

Pwuts

What specific issue(s) does this PR aim to solve?

Code needs some work.

Pwuts · 2025-06-05T07:37:08Z

autogpt_platform/backend/check_logging.py

put this in a scripts folder

Pwuts · 2025-06-05T07:44:21Z

autogpt_platform/backend/check_logging.py

+    if PATTERN.search(text) and "TruncatedLogger" not in text:
+        errors.append(str(path.relative_to(ROOT)))
+
+if errors:
+    print("Plain logging.getLogger usage detected in:\n" + "\n".join(errors))


So any usage of logger.getLogger not wrapped in TruncatedLogger is now reported as a linting error?

But this PR doesn't fix all usages of logging.getLogger so the PR wouldn't pass this check.

If we needed system-wide logging truncation, add some middleware in configure_logging to do this rather than wrapping all uses across the codebase in a helper class.

But the last time we discussed this, there was no real need for this, because there are only a few specific places where messages with long "attachments" are being logged.

Pwuts · 2025-06-05T07:45:32Z

autogpt_platform/backend/check_logging.py

this script always exits normally, so it will never trigger CI or pre-commit check failure

Pwuts · 2025-06-05T07:46:32Z

.pre-commit-config.yaml

+  - repo: local
+    hooks:
+      - id: check-loggers
+        name: Check for plain loggers


Suggested change

name: Check for plain loggers

name: Check for plain loggers - AutoGPT Platform - Backend

Pwuts · 2025-06-05T07:47:08Z

autogpt_platform/backend/backend/ws.py

why is this needed?

Pwuts · 2025-06-05T07:47:17Z

autogpt_platform/backend/backend/scheduler.py

why is this needed?

Pwuts · 2025-06-05T07:47:26Z

autogpt_platform/backend/backend/rest.py

why is this needed?

Pwuts · 2025-06-05T07:47:35Z

autogpt_platform/backend/backend/exec.py

why is this needed?

Pwuts · 2025-06-05T07:47:46Z

autogpt_platform/backend/backend/app.py

why is this needed?

Pwuts · 2025-06-05T07:48:13Z

autogpt_platform/README.md

+YYYY-MM-DD HH:MM:SS LEVEL [PREFIX] message {"json_fields": {...}}
+```
+
+When creating loggers for user-facing modules, wrap them with


what is a user-facing module?

feat(backend): setup logging utilities

defc851

Swiftyos requested a review from a team as a code owner May 23, 2025 20:04

Swiftyos requested review from ntindle and removed request for a team May 23, 2025 20:04

Swiftyos added the codex label May 23, 2025 — with ChatGPT Connector

Swiftyos requested a review from Pwuts May 23, 2025 20:04

Swiftyos added the codex label May 23, 2025

github-project-automation bot added this to AutoGPT development kanban May 23, 2025

github-project-automation bot moved this to 🆕 Needs initial review in AutoGPT development kanban May 23, 2025

github-actions bot added the platform/backend AutoGPT Platform - Back end label May 23, 2025

qodo-merge-pro bot added the Review effort 2/5 label May 23, 2025

github-actions bot added the size/m label May 23, 2025

ntindle reviewed May 23, 2025

View reviewed changes

Swiftyos marked this pull request as draft May 23, 2025 20:57

github-actions bot added the conflicts Automatically applied to PRs with merge conflicts label Jun 4, 2025

Pwuts requested changes Jun 5, 2025

View reviewed changes

github-project-automation bot moved this from 🆕 Needs initial review to 🚧 Needs work in AutoGPT development kanban Jun 5, 2025

	name: Check for plain loggers
	name: Check for plain loggers - AutoGPT Platform - Backend

feat(backend): setup logging utilities #10027

Are you sure you want to change the base?

feat(backend): setup logging utilities #10027

Conversation

Swiftyos commented May 23, 2025

Summary

Testing

Uh oh!

netlify bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for auto-gpt-docs-dev canceled.

Uh oh!

qodo-merge-pro bot commented May 23, 2025

PR Reviewer Guide 🔍

Uh oh!

netlify bot commented May 23, 2025

✅ Deploy Preview for auto-gpt-docs canceled.

Uh oh!

deepsource-io bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Analysis Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

Pwuts left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

netlify bot commented May 23, 2025 •

edited

Loading

deepsource-io bot commented May 23, 2025 •

edited

Loading