Follow-ups to config generation reporting in symphony-server

Open
#77 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
prometheus, rust

Research direction

Read issue #75 and the README sections describing config reloads, status.json, and the admin metrics endpoint. The issue lists five deferred edge cases but does not select one or define a change to make. Check whether a specific behavior should be revisited and what outcome is expected before estimating completion.

Written by the indexing model from the issue text.

Description

These are small behaviors left as they are by Report the generation of the config a reload applied in status.json (#75). None of them gives a false appliedGeneration to a writer that reads status.json. Each is here so it can be revisited if someone runs into it.

  • reloadedAt advances on a reload that skipped a proxy. So does symphony_config_reload_time_seconds. This predates generations, and it stays because host-manager falls back to the timestamp on older symphony versions. Consider making it success-only once nothing relies on the old meaning.
  • /metrics.json and the generation samples describe the process that answered. During an overlapped upgrade the admin endpoint can answer from the outgoing process while status.json names the successor. The snapshot carries pid and the README says to compare it. Nothing ties the two together automatically.
  • Generation labels map CR to LF. escapeLabel normalizes line endings, so tokens that differ only by CR and LF render the same in Prometheus. status.json and /metrics.json keep the exact string, and writers use counters or hashes.
  • Two entries for one port-set where one fails. The port is listed in failedGeneration even if the other entry applied and now serves the new generation. host-manager writes one entry per port, so this needs a hand-written config.
  • A running proxy kept beside a successful split. A config that splits one proxy into two, where only one applies, keeps the old proxy because the skipped entry needs its port. The port that applied is then served by both proxies, so some connections get old routes, and status.json lists it twice. The README documents it. Removing the old proxy would leave the skipped port with nothing serving it.

Review-Deferral: a50f8cd314342795 severity=nit category=documentation
Review-Deferral: a4357533996f8c1b severity=nit category=documentation
Review-Deferral: aca0334a249e0dcb severity=nit category=correctness
Review-Deferral: 14972246fe8b3e0e severity=nit category=correctness
Review-Deferral: 40be5c430fabdc85 severity=minor category=correctness

🤖 Generated by Claude Opus 5.5; posted via @kriszyp.

Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
11h 49m
Merged PRs (30d)
12

Getting set up

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 HarperFast/symphony

All issues in HarperFast/symphony

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.