Observability: metrics, logging, and tracing
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 4
- Forks
- 0
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Summary
Implement observability infrastructure for apex: Prometheus metrics, structured logging, and OpenTelemetry tracing.
Metrics
Instrument all subsystems with OTel metrics exposed via Prometheus endpoint.
Sync engine
apex_sync_head(gauge) — last synced heightapex_sync_network_head(gauge) — upstream network headapex_sync_lag_seconds(gauge) — time behind network headapex_sync_backfill_duration(histogram) — per-batch backfill latencyapex_sync_errors_total(counter) — sync errors by typeapex_sync_backfill_progress_pct(gauge) — backfill completion percentage
API
apex_rpc_request_duration(histogram) — per-method latencyapex_rpc_request_total(counter) — per-method call countapex_rpc_errors_total(counter) — per-method errors
Store
apex_store_query_duration(histogram) — SQLite query latencyapex_store_insert_duration(histogram) — insert latencyapex_store_size_bytes(gauge) — DB file size
Subscriptions
apex_subscriptions_active(gauge) — active subscription countapex_subscription_deliveries(counter) — messages deliveredapex_subscription_drops(counter) — messages dropped (slow reader)
Node
apex_build_info(gauge) — with version labelsapex_uptime_seconds(counter)
Logging
- Use
slog(Go stdlib) — no heavy dependencies likeipfs/go-log - Structured key-value pairs: height, namespace, method, duration, error
- Configurable log level at startup (and ideally at runtime via admin endpoint)
Tracing
- OpenTelemetry spans for sync fetch, store operations, and RPC handlers
- Configurable exporter (stdout for dev, OTLP for production)
API endpoint
Expose a unified SyncStatus() endpoint returning current synced height, network head, sync state (backfilling/streaming), lag, and active subscriptions in one call. celestia-node spreads this across 4 separate modules.
Configuration
[observability]
metrics_address = "0.0.0.0:9090" # Prometheus endpoint
log_level = "info" # debug, info, warn, error
tracing_enabled = false
tracing_endpoint = "" # OTLP endpoint
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza por mapear los puntos de entrada del motor de sincronización, la API, el almacén, las suscripciones, el nodo y la configuración, y después decide cómo encajan entre sí los requisitos de métricas, registro con slog y tracing. Verifica el endpoint de Prometheus, la respuesta SyncStatus, la configuración TOML y cada métrica y span indicados; la issue no menciona archivos ni tests, por lo que las ubicaciones de los tests deben identificarse durante la investigación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- go, prometheus, sqlite
- Área
- api, backend, databases, observability
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100