cephfs: Log clone progress during a clone operation #4918

Nikhil-Ladha · 2024-10-28T06:14:51Z

Describe what this PR does

Add clone progress report in the clone status operation and report the same in the logs for user's reference.

Checklist:

Commit Message Formatting: Commit titles and messages follow
guidelines in the developer
guide.
Reviewed the developer guide on Submitting a Pull
Request
Pending release
notes
updated with breaking and/or notable changes for the next major release.
Documentation has been updated, if necessary.
Unit tests have been added, if necessary.
Integration tests have been added, if necessary.

Show available bot commands

These commands are normally not required, but in case of issues, leave any of
the following bot commands in an otherwise empty comment in this PR:

/retest ci/centos/<job-name>: retest the <job-name> after unrelated
failure (please report the failure too!)

Nikhil-Ladha · 2024-10-28T06:18:14Z

cc @Madhu-1 @nixpanic

Madhu-1

what happens if we are using older version of the ceph that doesn't support the new fields? i assume it will be empty just want to confirm on it.

internal/cephfs/store/fsjournal.go

internal/cephfs/core/clone.go

Nikhil-Ladha · 2024-10-28T06:42:28Z

what happens if we are using older version of the ceph that doesn't support the new fields? i assume it will be empty just want to confirm on it.

Yes, it will be empty.

internal/cephfs/store/fsjournal.go

Madhu-1

can you please test it out and paste the PVC describe output, just to make sure we are surfacing it to user, feel free to add E2E if you think it can be done as well

Madhu-1

LGTM, Lets get the testing results

Nikhil-Ladha · 2024-10-28T09:42:35Z

Testing results:

PVC Events:

Events:
  Type     Reason                 Age                From                                                                                                             Message
  ----     ------                 ----               ----                                                                                                             -------
  Normal   ExternalProvisioning   68s (x2 over 68s)  persistentvolume-controller                                                                                      Waiting for a volume to be created either by the external provisioner 'rook-ceph.cephfs.csi.ceph.com' or manually by the system administrator. If volume creation is delayed, please verify that the provisioner is running and correctly registered.
  Warning  ProvisioningFailed     68s                rook-ceph.cephfs.csi.ceph.com_csi-cephfsplugin-provisioner-f5df68b95-9stgl_d702fa82-d9f0-4f54-a5b9-3bd7b2cdd7d5  failed to provision volume with StorageClass "rook-cephfs": rpc error: code = Aborted desc = clone from snapshot is pending
  Warning  ProvisioningFailed     67s                rook-ceph.cephfs.csi.ceph.com_csi-cephfsplugin-provisioner-f5df68b95-9stgl_d702fa82-d9f0-4f54-a5b9-3bd7b2cdd7d5  failed to provision volume with StorageClass "rook-cephfs": rpc error: code = Aborted desc = clone from snapshot is already in progress. progress report: percentage cloned=0%, amount cloned=306/0, files cloned=3/1
  Normal   Provisioning           66s (x3 over 68s)  rook-ceph.cephfs.csi.ceph.com_csi-cephfsplugin-provisioner-f5df68b95-9stgl_d702fa82-d9f0-4f54-a5b9-3bd7b2cdd7d5  External provisioner is provisioning volume for claim "default/cephfs-pvc-clone"
  Normal   ProvisioningSucceeded  58s                rook-ceph.cephfs.csi.ceph.com_csi-cephfsplugin-provisioner-f5df68b95-9stgl_d702fa82-d9f0-4f54-a5b9-3bd7b2cdd7d5  Successfully provisioned volume pvc-70f1e45e-7d31-4e52-babe-8ff083860505

CSI Logs:

I1028 09:34:09.854647       1 fsjournal.go:137] ID: 38 Req-ID: pvc-70f1e45e-7d31-4e52-babe-8ff083860505 clone from snapshot is already in progress. progress report: percentage cloned=0%!,(MISSING) amount cloned=306/0, files cloned=3/1
E1028 09:34:09.854817       1 utils.go:271] ID: 38 Req-ID: pvc-70f1e45e-7d31-4e52-babe-8ff083860505 GRPC error: rpc error: code = Aborted desc = clone from snapshot is already in progress. progress report: percentage cloned=0%, amount cloned=306/0, files cloned=3/1

I am unable to understand what does this "MISSING" indicates in the log, can someone please help?

iPraveenParihar · 2024-10-28T11:02:20Z

I am unable to understand what does this "MISSING" indicates in the log, can someone please help?

MISSING in log messages is occurred when there is mismatch between format specifiers and the arguments provided.
something, like fmt.Printf("key1: %s, key2: %s", "value1") should log MISSING.

In your PR, I don't see that to be the case 🤔. You could verify that once with you latest PR changes?

Nikhil-Ladha · 2024-10-28T11:10:45Z

I am unable to understand what does this "MISSING" indicates in the log, can someone please help?

MISSING in log messages is occurred when there is mismatch between format specifiers and the arguments provided. something, like fmt.Printf("key1: %s, key2: %s", "value1") should log MISSING.

In your PR, I don't see that to be the case 🤔. You could verify that once with you latest PR changes?

The above output is using the latest changes only.

Madhu-1 · 2024-10-28T12:04:13Z

/test ci/centos/mini-e2e-helm/k8s-1.31

internal/cephfs/store/fsjournal.go

Pull request has been modified.

internal/cephfs/store/fsjournal.go

mergify · 2024-11-06T09:49:54Z

This pull request now has conflicts with the target branch. Could you please resolve conflicts and force push the corrected changes? 🙏

Rakshith-R

just few small nits.
rest looks good to me.

internal/cephfs/core/clone.go

Rakshith-R

🤦 Sorry,
didn't click add review on this requested change.

Please take a look, small nit.

Nikhil-Ladha · 2024-11-11T10:07:21Z

🤦 Sorry, didn't click add review on this requested change.

Please take a look, small nit.

I don't see the code for which you are suggesting the change, can you please re-highlight?

internal/cephfs/store/fsjournal.go

Pull request has been modified.

iPraveenParihar

LGTM
Thanks!

Rakshith-R · 2024-11-14T06:54:43Z

internal/cephfs/store/fsjournal.go

+				log.UsefulLog(ctx, err.Error())
+
+				return nil, err
+			}


Suggested change

log.UsefulLog(ctx, err.Error())

return nil, err

}

}

log.ErrorLog(ctx, err.Error())

return nil, err

It would be logically incorrect to term it as error here.
Since, there is no error as such with the clone, rather it is just in progress and should get complete in sometime. So, I don't think we should log it as an error log.

It is returned as a error. I would be fine with using debuglog, we don't use useful log anywhere else.
And your recent change no longer returns err if progress is missing. This needs to be changed as well. Observe the change in curly bracket

Ah, right.
Updated the code now, please take a look.

Pull request has been modified.

iPraveenParihar · 2024-11-22T05:54:54Z

@Mergifyio rebase

log cephfs clone progress report during cephfs clone operation Signed-off-by: Nikhil-Ladha <[email protected]>

mergify · 2024-11-22T05:55:15Z

rebase

✅ Branch has been successfully rebased

iPraveenParihar · 2024-11-22T06:00:13Z

@Mergifyio queue

mergify · 2024-11-22T06:00:19Z

queue

✅ The pull request has been merged automatically

The pull request has been merged automatically at 98cf078

ceph-csi-bot · 2024-11-22T06:00:33Z

/test ci/centos/k8s-e2e-external-storage/1.30

ceph-csi-bot · 2024-11-22T06:00:34Z

/test ci/centos/k8s-e2e-external-storage/1.29

ceph-csi-bot · 2024-11-22T06:00:34Z

/test ci/centos/mini-e2e-helm/k8s-1.30

ceph-csi-bot · 2024-11-22T06:00:34Z

/test ci/centos/mini-e2e-helm/k8s-1.29

ceph-csi-bot · 2024-11-22T06:00:34Z

/test ci/centos/mini-e2e/k8s-1.30

ceph-csi-bot · 2024-11-22T06:00:35Z

/test ci/centos/mini-e2e/k8s-1.29

ceph-csi-bot · 2024-11-22T06:00:35Z

/test ci/centos/k8s-e2e-external-storage/1.31

ceph-csi-bot · 2024-11-22T06:00:35Z

/test ci/centos/upgrade-tests-cephfs

ceph-csi-bot · 2024-11-22T06:00:36Z

/test ci/centos/mini-e2e-helm/k8s-1.31

ceph-csi-bot · 2024-11-22T06:00:36Z

/test ci/centos/upgrade-tests-rbd

ceph-csi-bot · 2024-11-22T06:00:37Z

/test ci/centos/mini-e2e/k8s-1.31

mergify bot added the component/cephfs Issues related to CephFS label Oct 28, 2024

Nikhil-Ladha force-pushed the issue4813/log-clone-progress branch 2 times, most recently from f923e0a to 3f24712 Compare October 28, 2024 06:25

Madhu-1 reviewed Oct 28, 2024

View reviewed changes

internal/cephfs/store/fsjournal.go Show resolved Hide resolved

internal/cephfs/core/clone.go Show resolved Hide resolved

Nikhil-Ladha force-pushed the issue4813/log-clone-progress branch from 3f24712 to 992ff84 Compare October 28, 2024 07:03

Nikhil-Ladha requested a review from Madhu-1 October 28, 2024 07:06

Nikhil-Ladha force-pushed the issue4813/log-clone-progress branch from 992ff84 to 500fde7 Compare October 28, 2024 07:46

Madhu-1 reviewed Oct 28, 2024

View reviewed changes

internal/cephfs/store/fsjournal.go Outdated Show resolved Hide resolved

Madhu-1 reviewed Oct 28, 2024

View reviewed changes

Nikhil-Ladha force-pushed the issue4813/log-clone-progress branch from 500fde7 to 946609f Compare October 28, 2024 07:54

Madhu-1 previously approved these changes Oct 28, 2024

View reviewed changes

Madhu-1 requested a review from nixpanic October 28, 2024 07:59

Madhu-1 reviewed Oct 28, 2024

View reviewed changes

internal/cephfs/store/fsjournal.go Outdated Show resolved Hide resolved

Nikhil-Ladha force-pushed the issue4813/log-clone-progress branch from 946609f to f7ff8c3 Compare October 29, 2024 08:38

Madhu-1 reviewed Oct 30, 2024

View reviewed changes

internal/cephfs/store/fsjournal.go Outdated Show resolved Hide resolved

Nikhil-Ladha force-pushed the issue4813/log-clone-progress branch from f7ff8c3 to a91c8aa Compare November 7, 2024 14:36

Nikhil-Ladha requested a review from Madhu-1 November 11, 2024 05:24

Madhu-1 previously approved these changes Nov 11, 2024

View reviewed changes

Rakshith-R reviewed Nov 11, 2024

View reviewed changes

internal/cephfs/core/clone.go Show resolved Hide resolved

Rakshith-R reviewed Nov 11, 2024

View reviewed changes

internal/cephfs/store/fsjournal.go Outdated Show resolved Hide resolved

Madhu-1 previously approved these changes Nov 13, 2024

View reviewed changes

iPraveenParihar previously approved these changes Nov 14, 2024

View reviewed changes

Rakshith-R requested changes Nov 14, 2024

View reviewed changes

Nikhil-Ladha force-pushed the issue4813/log-clone-progress branch from b9023dc to c5da289 Compare November 21, 2024 13:39

Nikhil-Ladha requested a review from Rakshith-R November 21, 2024 13:39

Rakshith-R approved these changes Nov 21, 2024

View reviewed changes

iPraveenParihar approved these changes Nov 22, 2024

View reviewed changes

cephfs: log clone progress

68b4f9c

log cephfs clone progress report during cephfs clone operation Signed-off-by: Nikhil-Ladha <[email protected]>

iPraveenParihar force-pushed the issue4813/log-clone-progress branch from c5da289 to 68b4f9c Compare November 22, 2024 05:55

mergify bot added the ok-to-test Label to trigger E2E tests label Nov 22, 2024

ceph-csi-bot removed the ok-to-test Label to trigger E2E tests label Nov 22, 2024

mergify bot merged commit 98cf078 into ceph:devel Nov 22, 2024
38 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cephfs: Log clone progress during a clone operation #4918

cephfs: Log clone progress during a clone operation #4918

Nikhil-Ladha commented Oct 28, 2024

Nikhil-Ladha commented Oct 28, 2024

Madhu-1 left a comment

Nikhil-Ladha commented Oct 28, 2024 •

edited

Loading

Madhu-1 left a comment

Madhu-1 left a comment

Nikhil-Ladha commented Oct 28, 2024

iPraveenParihar commented Oct 28, 2024

Nikhil-Ladha commented Oct 28, 2024

Madhu-1 commented Oct 28, 2024

mergify bot commented Nov 6, 2024

Rakshith-R left a comment

Rakshith-R left a comment

Nikhil-Ladha commented Nov 11, 2024

iPraveenParihar left a comment

Rakshith-R Nov 14, 2024

Nikhil-Ladha Nov 15, 2024

Rakshith-R Nov 20, 2024 •

edited

Loading

Nikhil-Ladha Nov 21, 2024

iPraveenParihar commented Nov 22, 2024

mergify bot commented Nov 22, 2024

iPraveenParihar commented Nov 22, 2024

mergify bot commented Nov 22, 2024 •

edited

Loading

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

cephfs: Log clone progress during a clone operation #4918

cephfs: Log clone progress during a clone operation #4918

Conversation

Nikhil-Ladha commented Oct 28, 2024

Describe what this PR does

Nikhil-Ladha commented Oct 28, 2024

Madhu-1 left a comment

Choose a reason for hiding this comment

Nikhil-Ladha commented Oct 28, 2024 • edited Loading

Madhu-1 left a comment

Choose a reason for hiding this comment

Madhu-1 left a comment

Choose a reason for hiding this comment

Nikhil-Ladha commented Oct 28, 2024

iPraveenParihar commented Oct 28, 2024

Nikhil-Ladha commented Oct 28, 2024

Madhu-1 commented Oct 28, 2024

mergify bot commented Nov 6, 2024

Rakshith-R left a comment

Choose a reason for hiding this comment

Rakshith-R left a comment

Choose a reason for hiding this comment

Nikhil-Ladha commented Nov 11, 2024

iPraveenParihar left a comment

Choose a reason for hiding this comment

Rakshith-R Nov 14, 2024

Choose a reason for hiding this comment

Nikhil-Ladha Nov 15, 2024

Choose a reason for hiding this comment

Rakshith-R Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

Nikhil-Ladha Nov 21, 2024

Choose a reason for hiding this comment

iPraveenParihar commented Nov 22, 2024

mergify bot commented Nov 22, 2024

✅ Branch has been successfully rebased

iPraveenParihar commented Nov 22, 2024

mergify bot commented Nov 22, 2024 • edited Loading

✅ The pull request has been merged automatically

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

ceph-csi-bot commented Nov 22, 2024

Nikhil-Ladha commented Oct 28, 2024 •

edited

Loading

Rakshith-R Nov 20, 2024 •

edited

Loading

mergify bot commented Nov 22, 2024 •

edited

Loading