Initial project (#1)

Add base metrics code, tests, package boilerplate, github checks

.github/workflows/python-linters.yml

@@ -0,0 +1,32 @@
+name: Linters
+
+on:
+  push:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8.16']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pdm sync -dG lint
+
+      - name: Run lint
+        run: pdm run ruff check
+
+      - name: Run format check
+        run: pdm run ruff format --check
+
+      - name: Run mypy
+        run: pdm run mypy src

.github/workflows/python-tests.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pdm sync -dG pytest
+
+      - name: Run Tests
+        run: pdm run pytest
+

.gitignore

@@ -0,0 +1,137 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+.ruff_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# InteliJ IDEA
+.idea/
+
+# VSCode
+.vscode/
+.pdm-python

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Huntflow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -2,3 +2,58 @@
 Base definitions for metrics collection via prometheus client library.
 Intended to be used in Huntflow fastapi-based services: ready-to use collectors to measure HTTP requests and responses.
 Also provides universal decorator to observe timings of custom methods/functions.
+
+# How to use
+
+## How to collect metrics for FastAPI requests
+
+```python
+from contextlib import asynccontextmanager
+
+from fastAPI import FastAPI
+
+from huntflow_base_metrics import start_metrics, stop_metrics, add_middleware
+
+
+# Service name (in most cases should be provided in `FACILITY_NAME` environment variable)
+FACILITY_NAME = "my-service-name"
+# Service instance name (should provided in `FACILITY_ID` environment variable)
+FACILITY_ID = "qwerty"
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    await onstartup(app)
+    yield
+    await onshutdown(app)
+
+
+async def onstartup(app: FastAPI):
+    # do some startup actions
+    pass
+
+async def onshutdown(app: FastAPI):
+    # do some shutdown actions
+    stop_metrics()
+
+
+def create_app()
+    app = FastAPI(lifespan=lifespan)
+
+    start_metrics(
+        FACILITY_NAME,
+        FACILITY_ID,
+        # Optional, only needed if metrics are collected from files.
+        # Also, it's mandatory if write_to_file is True
+        out_file_path=f"/app/metrics/{FACILITY_NAME}-{FACILITY_ID}.prom",
+        enabled=True,
+        write_to_file=True,
+        # interval in seconds to dump metrics to a file
+        file_update_interval=15,
+    )
+    add_middleware(app)
+    return app
+
+```
+
+# TODO: another use-cases and development notes