[MeshCore P3] M5 - Realtime WS event + recent API

Open
  • Is something wrong?
#376 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python, redis
Domain
api, backend

Research direction

The issue names no files, so start from the parent issue #267 and the existing MeshCore packet ingest path, then find where observations are written. The change adds a meshcore.packet_path.observed event fired via transaction.on_commit, a Redis-bounded recent buffer, and a GET /api/meshcore/path-tracing/recent/ endpoint. Done means no event for rolled-back ingest, a bounded window returned, and the endpoint documented in OpenAPI. The sampling and cap policy is not specified, so confirm it with the maintainer first.

Written by the indexing model from the issue text.

Description

enhancement

Parent

Part of #267. Milestone M5.

Goal

Short-term operational view of recent MeshCore packet paths.

Scope

  • meshcore.packet_path.observed WS event emitted via transaction.on_commit, best-effort (sampled / coalesced / capped per feeder/channel).
  • Redis-backed bounded recent buffer + GET /api/meshcore/path-tracing/recent/ for reconnect hydration.

Acceptance criteria

  • No event for rolled-back ingest; no subscriber assumes every observation emits an event.
  • Recent endpoint returns a bounded window; documented in OpenAPI.

Out of scope

  • UI (M7).
Dominant language
Python
Stars
1
Forks
0
Avg merge
1d 20h
Merged PRs (30d)
5

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pskillen/meshflow-api

All issues in pskillen/meshflow-api

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.