refactor: interface-layer OpenTelemetry runtime follow-ups deferred from #802
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 52/100
- Tipo di issue
- Refactoring
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- python
- Ambito
- observability
Direzione di ricerca
Scegli un elemento con ambito indipendente, quindi leggi data_designer/integrations/opentelemetry.py e le sezioni referenziate di data_designer.py, observability.py o async_scheduler.py. Conferma innanzitutto il comportamento esistente del runtime e del protocollo; il lavoro è completato quando la modifica selezionata relativa a tipizzazione, contratto, performance, semantica delle metriche o ciclo di vita è implementata senza estenderla agli elementi di progettazione opzionali.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Priority Level
Low
Task Summary
PR #802 added the default pull-based OpenTelemetry/Prometheus metrics exporter (data_designer.integrations.opentelemetry.OpenTelemetryRuntime). During review a set of non-blocking polish/design items were intentionally deferred rather than expanded that PR's scope. This issue tracks them so they aren't lost.
None of these are correctness blockers — the PR shipped as "Ship it (with nits)." They are hygiene, typing, perf, and design-consolidation items localized to the interface-layer OTel runtime (plus two small engine-seam items).
Line references are against head 9aee1dde of #802.
Technical Details & Implementation Plan
Small / low-risk
- Document the deliberate log-handler swallow.
_MetricLogHandler.emit(opentelemetry.py:69-73) is a silentexcept Exception: pass. This is defensible (logging from inside a failing log handler risks recursion), but it's now the lone silent swallow in the module. Add a short comment explaining the silence is intentional so nobody "fixes" it into re-entrant logging. - Tighten
Any-typed instrument attributes. ~11 runtime attributes (opentelemetry.py:87-99:_registry,_meter_provider,_server, the instruments, etc.) are typedAnybecause OTel types aren't imported at module scope. Import them underTYPE_CHECKINGand annotate precisely (Histogram,Counter,UpDownCounter,ObservableGauge,MeterProvider,CollectorRegistry,HTTPServer). - DRY the enablement rule.
self._open_telemetry if self._run_config.otel_metrics_port is not None else Noneis duplicated at three call sites indata_designer.py(:753,754,762) plus the port passed intoobserve_create. Extract aself._metrics_sink()accessor.
Protocol / contract
- Declare the
accepts_*filters on the sink Protocols.scheduler_event_sink_accepts/request_event_sink_acceptsprobegetattr(sink, "accepts_*_event", None)(observability.py:276,324) for methods that aren't declared onSchedulerAdmissionEventSink/RequestAdmissionEventSink. A rename/typo silently degrades a filter to "accept everything." Also, onlySchedulerAdmissionEventSinkis@runtime_checkable(:217) —RequestAdmissionEventSink(:313) is not. Declareaccepts_*on the Protocols (or aFiltering*sub-Protocol) and apply@runtime_checkableconsistently.
Perf
- Lock-free interest check.
accepts_scheduler_event/accepts_request_event(opentelemetry.py:145-151) acquire the process-wideRLockon every event, on the hottest paths (the scheduler emits many events per task). Since the check only readsbool(self._active_run_ids)plus a static membership test, consider a lock-free "any run active" flag (updated under the lock, read without it) so the cheap gate stays lock- and allocation-free. Measure first.
Metric semantics
- Progress gauge starts at 0 on resume.
data_designer.dataset.progressuses the full job total as the denominator (_start_dataset_progress,opentelemetry.py:422-427;row_group_total_rowsfromasync_scheduler.py:326,1091) but the numerator only accrues checkpoints observed in the current run. A resumed (already-partway) job reads near 0 climbing up. Seedinitial_completed_recordsinto the starting(scheduled, processed)tuple, or document the limitation in the metric description.
Larger / optional design consolidation
- Split
OpenTelemetryRuntime. Extract the dataset-progress math (_start_/_advance_/_finish_active_dataset,_active_dataset_progress) into a small OTel-agnostic, directly unit-testableDatasetProgressTracker, and consider a typed_MetricInstrumentscontainer; leave the runtime as orchestration + lifecycle. - Lazy-construct the singleton. Module import constructs
_RUNTIMEand registersatexitas a side effect (opentelemetry.py:520-521). Consider constructing lazily on firstget_open_telemetry_runtime()call and registeringatexitthere once. - Per-run progress-gauge label.
_dataset_progress_valueis a single process-wide float blended across concurrent creates, with the last finished value lingering. If overlapping creates become a supported dashboard scenario, add a per-run gauge label. (Metric-schema change — only if needed.)
Investigation / Context
- Deferred from PR #802 (feat: add OpenTelemetry metrics for create jobs).
- Related: #447 (introduce
AsyncRunControllerand explicit build/preview sinks) covers the adjacent scheduler-side "converge emission seams into one fan-out" direction — #802 already added_FanoutSchedulerEventSinkas a first step. The items here are scoped to the interface-layer OTel exporter, which #447 and the #645 observability epic do not cover.
Dependencies
None. Independent polish; can be picked up piecemeal.
- Lingua principale
- Python
- Stelle
- 2.3k
- Fork
- 211
- Merge medio
- 3g 11h
- PR unite (30g)
- 48
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di NVIDIA-NeMo/DataDesigner
-
task
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
NVIDIA-NeMo/DataDesigner#760 ·
-
enhancement triaged
Difficoltà 4/5 3-5 giorni Idoneità per principianti 40/100
NVIDIA-NeMo/DataDesigner#956 ·
-
task
Difficoltà 5/5 Più di una settimana Idoneità per principianti 42/100
NVIDIA-NeMo/DataDesigner#947 ·
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 52/100
NVIDIA-NeMo/DataDesigner#946 · 1 commento ·
-
task
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
NVIDIA-NeMo/DataDesigner#885 ·
Tutte le issue di NVIDIA-NeMo/DataDesigner
Issue simili
-
bug confirmed issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
open-webui/open-webui#30750 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
OpenwaterHealth/openmotion-bloodflow-app#604 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
good first issue
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100