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

fs-repo-11-to-12: add env vars for configuring the number of workers and the sync size #149

Merged
merged 4 commits into from
Feb 15, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions fs-repo-11-to-12/migration/swapper.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ package mg11

import (
"errors"
"os"
"strconv"
"sync"
"sync/atomic"

Expand All @@ -19,6 +21,32 @@ var SyncSize uint64 = 20 * 1024 * 1024 // 20MiB
// migration.
var NWorkers int = 4

func init() {
workerEnvVar := "IPFS_FS_MIGRATION_11_TO_12_NWORKERS"
syncSizeEnvVar := "IPFS_FS_MIGRATION_11_TO_12_SYNC_SIZE"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Figured long names would prevent conflict and almost nobody should need to set these, but if you have other names in mind that's fine by me.

if nworkersStr, nworkerInEnv := os.LookupEnv(workerEnvVar); nworkerInEnv {
nworkers, err := strconv.Atoi(nworkersStr)
if err != nil {
panic(err)
}
if nworkers < 1 {
panic("number of workers must be at least 1")
}
Comment on lines +29 to +34
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could log an error and fallback to the defaults instead of panicking here, but this seems reasonable to let the user know they did something wrong.

NWorkers = nworkers
}

if syncSizeStr, syncSizeInEnv := os.LookupEnv(syncSizeEnvVar); syncSizeInEnv {
syncSize, err := strconv.ParseUint(syncSizeStr, 10, 64)
if err != nil {
panic(err)
}
if syncSize < 1 {
panic("sync size bytes must be at least 1")
}
Comment on lines +43 to +45
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we set this higher (e.g. 1MB minimum) just so people don't accidentally think 1 == 1MB or something?

Similarly is there any use for setting 0 to mean only syncing at the end of the migration?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's rename the env var to sync_size_bytes?

SyncSize = syncSize
}
}

// Swap holds the datastore keys for the original CID and for the
// destination Multihash.
type Swap struct {
Expand Down