swanmetrics 1.0.3__py3-none-any.whl

swanmetrics/__init__.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+from jupyter_server_proxy.handlers import ProxyHandler
+
+from prometheus_client import Counter
+from ._version import __version__
+
+from jupyter_server.base.handlers import PrometheusMetricsHandler
+
+editors_opened = {
+    "vscode": False
+}
+
+# Prometheus metrics
+EDITORS_OPEN = Counter(
+    "swan_editor_open",
+    "Code editor usage in SWAN",
+    ["editor"]
+)
+
+_original_prepare = ProxyHandler.prepare
+def _wrapped_prepare(self, *args, **kwargs):
+    path = self.request.path
+    for editor, visited in editors_opened.items():
+        if editor in path and not visited:
+            EDITORS_OPEN.labels(editor=editor).inc()
+            editors_opened[editor] = True
+    return _original_prepare(self)
+ProxyHandler.prepare = _wrapped_prepare
+
+def _load_jupyter_server_extension(server_app) -> None:
+    """
+    Extension entry point. Called by Jupyter Server on startup.
+    """
+    log = server_app.log
+    log.info(f"SwanMetrics: Loading version v{__version__}")
+
+    web_app = server_app.web_app
+    
+    # Add route for Prometheus handler at the root level
+    # so that Prometheus always scrapes the same endpoint,
+    # without having to access /user/<username>/metrics every time.
+
+    web_app.add_handlers(
+        r".*$", 
+        [(r"/metrics", PrometheusMetricsHandler)]
+    )
+
+
+def _jupyter_server_extension_points():
+    """
+    Returns the extension metadata for jupyter_server.
+
+    This is required for `jupyter server extension enable` to work.
+    """
+    return [{"module": "swanmetrics"}]

swanmetrics/_version.py

@@ -0,0 +1,3 @@
+# please don't modify this file,
+# this is automatically updated by bump2version
+__version__ = '1.0.3'

swanmetrics-1.0.3.data/data/etc/jupyter/jupyter_server_config.d/swanmetrics.json

@@ -0,0 +1,7 @@
+{
+    "ServerApp": {
+        "jpserver_extensions": {
+           "swanmetrics": true
+        }
+    }
+}

swanmetrics-1.0.3.dist-info/METADATA

@@ -0,0 +1,32 @@
+Metadata-Version: 2.4
+Name: swanmetrics
+Version: 1.0.3
+Summary: Jupyter Server extension for collecting metrics via jupyter_events
+Author-email: SWAN Team <swan-admins@cern.ch>
+License-Expression: MIT
+Requires-Python: >=3.10
+Requires-Dist: jupyter-events==0.12.0
+Requires-Dist: jupyter-server==2.15.0
+Description-Content-Type: text/markdown
+
+# SwanMetrics
+
+SWAN Metrics extension to add metrics for specific user actions, such as opening editors.
+
+
+## Requirements
+
+* jupyter_server
+* jupyter_events
+
+## Install
+
+```bash
+pip install swanmetrics
+```
+
+## Observations
+
+* The `/metrics` route was added to direct the `PrometheusMetricsHandler` to the root url, so that Prometheus always scrapes the same endpoint,
+without having to access the `/user/<username>/metrics` endpoint every time. Otherwise, the username would have to be parsed each time Prometheus
+would scrape the metrics from the user pod.

swanmetrics-1.0.3.dist-info/RECORD

@@ -0,0 +1,7 @@
+swanmetrics/__init__.py,sha256=iN7u09LaGNifsUxB3A114LhBJT86-QGR9VBpkyBGO40,1539
+swanmetrics/_version.py,sha256=TwPzof9L7jlosL2jMexzNnnv8eLO1skGscq6zLtpok8,103
+swanmetrics-1.0.3.data/data/etc/jupyter/jupyter_server_config.d/swanmetrics.json,sha256=O-mGTsTJWTrDJb0qqDC3nOQJXz8B4bm1ZRMCsurRco0,103
+swanmetrics-1.0.3.dist-info/METADATA,sha256=rl8KhubYfeMVdfaYwfCvQPfY8pVv0iVF6H8QzGxDR3k,901
+swanmetrics-1.0.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+swanmetrics-1.0.3.dist-info/entry_points.txt,sha256=_30ZxQbsnpYomPNf9xJyue3mOlRAWuuPIDl38NUjBLQ,85
+swanmetrics-1.0.3.dist-info/RECORD,,

swanmetrics-1.0.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

swanmetrics-1.0.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[jupyter_server.extensions]
+swanmetrics = swanmetrics:_load_jupyter_server_extension