grist-core icon indicating copy to clipboard operation
grist-core copied to clipboard

make a /boot/GRIST_BOOT_KEY page for diagnosing configuration problems

Open paulfitz opened this issue 1 year ago • 3 comments

This is a start at a page for diagnosing problems while setting up Grist. Starting to add some diagnostics based on feedback in github issues. We should make Grist installation easier! But when there is a problem it should be easier to diagnose than it is now, and this may help.

paulfitz avatar Feb 13 '24 12:02 paulfitz

Hi,

I have some questions about this page.

  • When we have homes and workers pod, where checks happen ?
  • Do you plan to add test on folders where Grist write ?

rouja avatar Feb 16 '24 13:02 rouja

* When we have **homes** and **workers** pod, where checks happen ?

That is a good question. I've been viewing this as a way to check the configuration of Grist as a holistic application, rather than checks on the individual servers/workers. In a setup with multiple home servers, the boot page will be served by one of the home servers, and each of the individual probes written so far will run on any of the home servers. Probes could be added that call out to doc workers, or that are more systematic about checking some properties of all servers+workers. I'm hoping to land the basic structure with a small number of probes. Then the UI could be improved independently, and extra probes added independently.

* Do you plan to add test on folders where Grist write ?

That sounds like a very good check to do. Relatedly, for installations that rely on a persistent volume, it would be good to make clear whether the volume has been proven to be persistent across Grist restarts, or if that hasn't yet been demonstrated. I'm not planning to do such tests in the first PR, but would welcome follow-ups :)

paulfitz avatar Feb 16 '24 23:02 paulfitz

Marking this for review even though it is ugly and doesn't have many diagnostics yet, since I'd like to let work on diagnostics and UI happen in parallel. Started https://github.com/gristlabs/grist-core/issues/867 to enumerate diagnostics to add.

paulfitz avatar Feb 23 '24 21:02 paulfitz

rebased after TopAppModelOptions and setUpPage going away.

paulfitz avatar Mar 04 '24 20:03 paulfitz

Thanks @paulfitz.

On the SaaS side, the landing page won't get synced until it's added to electron_files.rsync. Just flagging in case part of the plan was to preview this on staging.

Thanks @georgegevoian. There would also be a tweak needed to the SaaS's webpack config. But I don't plan to immediately enable this on our SaaS, maybe someday when we need it to debug something :-)

paulfitz avatar Mar 04 '24 21:03 paulfitz