Skip to content

docs(metrics): präzisiere sse_events_published_total Beschreibung (Audit #67)#119

Merged
strausmann merged 1 commit into
mainfrom
fix/sse-metric-description
Jun 14, 2026
Merged

docs(metrics): präzisiere sse_events_published_total Beschreibung (Audit #67)#119
strausmann merged 1 commit into
mainfrom
fix/sse-metric-description

Conversation

@strausmann

Copy link
Copy Markdown
Owner

Summary

Der printer_hub_sse_events_published_total Counter wird im Subscriber-Loop pro publish()-Event pro aktivem Client inkrementiert — also N mal pro publish bei N Clients. Der Metric-Name suggeriert "1 pro publish" — Audit #67 hatte das als irreführend markiert.

Name bleibt wegen Grafana-Dashboard-Kompatibilität. Description + Code-Comment klären die Semantik jetzt:

Total SSE events delivered to subscribers (one increment per subscriber per publish)

Test plan

  • Keine Code-Pfad-Änderung — nur Counter-Beschreibung
  • /metrics-Endpoint zeigt die neue HELP-Zeile

Refs #67 Audit-Punkt: PR #65 — events.py:208 — sse_events_published_total inflation

…dit #67)

Der Counter wird im Subscriber-Loop pro publish()-Event pro aktivem
Subscriber inkrementiert — semantisch also "delivered to subscriber",
nicht "published once" wie der Name vermuten lässt.

Audit #67 hatte das als irreführend markiert. Name bleibt aus Gründen
der Grafana-Dashboard-Kompatibilität, Description+Code-Comment klären
die Semantik nun.

Refs #67 Audit-Punkt: "PR #65 — events.py:208 — sse_events_published_total inflation"

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 14, 2026 12:58

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@strausmann
strausmann merged commit ab8c4c4 into main Jun 14, 2026
14 checks passed
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Diese Änderung korrigiert die irreführende Dokumentation des 'sse_events_published_total' Counters. Da der Name aus Gründen der Abwärtskompatibilität mit bestehenden Grafana-Dashboards beibehalten werden muss, wurde die Beschreibung angepasst, um die tatsächliche Zählweise – ein Inkrement pro Subscriber pro Publish – präzise abzubilden.

Highlights

  • Präzisierung der Metrik-Beschreibung: Die Beschreibung des 'sse_events_published_total' Counters wurde aktualisiert, um klarzustellen, dass der Zähler pro Subscriber und nicht pro Publish-Event inkrementiert wird.
  • Beibehaltung des Metrik-Namens: Der Name der Metrik bleibt unverändert, um die Kompatibilität mit bestehenden Grafana-Dashboards zu gewährleisten.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@strausmann
strausmann deleted the fix/sse-metric-description branch June 14, 2026 12:58

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the description and adds explanatory comments to the sse_events_published_total metric in backend/app/api/routes/events.py to clarify its behavior. The review feedback suggests using standard German umlauts instead of digraphs in the comments to maintain consistency with the rest of the codebase.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +59 to +63
# Inkrementiert pro SSE-Subscriber, nicht pro publish()-Call: ein
# publish() mit N aktiven Clients erhoeht den Counter um N. Der
# Metric-Name ist aus historischen Gruenden behalten (Grafana-
# Dashboards) — semantisch ist es "delivered to subscriber",
# nicht "published once" (siehe Audit #67 Hinweis).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Für eine konsistente Schreibweise im gesamten Projekt sollten echte deutsche Umlaute (ö, ü) anstelle von Umlaut-Ersatzzeichen (oe, ue) verwendet werden, da diese auch in anderen Dateien wie config.py (z. B. „gelöscht“, „beschränkt“) standardmäßig genutzt werden.

Suggested change
# Inkrementiert pro SSE-Subscriber, nicht pro publish()-Call: ein
# publish() mit N aktiven Clients erhoeht den Counter um N. Der
# Metric-Name ist aus historischen Gruenden behalten (Grafana-
# Dashboards) — semantisch ist es "delivered to subscriber",
# nicht "published once" (siehe Audit #67 Hinweis).
# Inkrementiert pro SSE-Subscriber, nicht pro publish()-Call: ein
# publish() mit N aktiven Clients erhöht den Counter um N. Der
# Metric-Name ist aus historischen Gründen behalten (Grafana-
# Dashboards) — semantisch ist es "delivered to subscriber",
# nicht "published once" (siehe Audit #67 Hinweis).

@codecov

codecov Bot commented Jun 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.24%. Comparing base (0faab99) to head (d7e6055).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #119      +/-   ##
==========================================
- Coverage   89.26%   89.24%   -0.03%     
==========================================
  Files          91       91              
  Lines        4257     4257              
  Branches      369      369              
==========================================
- Hits         3800     3799       -1     
- Misses        359      360       +1     
  Partials       98       98              
Components Coverage Δ
Printer Backends (transport) 86.87% <ø> (ø)
Printer Models (drivers) 88.20% <ø> (ø)
Services 91.20% <ø> (-0.07%) ⬇️
REST API 84.97% <ø> (ø)
Pydantic Schemas 100.00% <ø> (ø)
Integration Plugins 100.00% <ø> (ø)
Files with missing lines Coverage Δ
backend/app/api/routes/events.py 82.78% <ø> (ø)

... and 1 file with indirect coverage changes

Flag Coverage Δ
backend 89.24% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0faab99...d7e6055. Read the comment docs.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions Bot pushed a commit that referenced this pull request Jun 15, 2026
## <small>0.10.2 (2026-06-15)</small>

* refactor(main): _resolve_model_id_from_config nimmt PrinterYAMLConfig statt Any (#67) (#123) ([2ff51d2](2ff51d2)), closes [#67](#67) [#123](#123) [#67](#67) [#59](#59) [#67](#67) [#59](#59)
* refactor(snipeit): typisiere response payload als TypedDict statt dict[str, Any] (#67) (#122) ([e88601b](e88601b)), closes [#67](#67) [#122](#122) [#67](#67) [#67](#67) [#51](#51)
* perf(lifespan): plugin-discovery in Thread auslagern (Audit #67) (#121) ([48215b4](48215b4)), closes [#67](#67) [#121](#121) [#67](#67) [#59](#59)
* fix(config): stricter validation for log_level + webhook_api_key (#46) (#116) ([6b8ac30](6b8ac30)), closes [#46](#46) [#116](#116) [#46](#46) [#46](#46) [#46](#46) [#46](#46) [#116](#116)
* fix(print): copies-replication erzeugt UNIQUE job_ids (Round 2 #hangar-109) (#120) ([bd781ae](bd781ae)), closes [#hangar-109](https://github.com/strausmann/label-printer-hub/issues/hangar-109) [#120](#120) [#115](#115)
* fix(print): PrintOptions.copies replicates images for hardware print (#hangar-109) (#115) ([d27bbcc](d27bbcc)), closes [#hangar-109](https://github.com/strausmann/label-printer-hub/issues/hangar-109) [#115](#115) [strausmann/hangar#109](https://github.com/strausmann/hangar/issues/109)
* docs(metrics): präzisiere sse_events_published_total Beschreibung (Audit #67) (#119) ([ab8c4c4](ab8c4c4)), closes [#67](#67) [#119](#119) [#67](#67) [#67](#67) [#65](#65)
* docs(ptouch): korrigiere Tape-Klassen-Namen in ptouch-integration.md (Audit #67) (#118) ([0faab99](0faab99)), closes [#67](#67) [#118](#118) [#67](#67) [#59](#59)
* chore(readme): codecov badge ohne embedded Token (Audit #67) (#117) ([4bb5423](4bb5423)), closes [#67](#67) [#117](#117) [#67](#67) [#59](#59)

[skip ci]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants