add first version

chrisK824 · chrisK824 · commit e46eac46c474 · 2024-08-26T18:31:59.000+03:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,12 @@
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    assignees:
+      - "chrisK824"
+    reviewers:
+      - "chrisK824"
+
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -0,0 +1,77 @@
+name: CI/CD
+
+on:
+  push:
+    branches: [ "main" ]
+  release:
+    types: 
+      - published
+
+jobs:
+  linting:
+    name: CI against Python versions
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=20 --max-line-length=127 --statistics
+
+  build:
+    name: Build Python Package
+    needs:
+    - linting
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: fastapi-gae-logging
+        path: dist/
+
+  publish-to-pypi:
+    name: Publish package to PyPI
+    if: github.event_name == 'release' && github.event.action == 'published'
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fastapi-gae-logging
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: fastapi-gae-logging
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+    "flake8.args": [
+        "--max-line-length=127"
+     ]
+}
diff --git a/README.md b/README.md
@@ -1 +1,96 @@
-# fastapi-gae-logging
+# fastapi-gae-logging
+Custom Cloud Logging handler for FastAPI applications deployed in Google App Engine.
+Groups logs coming from the same request lifecycle and propagates the maximum log level throughout the request lifecycle using middleware and context management.
+
+## Install
+`pip install fastapi-gae-logging`
+
+## Features:
+
+- **Request Logs Grouping**: Groups logs coming from the same request lifecycle to ease out log analysis using the Google Cloud Log Explorer. Grouping logger name can be customised and it defaults to the Google Cloud Project ID with '-request-logger' as a suffix.
+- **Request Maximum Log Level propagation**: Propagates the maximum log level throughout the request lifecycle to ease out log searching based on severity of an issue.
+
+## API
+- Custom Cloud Logging Handler to use with official library `google-cloud-logging`: `FastAPIGAELoggingHandler`
+
+
+## Example
+
+```python
+from fastapi import FastAPI
+from fastapi.responses import JSONResponse
+from fastapi.exceptions import HTTPException
+import logging
+import os
+
+
+app = FastAPI()
+
+if os.getenv('GAE_ENV', '').startswith('standard'):
+    import google.cloud.logging
+    from google.cloud.logging_v2.handlers import setup_logging
+    from fastapi_gae_logging import FastAPIGAELoggingHandler
+
+    client = google.cloud.logging.Client()
+    gae_log_handler = FastAPIGAELoggingHandler(app=app, client=client)
+    setup_logging(handler=gae_log_handler)
+
+
+logging.getLogger().setLevel(logging.DEBUG)
+
+
+@app.get("/info")
+def info():
+    logging.debug("this is a debug")
+    logging.info("this is an info")
+    return JSONResponse(
+        content={
+            "message": "info"
+        }
+    )
+
+
+@app.get("/warning")
+async def warning():
+    logging.debug("this is a debug")
+    logging.info("this is an info")
+    logging.warning("this is a warning")
+    return JSONResponse(
+        content={
+            "message": "warning"
+        }
+    )
+
+
+@app.get("/error")
+def error():
+    logging.debug("this is a debug")
+    logging.info("this is an info")
+    logging.warning("this is a warning")
+    logging.error("this is an error")
+    return JSONResponse(
+        content={
+            "message": "error"
+        }
+    )
+
+
+@app.get("/exception")
+def exception():
+    logging.debug("this is a debug")
+    logging.info("this is an info")
+    logging.error("this is an error")
+    raise ValueError("This is a value error")
+
+
+@app.get("/http_exception")
+def http_exception():
+    logging.debug("this is an debug")
+    logging.info("this is an info")
+    raise HTTPException(
+        status_code=404,
+        detail={
+            "error": "Resource not found"
+        }
+    )
+```
diff --git a/examples.py b/examples.py
@@ -0,0 +1,78 @@
+from fastapi import FastAPI
+from fastapi.responses import JSONResponse
+from fastapi.exceptions import HTTPException
+import logging
+import os
+
+
+app = FastAPI()
+
+
+# Init logging
+if os.getenv('GAE_ENV', '').startswith('standard'):
+    import google.cloud.logging
+    from google.cloud.logging_v2.handlers import setup_logging
+    from fastapi_gae_logging.fastapi_gae_logging import FastAPIGAELoggingHandler
+
+    client = google.cloud.logging.Client()
+    gae_log_handler = FastAPIGAELoggingHandler(app=app, client=client)
+    setup_logging(handler=gae_log_handler)
+
+
+logging.getLogger().setLevel(logging.DEBUG)
+
+
+@app.get("/info")
+def info():
+    logging.debug("this is a debug")
+    logging.info("this is an info")
+    return JSONResponse(
+        content={
+            "message": "info"
+        }
+    )
+
+
+@app.get("/warning")
+async def warning():
+    logging.debug("this is a debug")
+    logging.info("this is an info")
+    logging.warning("this is a warning")
+    return JSONResponse(
+        content={
+            "message": "warning"
+        }
+    )
+
+
+@app.get("/error")
+def error():
+    logging.debug("this is a debug")
+    logging.info("this is an info")
+    logging.warning("this is a warning")
+    logging.error("this is an error")
+    return JSONResponse(
+        content={
+            "message": "error"
+        }
+    )
+
+
+@app.get("/exception")
+def exception():
+    logging.debug("this is a debug")
+    logging.info("this is an info")
+    logging.error("this is an error")
+    raise ValueError("This is a value error")
+
+
+@app.get("/http_exception")
+def http_exception():
+    logging.debug("this is an debug")
+    logging.info("this is an info")
+    raise HTTPException(
+        status_code=404,
+        detail={
+            "error": "Resource not found"
+        }
+    )
diff --git a/fastapi_gae_logging/__init__.py b/fastapi_gae_logging/__init__.py
@@ -0,0 +1,5 @@
+from .fastapi_gae_logging import FastAPIGAELoggingHandler
+
+__all__ = [
+    "FastAPIGAELoggingHandler",
+]
diff --git a/fastapi_gae_logging/fastapi_gae_logging.py b/fastapi_gae_logging/fastapi_gae_logging.py
diff --git a/setup.py b/setup.py
