oasisprotocol / oasisprotocol/oasis-core

Dump active configuration at every start and configuration reload

Open
#6,162 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
369
Forks
151
Avg merge
1d 3h
Merged PRs (30d)
6

Description

SUMMARY

When debugging issues it is helpful to see the exact config file that is being used by oasis-node. On one hand node operators typically forget to provide it, on the other hand with envsubst support and the upcoming config hot-reloading it will be even less obvious what configuration is being used.

I suggest that at every start (and configuration reload) the active oasis-node configuration is dumped into logs at debug level (maybe as a base64-encoded one-line log entry).

ISSUE TYPE
  • Feature Idea
COMPONENT NAME
  • config
ADDITIONAL INFORMATION

Contributor guide

Open the 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.

Research direction

Start with go/config/config.go, including the envsubst-related code linked in the issue, and read issue #6154 for the configuration reload path. Trace how oasis-node loads configuration at startup and reloads it, then identify the existing debug logging entry points. Done means the active configuration is dumped at debug level after both startup and configuration reload.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.