feat: log to base dir #5197
Merged
feat: log to base dir #5197
Conversation
This file contains 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
Instead of feeding log4rs a file, load the yaml and feed log4rs a string. The purpose of this is to prepare the file contents for manipulation before handing them over to log4rs.
This is because we will need to know the path to replace in the contents.
Use a simple and naive placeholder swap out.
All other base_node directories in the config directory are consistent with underscores except the log dir. Until now.
I think the log was meant to print to stdout as well as the miner appender. It was done by duplicated a section of yaml, but that infact overrides one for the other. So we only had stdout, and never to the log file. Remove the duplicated block, and have all output go to stdout and the miner logfile.
I chose to remove tari_miner in favour of tari::miner to match the standard of the base node. The wallet is still an outlier but none of them use the tari_APP scheme so this was an outlier.
stringhandler
approved these changes
Feb 21, 2023
stringhandler
approved these changes
Feb 28, 2023
stringhandler
pushed a commit
that referenced
this pull request
Mar 8, 2023
### ⚠ BREAKING CHANGES * **peer_db:** more accurate peer stats per address (5142) * use consensus hashing API for validator node MMR (5207) * **consensus:** add balanced binary merkle tree (5189) ### Features * add favourite flag to contact ([5217](#5217)) ([0371b60](0371b60)) * add indexer config ([5210](#5210)) ([cf95601](cf95601)) * add merge proof for balanced binary merkle tree ([5193](#5193)) ([8962909](8962909)) * **consensus:** add balanced binary merkle tree ([5189](#5189)) ([8d34e8a](8d34e8a)) * log to base dir ([#5197](#5197)) ([5147b5c](5147b5c)) * **peer_db:** more accurate peer stats per address ([5142](#5142)) ([fdad1c6](fdad1c6)) ### Bug Fixes * add grpc commitment signature proto type ([5200](#5200)) ([d523f1e](d523f1e)) * peer seeds for esme/igor ([5202](#5202)) ([1bc226c](1bc226c)) * remove panics from merged BBMT verification ([5221](#5221)) ([a4c5fce](a4c5fce)) * source coverage ci failure ([5209](#5209)) ([80294a1](80294a1)) * use consensus hashing API for validator node MMR ([5207](#5207)) ([de28115](de28115)) * wallet reuse existing tor address ([5092](#5092)) ([576f44e](576f44e)) * **wallet:** avoids empty addresses in node identity ([5224](#5224)) ([1a66312](1a66312))
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.
Description
-boption on application startup, and dynamically replace the new{{log_dir}}placeholder value inside the log4rs files.base-nodetobase_nodeMotivation and Context
log4rs considers the cli working directory the root. From there it appends the
pathfrom the log4rs yaml file as a relative path (unless it's an absolute path). The problem with this is that it completely disregards the standard Tari cli option-bfor assigning a base directory. This can result in the configuration in the expected assigned location, and the logging ending up in whatever working directory you happened to be in at the time. This has resulted in me finding lots of orphaned logging directories and files spread over my local system.How Has This Been Tested?
Tested locally by using the
-boption to a location different than the current working directory and ensuring all config and logs end up in the directory provided. Whereas before thelogdir still would have been created in the working directory.BREAKING CHANGE: This PR changes the logging configuration which is only generated on the first run. Users may wish to remove log config files:
base_dir/config/base_node/log4rs.ymlbase_dir/config/miner/log4rs.ymlbase_dir/config/wallet/log4rs.yml