Merge pull request #1 from RefaceAI/summary

Add initial summary implementation

Author: antonmyronyuk

.github/workflows/publish.yaml

@@ -0,0 +1,33 @@
+name: Upload package ty PYPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment: production
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: '__token__'
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python setup.py sdist bdist_wheel
+          twine upload dist/*

.github/workflows/tests.yaml

@@ -0,0 +1,28 @@
+name: tests
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+
+    steps:
+      - name: Checkout repository code
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools
+          pip install -r requirements/dev.txt
+          pip install -r requirements/test.txt
+
+      - name: Tests with pytest
+        run: pytest

.gitignore

@@ -157,4 +157,6 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
+
+.DS_Store

README.md

@@ -1,2 +1,2 @@
 # prometheus-summary
-Prometheus summary with quantiles
+Prometheus summary with quantiles over configurable sliding time window

prometheus_summary/__init__.py

@@ -0,0 +1,60 @@
+from typing import Iterable, Sequence, Optional, Tuple
+
+import prometheus_client
+from prometheus_client.samples import Sample
+from quantile_estimator import TimeWindowEstimator
+
+from .version import __version__
+
+
+class Summary(prometheus_client.Summary):
+    # pairs of (quantile, allowed error)
+    DEFAULT_INVARIANTS = ((0.50, 0.05), (0.90, 0.01), (0.99, 0.001))
+
+    def __init__(
+        self,
+        name: str,
+        documentation: str,
+        labelnames: Iterable[str] = (),
+        namespace: str = '',
+        subsystem: str = '',
+        unit: str = '',
+        registry: Optional[prometheus_client.CollectorRegistry] = prometheus_client.REGISTRY,
+        _labelvalues: Optional[Sequence[str]] = None,
+        invariants: Sequence[Tuple[float, float]] = DEFAULT_INVARIANTS,
+        max_age_seconds: int = 10 * 60,
+        age_buckets: int = 5,
+    ) -> None:
+        self._invariants = invariants
+        self._max_age_seconds = max_age_seconds
+        self._age_buckets = age_buckets
+        super().__init__(
+            name,
+            documentation,
+            labelnames=labelnames,
+            namespace=namespace,
+            subsystem=subsystem,
+            unit=unit,
+            registry=registry,
+            _labelvalues=_labelvalues,
+        )
+
+    def _metric_init(self):
+        super()._metric_init()
+        self._estimator = TimeWindowEstimator(
+            *self._invariants,
+            max_age_seconds=self._max_age_seconds,
+            age_buckets=self._age_buckets,
+        )
+
+    def observe(self, amount):
+        super().observe(amount)
+        self._estimator.observe(amount)
+
+    def _child_samples(self):
+        default_samples = super()._child_samples()
+        quantile_samples = tuple(
+            Sample("", {"quantile": str(quantile)}, self._estimator.query(quantile), None, None)
+            for quantile, _ in self._invariants
+        )
+        return [*default_samples, *quantile_samples]

prometheus_summary/version.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+testpaths = tests

requirements/dev.txt

@@ -0,0 +1,2 @@
+prometheus_client>=0.11.0
+quantile-estimator>=0.1.0

requirements/test.txt

@@ -0,0 +1 @@
+pytest

setup.py

@@ -0,0 +1,35 @@
+import pathlib
+import setuptools
+from importlib.machinery import SourceFileLoader
+
+version = SourceFileLoader("version", "prometheus_summary/version.py").load_module()
+
+
+def readfile(filename) -> str:
+    return pathlib.Path(filename).read_text("utf-8").strip()
+
+
+setuptools.setup(
+    name="prometheus-summary",
+    version=version.__version__,
+    author="RefaceAI",
+    author_email="github-support@reface.ai",
+    description="Prometheus summary with quantiles over configurable sliding time window",
+    long_description=readfile("README.md"),
+    long_description_content_type="text/markdown",
+    license="Apache License 2.0",
+    url="https://github.com/RefaceAI/prometheus-summary",
+    packages=["prometheus_summary"],
+    install_requires=[
+        "prometheus_client>=0.11.0",
+        "quantile-estimator>=0.1.0",
+    ],
+    platforms="Platform Independent",
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: OS Independent",
+        "Topic :: Scientific/Engineering :: Mathematics",
+    ],
+)