docs

Author: grigi

README.md

@@ -7,7 +7,7 @@ It is similar to [RQ](https://github.com/rq/rq) and heavily inspired by [ARQ](ht
 
 SAQ optionally comes with a simple UI for monitor workers and jobs.
 
-<img src="web.png" alt="SAQ Web UI" style="width:100%;"/>
+<img src="docs/web.png" alt="SAQ Web UI" style="width:100%;"/>
 
 ## Install
 ```

docs/conf.py

@@ -51,6 +51,9 @@
     },
 ]
 
+myst_enable_extensions = [
+    "fieldlist"
+]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

docs/getting_started.md

@@ -118,7 +118,7 @@ await queue.enqueue("test", a=1, scheduled=time.time() + 10)
 Start the worker
 
 ```nasm
-python -m saq examples.simple.settings --web
+saq examples.simple.settings --web
 ```
 
 Navigate to the [web ui](http://localhost:8080])

docs/index.md

@@ -4,6 +4,7 @@
 :hidden:
 
 getting_started
+monitoring
 comparison
 benchmarks
 apidocs/index
@@ -17,7 +18,11 @@ It is similar to [RQ](https://github.com/rq/rq) and heavily inspired by [ARQ](ht
 
 SAQ optionally comes with a simple UI for monitor workers and jobs:
 
-<img src="web.png" alt="SAQ Web UI" style="width:100%;"/>
+```{figure-md}
+![SAQ Web UI](web.png){width=100%}
+
+SAQ Web UI
+```
 
 # Indices and tables
 

docs/monitoring.md

@@ -0,0 +1,57 @@
+# Monitoring
+
+SAQ comes with a simple UI for monitor workers and jobs:
+
+```{figure-md}
+![SAQ Web UI](web.png){width=100%}
+
+SAQ Web UI
+```
+
+## Part of worker process
+
+You can run it as part of the worker process:
+```nasm
+saq examples.simple.settings --web
+```
+which wil serve it on port 8080 by default. You can specify a custom port by adding `--port <portnum>`. e.g.:
+```nasm
+saq examples.simple.settings --web --port 7000
+```
+
+## Mounted in your own web service
+You can also mount the Web UI as part of your own web service
+
+### Starlette/FastAPI
+Module `saq.web.starlette` contains a starlette instance for use in anything that is derived from Starlette.
+
+**Starlette**
+```python
+from saq.web.starlette import saq_web
+from starlette.routing import Mount
+
+routes = [
+    ...
+    Mount("/monitor", saq_web("/monitor", queues=all_the_queues_list))
+]
+```
+
+**FastAPI**
+```python
+from fastapi import FastAPI
+from saq.web.starlette import saq_web
+
+app = FastAPI()
+
+app.mount("/monitor", saq_web("/monitor", queues=all_the_queues_list))
+```
+
+
+```{py:function} saq_web(root_path: str, queues: list[Queue]) -> Starlette:
+
+Create an embeddable monitoring Web UI
+
+:param str root_path: The absolute mount point
+:param list[Queue] queue: The list of known queues
+:rtype: Starlette
+```