[#5873] feat(gvfs-fuse): add debug log for FuseApiHandle #5905
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
unknowntpo
force-pushed
the
feat-fuse-debug-log
branch
2 times, most recently
from
9ae9ea0 to
3574bce
Compare
diqiu50
reviewed
Dec 20, 2024
| } | ||
|
|
||
| impl<T: RawFileSystem> Filesystem for FuseApiHandleDebug<T> { | ||
| async fn init(&self, req: Request) -> fuse3::Result<ReplyInit> { |
There was a problem hiding this comment.
We need to implement all interfaces of the Filesystem. If they are not implemented yet, an error log should be recorded.
There was a problem hiding this comment.
Do you implement all the Filesystem interfaces?
diqiu50
reviewed
Dec 20, 2024
|
Please refer to other PRs for the format of PR titles and descriptions. |
unknowntpo
changed the title
unknowntpo
force-pushed
the
feat-fuse-debug-log
branch
from
d1bfdba to
425c490
Compare
|
close and reopen to run workflow |
|
@diqiu50 Please help review this PR, Thanks. |
diqiu50
reviewed
Dec 30, 2024
| "readdir [id={}]: req: {:?}, parent: {:?}, fh: {:?}, offset: {:?}", | ||
| req.unique, req, parent, fh, offset | ||
| ); | ||
| let result = self.inner.readdir(req, parent, fh, offset).await; |
diqiu50
reviewed
Dec 30, 2024
diqiu50
reviewed
Dec 30, 2024
diqiu50
reviewed
Dec 30, 2024
diqiu50
reviewed
Dec 30, 2024
| req.unique, | ||
| FileAttrDebug { | ||
| file_attr: &reply.attr | ||
| } |
There was a problem hiding this comment.
Constructing an object is not as clear as using a function like to_desc_string()
There was a problem hiding this comment.
I implemented some methods like reply_attr_to_desc_str, reply_entry_to_desc_str to manually control the format.
diqiu50
reviewed
Dec 30, 2024
diqiu50
reviewed
Dec 30, 2024
unknowntpo
force-pushed
the
feat-fuse-debug-log
branch
from
1d9ff8a to
d619db0
Compare
|
@unknowntpo All the code are merged to the main brach. you need to merge the pr to main |
|
@diqiu50 Okay, (I'm still working this PR) |
unknowntpo
force-pushed
the
feat-fuse-debug-log
branch
2 times, most recently
from
d4627de to
ec48523
Compare
unknowntpo
force-pushed
the
feat-fuse-debug-log
branch
2 times, most recently
from
479e7be to
87e01ff
Compare
|
Note that I use e.g. |
|
@diqiu50 Done, please take a look. |
… by fuse_debug option
… by fuse_debug option
unknowntpo
force-pushed
the
feat-fuse-debug-log
branch
from
0444a02 to
2ee68cf
Compare
diqiu50
reviewed
Jan 16, 2025
| @@ -46,6 +47,7 @@ opendal = { version = "0.46.0", features = ["services-s3"] } | |||
| reqwest = { version = "0.12.9", features = ["json"] } | |||
| serde = { version = "1.0.216", features = ["derive"] } | |||
| tokio = { version = "1.38.0", features = ["full"] } | |||
| tracing = "0.1.41" | |||
There was a problem hiding this comment.
If you want to use tracing instead of log, please remove log.
| @@ -20,6 +20,7 @@ | |||
| file_mask = 0o600 | |||
| dir_mask = 0o700 | |||
| fs_type = "memory" | |||
| fuse_debug=true | |||
|
|
|||
| @@ -265,6 +265,8 @@ pub struct FuseConfig { | |||
| #[serde(default)] | |||
| pub fs_type: String, | |||
| #[serde(default)] | |||
| pub fuse_debug: bool, | |||
| #[serde(default)] | |||
There was a problem hiding this comment.
Need to handle default value like other configurations.
| @@ -53,7 +53,7 @@ impl<T: RawFileSystem> FuseApiHandle<T> { | |||
| } | |||
| } | |||
|
|
|||
| async fn get_modified_file_stat( | |||
| pub async fn get_modified_file_stat( | |||
| &self, | |||
There was a problem hiding this comment.
Don't use this function to retrieve the file name. use the RawFileSystem::get_file_path
|
|
||
| /// Convert `ReplyAttr` to descriptive string. | ||
| /// | ||
| /// Example: `ttl: 1s, FileAttr: { ino: 10000, size: 0, blocks: 0, atime: "2025-01-16 02:42:52.600436", mtime: "2025-01-16 02:42:52.600436", ctime: "2025-01-16 02:42:52.600436", crtime: "2025-01-16 02:42:52.600436", kind: RegularFile, perm: 600, nlink: 1, uid: 501, gid: 20, rdev: 0, flags: 0, blksize: 8192 }` |
There was a problem hiding this comment.
This line is too long , you can format it like this.
/// Example: `ttl: 1s, FileAttr: { ino: 10000, size: 0, blocks: 0, atime: "2025-01-16 02:42:52.600436",
/// mtime: "2025-01-16 02:42:52.600436", ctime: "2025-01-16 02:42:52.600436", crtime: "2025-01-16
/// 02:42:52.600436", kind: RegularFile, perm: 600, nlink: 1, uid: 501, gid: 20, rdev: 0, flags: 0, blksize: 8192 }`
|
|
||
| /// Convert `ReplyAttr` to descriptive string. | ||
| /// | ||
| /// Example: `ttl: 1s, FileAttr: { ino: 10000, size: 0, blocks: 0, atime: "2025-01-16 02:42:52.600436", mtime: "2025-01-16 02:42:52.600436", ctime: "2025-01-16 02:42:52.600436", crtime: "2025-01-16 02:42:52.600436", kind: RegularFile, perm: 600, nlink: 1, uid: 501, gid: 20, rdev: 0, flags: 0, blksize: 8192 }` |
There was a problem hiding this comment.
This line is too long , you can format it like this.
/// Example: `ttl: 1s, FileAttr: { ino: 10000, size: 0, blocks: 0, atime: "2025-01-16 02:42:52.600436",
/// mtime: "2025-01-16 02:42:52.600436", ctime: "2025-01-16 02:42:52.600436", crtime: "2025-01-16
/// 02:42:52.600436", kind: RegularFile, perm: 600, nlink: 1, uid: 501, gid: 20, rdev: 0, flags: 0, blksize: 8192 }`
| file_attr_to_desc_str(&reply_attr.attr) | ||
| ) | ||
| .unwrap(); | ||
|
|
There was a problem hiding this comment.
Is better like this:
write!(output, "ttl: {:?}, FileAttr: {}, generation: {}",
reply_entry.ttl,
file_attr_to_desc_str(&reply_entry.attr),
reply_entry.generation).unwrap();
| .inner | ||
| .get_modified_file_stat(parent, Option::None, Option::None, Option::None) | ||
| .await?; | ||
| debug!( |
There was a problem hiding this comment.
Please make the debug code readable.
like :
debug!("format string", x1, x2, x3)
| self.inner.readdirplus(req, parent, fh, offset, lock_owner), | ||
| "readdirplus", | ||
| req | ||
| ) |
There was a problem hiding this comment.
Do you print the child DirectoryEntry in the log?
I've checked your run logs, and they look pretty good. However, please pay attention to the following points:
|
|
This is the new format I came up with:
|
|
We need to print the directory list on a single line; otherwise, it’s hard to tell which request the result belongs to. |
|
Ok, I can put them in the same line like this |
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.
What changes were proposed in this pull request?
Implement
FuseApiHandleDebugso we can log all input arguments and return values ofFuseApiHandle.I use
tracing::debug,tracing::errorwith structure logging to format the message in key value pair format, so we don't need to control format manually.e.g.
And user can set
fuse_debug = truein[fuse] sectionat config file likegvfs_fuse_memory.tomlto decide whether they need fuse debug logging or not.Fix: #5873
Does this PR introduce any user-facing change?
No.
How was this patch tested?
tested with
fuse_test.rs, along withMemoryFileSystem.Now,
FuseApiHandleDebugwill wrapFuseApiHandleand log all input arguments and returned values, if return value isResult, we usematchto extract and log the status of result, note that error will be logged if occured.To test this PR, set
fuse_debug = trueingvfs_fuse_memory.tomland run:Here's some example logging generated by
test_fuse_system_with_autoinfuse_test.rs: