Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

There is no runbook for the service

Aperta
#350 2 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@felixumeh ci sta già lavorando.

Dal 16/10/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

area:docs difficulty:easy help wanted points:100 Stellar Wave
Background

Lens has ingesters, a websocket fanout, a Redis-backed retention worker with an
in-process fallback, multiple instances, and a Postgres database shared with
another service. None of that operational shape is written down. The knowledge
that the retention worker silently degrades when Redis is away, or that the
ingesters share a connection pool with the API, currently exists only in the
code and in whoever last read it.

What to build

A runbook in the repo — docs/RUNBOOK.md — covering:

  • The processes that run and what each one does.
  • Every external dependency and what degrades when it is unavailable.
  • How to tell whether ingestion is healthy, using /status and /metrics.
  • The known failure modes in this batch and the symptom each presents.
  • How to deploy, how to roll back, and what a deploy interrupts.
  • That Load test (prices) is failing on main and is a known, unrelated red.

Write what is true today, including the ugly parts. A runbook describing an
aspirational system is worse than none.

Acceptance criteria
  • docs/RUNBOOK.md exists and is linked from the README
  • Every external dependency is listed with its degraded behaviour
  • Each documented symptom names the endpoint or metric that shows it
  • Rollback is documented
  • Nothing in it is aspirational — every claim is checkable against the code today

Drips Wave · Complexity: Easy · 100 points


Repo: Divinity-Labs/Lens. Node + TypeScript, Fastify, Prisma on Postgres,
Redis for queues, Prometheus via prom-client.

Run the tests: npm test. The tests are vitest, not jest. Running jest
against this repo reports "66 suites, 0 tests" and means nothing. A single file
is npx vitest run src/__tests__/yourfile.test.ts.

Load test (prices) is already failing on main and has been for some
time. It is not your PR that broke it. Every other check should be green.

This service prices real assets on Stellar mainnet. A number that is wrong
is worse than a number that is missing, because a caller cannot tell the
difference. Prefer failing loudly over returning a plausible value.

Never elide an address, a contract id or a key in code, a comment or a test
fixture.
A previous batch wrote a shortened contract id in an issue text and
five contributors invented plausible-looking ids to fill the gap. Write the
whole thing or do not write it at all.

The house pattern for an outbound deadline already exists — see
src/alerts/delivery.ts, which passes signal: AbortSignal.timeout(10_000) to
fetch. Where an issue below asks for a timeout, copy that, do not invent a
second convention.


Required: Before submitting, join the contributor Telegram so your work can be tracked and counted toward the Stellar Wave: https://t.me/+fxHXq8f1SwlkZDBk

Lingua principale
TypeScript
Stelle
4
Fork
71
Merge medio
1g 15h
PR unite (30g)
28

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Divinity-Labs/Lens

Tutte le issue di Divinity-Labs/Lens

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.