-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
server,storage: capture filesystem properties in store descriptors
We have found numerous times during troubleshooting that it is useful to inspect the filesystem type and mount options and, when hosted without containers, the block device used to support the filesystem. This patch achieves this by retrieving the filesystem details and attaching them to store descriptors. Release note: None
- Loading branch information
Showing
9 changed files
with
883 additions
and
109 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
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
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 |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| // Copyright 2021 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package storage | ||
|
|
||
| import ( | ||
| "context" | ||
| "path/filepath" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/roachpb" | ||
| "github.com/cockroachdb/cockroach/pkg/util/log" | ||
| "github.com/elastic/gosigar" | ||
| ) | ||
|
|
||
| func computeStoreProperties( | ||
| ctx context.Context, dir string, readonly bool, encryptionEnabled bool, | ||
| ) roachpb.StoreProperties { | ||
| props := roachpb.StoreProperties{ | ||
| ReadOnly: readonly, | ||
| Encrypted: encryptionEnabled, | ||
| } | ||
|
|
||
| // In-memory store? | ||
| if dir == "" { | ||
| return props | ||
| } | ||
|
|
||
| fsprops := getFileSystemProperties(ctx, dir) | ||
| props.FileStoreProperties = &fsprops | ||
| return props | ||
| } | ||
|
|
||
| func getFileSystemProperties(ctx context.Context, dir string) roachpb.FileStoreProperties { | ||
| fsprops := roachpb.FileStoreProperties{ | ||
| Path: dir, | ||
| } | ||
|
|
||
| // Find which filesystem supports the store. | ||
|
|
||
| absPath, err := filepath.Abs(dir) | ||
| if err != nil { | ||
| log.Warningf(ctx, "cannot compute absolute file path for %q: %v", dir, err) | ||
| return fsprops | ||
| } | ||
|
|
||
| // Alas, only BSD reliably populates "fs" in os.StatFs(), | ||
| // so we must find the filesystem manually. | ||
| // | ||
| // Note that scanning the list of mounts is also | ||
| // what linux' df(1) command does. | ||
| // | ||
| var fslist gosigar.FileSystemList | ||
| if err := fslist.Get(); err != nil { | ||
| log.Warningf(ctx, "cannot retrieve filesystem list: %v", err) | ||
| return fsprops | ||
| } | ||
|
|
||
| var fsInfo *gosigar.FileSystem | ||
| // We're reading the list of mounts in reverse order: we're assuming | ||
| // that mounts are LIFO and can only be stacked, so the best match | ||
| // will necessarily be the first filesystem that's a prefix of the | ||
| // target directory, when looking from the end of the file. | ||
| // | ||
| // TODO(ssd): Steven points out that gosigar reads from /etc/mtab on | ||
| // linux, which is sometimes managed by the user command 'mount' and | ||
| // can sometimes miss entries when `mount -n` is used. It might be | ||
| // better to change gosigar to use /proc/mounts instead. | ||
| // | ||
| // FWIW, we are OK with this for now, since the systems where crdb | ||
| // is typically being deployed are well-behaved in that regard: | ||
| // Kubernetes mirrors /proc/mount in /etc/mtab. | ||
| for i := len(fslist.List) - 1; i >= 0; i-- { | ||
| // filepath.Rel can reliably tell us if a path is relative to | ||
| // another: if it is not, an error is returned. | ||
| _, err := filepath.Rel(fslist.List[i].DirName, absPath) | ||
| if err == nil { | ||
| fsInfo = &fslist.List[i] | ||
| break | ||
| } | ||
| } | ||
| if fsInfo == nil { | ||
| // This is surprising!? We're expecting at least a match on the | ||
| // root filesystem. Oh well. | ||
| return fsprops | ||
| } | ||
|
|
||
| fsprops.FsType = fsInfo.SysTypeName | ||
| fsprops.BlockDevice = fsInfo.DevName | ||
| fsprops.MountPoint = fsInfo.DirName | ||
| fsprops.MountOptions = fsInfo.Options | ||
| return fsprops | ||
| } |