add log rotation configuration for phi log #63
Merged
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
HenryKeiter
reviewed
Dec 15, 2022
README.md
Outdated
| @@ -48,6 +48,8 @@ Example: | |||
| ```ruby | |||
| PhiAttrs.configure do |conf| | |||
| conf.log_path = Rails.root.join("log", "phi_access_#{Rails.env}.log") | |||
| conf.log_shift_age = 10 # how many logs to keep of `log_shift_size` or frequency to rotate (daily, weekly or monthly) | |||
| conf.log_shift_size = 100.megabyte # size in bytes when using `log_shift_age` as a number | |||
There was a problem hiding this comment.
I assume this needs to be plural
There was a problem hiding this comment.
Either works in rails.
README.md
Outdated
| @@ -48,6 +48,8 @@ Example: | |||
| ```ruby | |||
| PhiAttrs.configure do |conf| | |||
| conf.log_path = Rails.root.join("log", "phi_access_#{Rails.env}.log") | |||
| conf.log_shift_age = 10 # how many logs to keep of `log_shift_size` or frequency to rotate (daily, weekly or monthly) | |||
There was a problem hiding this comment.
Should include info about 0 == disabled here
| @@ -2,4 +2,8 @@ | |||
|
|
|||
| PhiAttrs.configure do |conf| | |||
| conf.log_path = Rails.root.join('log', 'phi_access.log') | |||
|
|
|||
| # Log Rotation - disabled by default | |||
| conf.log_shift_age = 0 # how many logs to keep of `shift_size` | |||
There was a problem hiding this comment.
Should indicate here that 0 is "disabled"
HenryKeiter
approved these changes
Dec 15, 2022
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.
Fixes #62 and allows rotation configuration to be passed in along with the path. Rotation is disabled by default.
For more information on the defaults see https://apidock.com/ruby/Logger/new/class