registry: add hidden experimental status file argument#311
Open
VDanielEdwards wants to merge 2 commits intomainfrom
Open
registry: add hidden experimental status file argument#311VDanielEdwards wants to merge 2 commits intomainfrom
VDanielEdwards wants to merge 2 commits intomainfrom
Conversation
Signed-off-by: Daniel Edwards <Daniel.Edwards@vector.com>
Signed-off-by: Daniel Edwards <Daniel.Edwards@vector.com>
VDanielEdwards
commented
Apr 23, 2026
|
|
||
| commandlineParser.Add<CliParser::Option>( | ||
| "x-status-file", "", "", "[--x-status-file <path>]", | ||
| "--x-status-file <path>: The registry process will write the current status ('starting' or 'running') as the " |
Member
Author
There was a problem hiding this comment.
The actually used states are starting, running, and stopped.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Subject
This change adds a hidden command line argument
--x-status-fileto thesil-kit-registryexecutable. It expects a path that can be opened for file creation, truncation, and writing.The registry will rewrite this files content to
startingat an early point in the startup procedure.After the registry has started listening for incoming connection, the files content will be rewritten to
running.When the registry is shutting down 'normally' (e.g., CTRL-C, handled signals, or a handled exception) the files content will be rewritten to
stopped. The file is also deleted afterwards. The rewrite ensures that even if the file cannot be deleted for some reason, it will not containrunninganymore.Such a status file is very useful for implementing a health check for orchestrated container setups, e.g., using
docker-compose. It allows the user to ensure that participant containers are only started after the registry is up.Why Hidden & Experimental
The argument is useful in this state (for the example given above), but it may not be enough. We might think about either adding a separate PID-file argument, or integrate that functionality with this argument.
Personally I believe that this needs to be used in our own workflows until it's clear that it can be 'released'.
Developer checklist (address before review)