feat: first implementation

Author: pquadri

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Semantic Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency: release
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Python Semantic Release
+        uses: python-semantic-release/python-semantic-release@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tests.yml

@@ -0,0 +1,55 @@
+on:
+  push:
+    branches:
+      - "**"
+    tags-ignore:
+      - "*.*.*"
+
+name: tests
+
+concurrency:
+  group: tests
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+        poetry-version: ["1.8.2"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        name: Checkout
+
+      - uses: actions/setup-python@v4
+        name: Setup Python
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: abatilo/actions-poetry@v3
+        name: Install Poetry
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+
+      - name: Update Poetry cache location
+        run: poetry config virtualenvs.in-project true
+
+      - id: venv_cache
+        uses: actions/cache@v3
+        name: Cache or Restore venv
+        with:
+          path: .venv
+          key: venv-${{ matrix.python-version }}-${{ matrix.poetry-version }}-lock-${{ hashFiles('poetry.lock') }}
+
+      - name: Install Poetry Dependencies
+        run: poetry install
+        if: steps.venv_cache.outputs.cache-hit != 'true'
+
+      - name: Run ruff
+        run: poetry run ruff check .
+
+      - name: Run ruff format
+        run: poetry run ruff format --check .
+
+      - name: Run tests
+        run: poetry run pytest

README.md

@@ -0,0 +1,11 @@
+# Remote Python log formatter
+
+## Sample usage
+
+```python
+from remote_log_formatter import get_logger, setup_logging
+
+setup_logging(json=False)
+logger = get_logger(__package__)
+logger.info("foo")
+```

poetry.lock

@@ -0,0 +1,17 @@
+[tool.poetry]
+name = "remote-log-formatter"
+version = "0.1.0"
+description = ""
+authors = ["Paolo Quadri <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+
+[tool.poetry.group.dev.dependencies]
+ruff = "^0.3.4"
+pytest = "^8.1.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -0,0 +1,107 @@
+import json
+import logging
+import logging.config
+import os
+import sys
+from datetime import datetime
+
+
+class SimpleFormatter(logging.Formatter):
+    def __init__(
+        self, fmt=None, datefmt=None, style="%", validate=True, *, defaults=None
+    ) -> None:
+        if fmt is None:
+            fmt = "%(asctime)s | %(levelname)s | %(message)s | %(pathname)s:%(lineno)s"
+        super(SimpleFormatter, self).__init__(fmt, datefmt, style, validate)
+
+
+class JSONFormatter(logging.Formatter):
+    def __init__(self, *args, **kwargs) -> None:
+        super(JSONFormatter, self).__init__(*args, **kwargs)
+
+        self._pid = os.getpid()
+
+    @staticmethod
+    def format_timestamp(time: float) -> str:
+        return datetime.fromtimestamp(time).isoformat()
+
+    def format(self, record: logging.LogRecord) -> str:
+        try:
+            msg = record.msg % record.args
+        except TypeError:
+            msg = record.msg
+
+        extra = {"type": "log"}
+
+        exc = ""
+        if record.exc_info:
+            if not record.exc_text:
+                record.exc_text = self.formatException(record.exc_info)
+            extra["class"] = str(record.exc_info[0])
+
+        if record.exc_text:
+            if exc[-1:] != "\n":
+                exc += "\n"
+            exc += record.exc_text
+
+        if record.stack_info:
+            if exc[-1:] != "\n":
+                exc += "\n"
+            exc += self.formatStack(record.stack_info)
+
+        if len(exc):
+            extra["traceback"] = exc
+            extra["type"] = "exception"
+
+        message = {
+            "datetime": self.format_timestamp(record.created),
+            "level": record.levelname,
+            "message": msg,
+            "channel": record.name,
+            "pid": record.process,
+            "context": {
+                "processname": record.processName,
+                "pathname": record.pathname,
+                "module": record.module,
+                "function": record.funcName,
+                "lineno": record.lineno,
+            },
+            "extra": extra,
+        }
+
+        return json.dumps(message, default=str)
+
+
+def setup_logging(json: bool = True) -> None:
+    LOG_CONFIG = dict(
+        version=1,
+        disable_existing_loggers=False,
+        root={
+            "level": "INFO",
+            "handlers": ["console"],
+        },
+        loggers={
+            "root": {
+                "level": "INFO",
+                "handlers": ["console"],
+                "propagate": True,
+            }
+        },
+        handlers={
+            "console": {
+                "class": "logging.StreamHandler",
+                "formatter": "generic" if json else "simple",
+                "stream": sys.stdout,
+            },
+        },
+        formatters={
+            "generic": {"class": "remote_log_formatter.JSONFormatter"},
+            "simple": {"class": "remote_log_formatter.SimpleFormatter"},
+        },
+    )
+
+    logging.config.dictConfig(LOG_CONFIG)
+
+
+def get_logger(name: str = "remote") -> logging.Logger:
+    return logging.getLogger(name)

remote_log_formatter/__init__.py

@@ -0,0 +1,5 @@
+from remote_log_formatter import get_logger, setup_logging
+
+setup_logging(json=False)
+logger = get_logger(__package__)
+logger.info("foo")