forked from cosmos/cosmos-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add a cli cmd to prune old states according to current settings…
… (backport cosmos#12742) (cosmos#13120) * feat: Add a cli cmd to prune old states according to current settings (cosmos#12742) * add PruningCmd and change PruneStores signature * the mimimum default pruning interval is 10 Co-authored-by: Marko <[email protected]> (cherry picked from commit d874ace) # Conflicts: # CHANGELOG.md # store/rootmulti/store.go * fix backport error and conflicts Co-authored-by: adu-crypto <[email protected]> Co-authored-by: adu <[email protected]>
- Loading branch information
1 parent
bdfb6e0
commit acf61c0
Showing
5 changed files
with
205 additions
and
97 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,121 @@ | ||
| package pruning | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| dbm "github.com/cosmos/cosmos-db" | ||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/viper" | ||
|
|
||
| corestore "cosmossdk.io/core/store" | ||
| "cosmossdk.io/log" | ||
| pruningtypes "cosmossdk.io/store/pruning/types" | ||
| "cosmossdk.io/store/rootmulti" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/client/flags" | ||
| "github.com/cosmos/cosmos-sdk/server" | ||
| servertypes "github.com/cosmos/cosmos-sdk/server/types" | ||
| "github.com/cosmos/cosmos-sdk/version" | ||
| "github.com/cosmos/cosmos-sdk/store/rootmulti" | ||
| storetypes "github.com/cosmos/cosmos-sdk/store/types" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/tendermint/tendermint/libs/log" | ||
| dbm "github.com/tendermint/tm-db" | ||
| ) | ||
|
|
||
| const FlagAppDBBackend = "app-db-backend" | ||
|
|
||
| // Cmd prunes the sdk root multi store history versions based on the pruning options | ||
| // PruningCmd prunes the sdk root multi store history versions based on the pruning options | ||
| // specified by command flags. | ||
| func Cmd[T servertypes.Application](appCreator servertypes.AppCreator[T]) *cobra.Command { | ||
| func PruningCmd(appCreator servertypes.AppCreator) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "prune [pruning-method]", | ||
| Use: "prune", | ||
| Short: "Prune app history states by keeping the recent heights and deleting old heights", | ||
| Long: `Prune app history states by keeping the recent heights and deleting old heights. | ||
| The pruning option is provided via the 'pruning' argument or alternatively with '--pruning-keep-recent' | ||
| - default: the last 362880 states are kept | ||
| - nothing: all historic states will be saved, nothing will be deleted (i.e. archiving node) | ||
| - everything: 2 latest states will be kept | ||
| - custom: allow pruning options to be manually specified through 'pruning-keep-recent' | ||
| Note: When the --app-db-backend flag is not specified, the default backend type is 'goleveldb'. | ||
| Supported app-db-backend types include 'goleveldb', 'rocksdb', 'pebbledb'.`, | ||
| Example: fmt.Sprintf("%s prune custom --pruning-keep-recent 100 --app-db-backend 'goleveldb'", version.AppName), | ||
| Args: cobra.RangeArgs(0, 1), | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| // bind flags to the Context's Viper so we can get pruning options. | ||
| The pruning option is provided via the '--pruning' flag or alternatively with '--pruning-keep-recent' | ||
| For '--pruning' the options are as follows: | ||
| default: the last 362880 states are kept | ||
| nothing: all historic states will be saved, nothing will be deleted (i.e. archiving node) | ||
| everything: 2 latest states will be kept | ||
| custom: allow pruning options to be manually specified through 'pruning-keep-recent'. | ||
| besides pruning options, database home directory and database backend type should also be specified via flags | ||
| '--home' and '--app-db-backend'. | ||
| valid app-db-backend type includes 'goleveldb', 'cleveldb', 'rocksdb', 'boltdb', and 'badgerdb'. | ||
| `, | ||
| Example: `prune --home './' --app-db-backend 'goleveldb' --pruning 'custom' --pruning-keep-recent 100 -- | ||
| pruning-keep-every 10, --pruning-interval 10`, | ||
| RunE: func(cmd *cobra.Command, _ []string) error { | ||
| vp := viper.New() | ||
|
|
||
| // Bind flags to the Context's Viper so we can get pruning options. | ||
| if err := vp.BindPFlags(cmd.Flags()); err != nil { | ||
| return err | ||
| } | ||
| if err := vp.BindPFlags(cmd.PersistentFlags()); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // use the first argument if present to set the pruning method | ||
| if len(args) > 0 { | ||
| vp.Set(server.FlagPruning, args[0]) | ||
| } else { | ||
| vp.Set(server.FlagPruning, pruningtypes.PruningOptionDefault) | ||
| } | ||
| pruningOptions, err := server.GetPruningOptionsFromFlags(vp) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| cmd.Printf("get pruning options from command flags, strategy: %v, keep-recent: %v\n", | ||
| pruningOptions.Strategy, | ||
| fmt.Printf("get pruning options from command flags, keep-recent: %v\n", | ||
| pruningOptions.KeepRecent, | ||
| ) | ||
|
|
||
| home := vp.GetString(flags.FlagHome) | ||
| db, err := openDB(home, server.GetAppDBBackend(vp)) | ||
| db, err := openDB(home) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| logger := log.NewLogger(cmd.OutOrStdout()) | ||
| logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout)) | ||
| app := appCreator(logger, db, nil, vp) | ||
| cms := app.CommitMultiStore() | ||
|
|
||
| rootMultiStore, ok := cms.(*rootmulti.Store) | ||
| if !ok { | ||
| return errors.New("currently only support the pruning of rootmulti.Store type") | ||
| return fmt.Errorf("currently only support the pruning of rootmulti.Store type") | ||
| } | ||
| latestHeight := rootmulti.GetLatestVersion(db) | ||
| // valid heights should be greater than 0. | ||
| if latestHeight <= 0 { | ||
| return fmt.Errorf("the database has no valid heights to prune, the latest height: %v", latestHeight) | ||
| } | ||
|
|
||
| pruningHeight := latestHeight - int64(pruningOptions.KeepRecent) | ||
| cmd.Printf("pruning heights up to %v\n", pruningHeight) | ||
| var pruningHeights []int64 | ||
| for height := int64(1); height < latestHeight; height++ { | ||
| if height < latestHeight-int64(pruningOptions.KeepRecent) { | ||
| pruningHeights = append(pruningHeights, height) | ||
| } | ||
| } | ||
| if len(pruningHeights) == 0 { | ||
| fmt.Printf("no heights to prune\n") | ||
| return nil | ||
| } | ||
| fmt.Printf( | ||
| "pruning heights start from %v, end at %v\n", | ||
| pruningHeights[0], | ||
| pruningHeights[len(pruningHeights)-1], | ||
| ) | ||
|
|
||
| err = rootMultiStore.PruneStores(pruningHeight) | ||
| rootMultiStore.PruneStores(false, pruningHeights) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| cmd.Println("successfully pruned the application root multi stores") | ||
| fmt.Printf("successfully pruned the application root multi stores\n") | ||
| return nil | ||
| }, | ||
| } | ||
|
|
||
| cmd.Flags().String(flags.FlagHome, "", "The database home directory") | ||
| cmd.Flags().String(FlagAppDBBackend, "", "The type of database for application and snapshots databases") | ||
| cmd.Flags().String(server.FlagPruning, storetypes.PruningOptionDefault, "Pruning strategy (default|nothing|everything|custom)") | ||
| cmd.Flags().Uint64(server.FlagPruningKeepRecent, 0, "Number of recent heights to keep on disk (ignored if pruning is not 'custom')") | ||
| cmd.Flags().Uint64(server.FlagPruningKeepEvery, 0, | ||
| `Offset heights to keep on disk after 'keep-every' (ignored if pruning is not 'custom'), | ||
| this is not used by this command but kept for compatibility with the complete pruning options`) | ||
| cmd.Flags().Uint64(server.FlagPruningInterval, 10, | ||
| `Height interval at which pruned heights are removed from disk (ignored if pruning is not 'custom'), | ||
| this is not used by this command but kept for compatibility with the complete pruning options`) | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func openDB(rootDir string, backendType dbm.BackendType) (corestore.KVStoreWithBatch, error) { | ||
| func openDB(rootDir string) (dbm.DB, error) { | ||
| dataDir := filepath.Join(rootDir, "data") | ||
| return dbm.NewDB("application", backendType, dataDir) | ||
| return sdk.NewLevelDB("application", dataDir) | ||
| } |
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
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
Oops, something went wrong.