swanmetrics 1.0.3__tar.gz

swanmetrics-1.0.3/.bumpversion.cfg

@@ -0,0 +1,8 @@
+[bumpversion]
+current_version = 1.0.3
+commit = True
+tag = True
+tag_name = SwanMetrics/v{new_version}
+message = SwanMetrics v{new_version}
+
+[bumpversion:file:swanmetrics/_version.py]

swanmetrics-1.0.3/.gitignore

@@ -0,0 +1,267 @@
+*/*/js/
+*/*/nbextension/extension.js
+!SwanContents/swancontents/js/
+SparkMonitor/scalalistener/project/
+SparkMonitor/scalalistener/target/
+SparkMonitor/sparkmonitor/listener*.jar
+SparkMonitor/sparkmonitor/nbextension/*
+.idea/
+
+# 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/
+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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# Mac OS files
+.DS_Store

swanmetrics-1.0.3/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,21 @@
+# 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/jupyter_server_config.d/swanmetrics.json

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

swanmetrics-1.0.3/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["hatchling==1.28.0"]
+build-backend = "hatchling.build"
+
+[project]
+name = "swanmetrics"
+dynamic = ["version"]
+description = "Jupyter Server extension for collecting metrics via jupyter_events"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [{ name = "SWAN Team", email = "swan-admins@cern.ch" }]
+dependencies = ["jupyter_server==2.15.0", "jupyter_events==0.12.0"]
+
+[project.entry-points."jupyter_server.extensions"]
+swanmetrics = "swanmetrics:_load_jupyter_server_extension"
+
+[tool.hatch]
+version = { path = "swanmetrics/_version.py" }
+
+[tool.hatch.build.targets.wheel]
+packages = ["swanmetrics"]
+
+[tool.hatch.build.targets.wheel.shared-data]
+"jupyter_server_config.d/swanmetrics.json" = "etc/jupyter/jupyter_server_config.d/swanmetrics.json"

swanmetrics-1.0.3/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-1.0.3/swanmetrics/_version.py

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