Merge pull request #25 from insight-platform/10-11-samples-n-benchmark

Resolve #10, #11: E2E samples and benchmarks, release Dockerfile, better naming

*
  * better naming to be better aligned with Savant repo and have Docker images configured similarly
  * no environment variables prefix for the same reason
  * fix some typos

*
  * Dockerfile build based on uv build
  * different E2E samples: plain HTTP stream, SSL stream, Nginx based setup, high frame rate
  * benchmarks: normal frame rate and high frame rate
  * benchmarks metrics: Message Drops, Total Messages, Messages per Second, Total Data transferred, Data per Second, Average Message Delay, Message Delay Histogram
  * don't run `prometheus` and `otlp-collector` with default Dev Containers start. There is option to run it with docker compose `docker -f .devcontainer/compose.yaml -f .devcontainer/compose.services.yaml up`
  * use git LFS for images and video, enable it for the dev container

Author: abukharov268

.devcontainer/compose.services.yaml

@@ -0,0 +1,20 @@
+services:
+  prometheus:
+    image: prom/prometheus:latest
+    ports:
+      - 9090:9090
+    volumes:
+      - ./configs/prometheus.yml:/etc/prometheus/prometheus.yml
+    command:
+      - --config.file=/etc/prometheus/prometheus.yml
+      - --storage.tsdb.path=/prometheus
+      - --web.enable-otlp-receiver
+    networks:
+      - dev
+      
+  otlp-collector:                                                                                                                                                       
+    image: otel/opentelemetry-collector-contrib:latest                                                                                                                                          
+    volumes:                            
+      - ./configs/otlp-collector.yaml:/etc/otelcol-contrib/config.yaml
+    networks:
+      - dev

.devcontainer/compose.yaml

@@ -6,27 +6,12 @@ services:
         REMOTE_USER: ${USER}
         REMOTE_UID: ${REMOTE_UID:-1000}
         REMOTE_GID: ${REMOTE_GID:-1000}
-    command: /bin/sh -c "while sleep 1000; do :; done"
     volumes:
       - ..:/workspace:cached
-    depends_on:
-      prometheus:
-        condition: service_started
-        required: false
-      otlp-collector:
-        condition: service_started
-        required: false
-  prometheus:
-    image: prom/prometheus:latest
-    ports:
-      - 9090:9090
-    volumes:
-      - ./configs/prometheus.yml:/etc/prometheus/prometheus.yml
-    command:
-      - --config.file=/etc/prometheus/prometheus.yml
-      - --storage.tsdb.path=/prometheus
-      - --web.enable-otlp-receiver
-  otlp-collector:                                                                                                                                                       
-    image: otel/opentelemetry-collector-contrib:latest                                                                                                                                          
-    volumes:                            
-      - ./configs/otlp-collector.yaml:/etc/otelcol-contrib/config.yaml     
+    networks:
+      - dev
+
+networks:
+  dev:
+    name: dev
+    driver: bridge

.devcontainer/devcontainer.json

@@ -1,12 +1,14 @@
 {
   "dockerComposeFile": "./compose.yaml",
-  "remoteUser": "${localEnv:REMOTE_USER}",
   "service": "cloud-pin",
-  "runServices": ["cloud-pin"],
+  "shutdownAction": "stopCompose",
+  "overrideCommand": true,
+  "remoteUser": "${localEnv:REMOTE_USER}",
   "workspaceFolder": "/workspace",
   "features": {
     "ghcr.io/devcontainers-extra/features/uv:1": {},
-    "ghcr.io/devcontainers/features/git:1": {}
+    "ghcr.io/devcontainers/features/git:1": {},
+    "ghcr.io/devcontainers/features/git-lfs:1": {}
   },
   "containerEnv": {
     "UV_LINK_MODE": "copy"

.gitattributes

@@ -0,0 +1,4 @@
+*.psd filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -205,3 +205,8 @@ cython_debug/
 marimo/_static/
 marimo/_lsp/
 __marimo__/
+
+
+# Project temporary files
+/tmp/
+/samples/benchmarks/reports

Dockerfile

@@ -0,0 +1,23 @@
+FROM ghcr.io/insight-platform/savant-rs-py314:savant-latest AS build
+
+RUN apt-get update && apt-get install -y build-essential
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+COPY . /build/
+WORKDIR /build/
+RUN uv pip install --system --requirements pyproject.toml && \
+    uv build && \
+    CLOUDPIN_VERSION=`uv version --short` && \
+    uv pip install --system "savant-cloudpin @ /build/dist/savant_cloudpin-$CLOUDPIN_VERSION.tar.gz"
+
+WORKDIR /
+RUN uv cache clean && \
+    apt-get remove -y build-essential && \
+    apt autoremove -y && \
+    apt clean && \
+    rm -rf /bin/uv /bin/uvx /build /var/lib/apt/lists/*
+
+
+FROM build AS savant-cloudpin
+
+ENTRYPOINT ["python", "-m", "savant_cloudpin"]

README.md

@@ -17,3 +17,5 @@ where channels:
   * Pipeline sink (ZMQ Dealer) - 3
   * Pipeline source (ZMQ Router) - 4
   * Downstream bridge (WS) - 5
+
+There are [samples and benchmarks](samples/README.md)

pyproject.toml

@@ -3,6 +3,7 @@ name = "savant-cloudpin"
 version = "0.1.0"
 description = "A service to run Savant pipeline remotely (cloud) via WebSockets (WS)"
 readme = "README.md"
+license-files = ["LICEN[CS]E*"]
 requires-python = ">=3.14"
 dependencies = [
     "aiohttp>=3.13.2",
@@ -48,3 +49,12 @@ dev = [
     "pytest-xdist>=3.8.0",
     "ruff>=0.14.4",
 ]
+
+[tool.uv.build-backend]
+source-include = ["savant_cloudpin/**"]
+module-name = "savant_cloudpin"
+module-root = ""
+
+[build-system]
+requires = ["uv_build>=0.9.8,<0.10.0"]
+build-backend = "uv_build"

samples/README.md

@@ -0,0 +1,6 @@
+# Samples and benchmarks
+
+* [Plain HTTP setup](./http/README.md)
+* [SSL secured setup](./ssl/README.md)
+* [Nginx usage](./nginx/README.md)
+* [High frame rate demo](./no_sync/README.md)