Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add max-days and max-backups default value 0 means for PD (#9330) #9916

Merged

Conversation

ti-chi-bot
Copy link
Member

This is an automated cherry-pick of #9330

What is changed, added or deleted? (Required)

This pull request adds max-days and max-backups default value 0 means for PD configuration guide. There is a similar document for TiKV's max-days and max-backups via #7425 There is no PD one.

Here are the technical backgrounds for these documentation changes.

  1. max-days at PD configuration

https://github.com/tikv/pd/blob/b5e113436c85f81d0e6ca2b5b592271114089db2/conf/config.toml#L97

# max-days = 0

https://github.com/tikv/pd/blob/b5e113436c85f81d0e6ca2b5b592271114089db2/pkg/logutil/log.go#L33-L34

// Max log keep days, default is never deleting.
  MaxDays int `toml:"max-days" json:"max-days"`

It says "default is never deleting."

  1. max-backups at PD configuration

https://github.com/tikv/pd/blob/b5e113436c85f81d0e6ca2b5b592271114089db2/conf/config.toml#L99

# max-backups = 0

https://github.com/tikv/pd/blob/b5e113436c85f81d0e6ca2b5b592271114089db2/pkg/logutil/log.go#L35-L36

  // Maximum number of old log files to retain.
  MaxBackups int `toml:"max-backups" json:"max-backups"`

log.go does not anything about the default value. Based on the method lookup, I believe MaxBackups default behavior is defined by https://github.com/natefinch/lumberjack default value as follows.

https://github.com/pingcap/log/blob/07caf4f152b9d53fedb241dc5e5aaa282fdaa74b/log.go#L126

    MaxBackups: cfg.MaxBackups,

https://github.com/natefinch/lumberjack/blob/47ffae23317c5951a2a6267a069cf676edf53eb6/lumberjack.go#L96-L99

  // MaxBackups is the maximum number of old log files to retain.  The default
  // is to retain all old log files (though MaxAge may still cause them to get
  // deleted.)
  MaxBackups int `json:"maxbackups" yaml:"maxbackups"`

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v6.2 (TiDB 6.2 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot
Copy link
Member Author

ti-chi-bot commented Aug 10, 2022

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • Oreoxmt

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added area/scheduling Indicates that the Issue or PR belongs to the area of scheduling. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-release-5.4 This PR is cherry-picked to release-5.4 from a source PR. type/enhancement This issue/PR improves documentation usability or supplements document content. labels Aug 10, 2022
@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Aug 10, 2022
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Aug 10, 2022

/merge

@ti-chi-bot
Copy link
Member Author

This pull request has been accepted and is ready to merge.

Commit hash: 47c76d9

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Aug 10, 2022
@ti-chi-bot ti-chi-bot merged commit a9177e7 into pingcap:release-5.4 Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/scheduling Indicates that the Issue or PR belongs to the area of scheduling. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1. type/cherry-pick-for-release-5.4 This PR is cherry-picked to release-5.4 from a source PR. type/enhancement This issue/PR improves documentation usability or supplements document content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants