From: ShreeJejurikar <shreemj8@gmail.com>
Date: Wed, 28 Jan 2026 10:09:27 +0000 (+0530)
Subject: doc: Add bucket logging admin commands documentation
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F67103%2Fhead;p=ceph.git

doc: Add bucket logging admin commands documentation

Documents the flush and info subcommands for radosgw-admin bucket logging.

Fixes: https://tracker.ceph.com/issues/74447

Signed-off-by: Shree Jejurikar <shreemj8@gmail.com>
---

diff --git a/doc/man/8/radosgw-admin.rst b/doc/man/8/radosgw-admin.rst
index 3860f0208190..48367695f77e 100644
--- a/doc/man/8/radosgw-admin.rst
+++ b/doc/man/8/radosgw-admin.rst
@@ -124,6 +124,16 @@ as follows:
 :command:`bucket sync enable`
   Enable bucket sync.
 
+:command:`bucket logging list`
+  List pending log objects for a source bucket.
+
+:command:`bucket logging info`
+  Show logging configuration for a source bucket, or list source buckets
+  logging to a specific log bucket.
+
+:command:`bucket logging flush`
+  Flush pending log objects to the log bucket immediately.
+
 :command:`bi get`
   Retrieve bucket index object entries.
 
diff --git a/doc/radosgw/bucket_logging.rst b/doc/radosgw/bucket_logging.rst
index 3915ae59a71a..4d58d3284595 100644
--- a/doc/radosgw/bucket_logging.rst
+++ b/doc/radosgw/bucket_logging.rst
@@ -54,6 +54,13 @@ them, regardless if enough time passed or if no more records are written to the
 object. Flushing will happen automatically when logging is disabled on a
 bucket, or its logging configuration is changed, or the bucket is deleted.
 
+To manually flush pending log objects to the log bucket, execute the following
+command:
+
+.. prompt:: bash #
+
+   radosgw-admin bucket logging flush --bucket <source bucket>
+
 The process of adding a new log object to the log bucket is asynchronous when
 triggered by a log record being written. Consequently, the operation that
 generated the log is completed immediately and does not wait for the log object
@@ -69,6 +76,17 @@ the log bucket, execute the following command:
 
    radosgw-admin bucket logging list --bucket <source bucket>
 
+To view the logging configuration of a source bucket, or to see which source
+buckets are logging to a specific log bucket, execute the following command:
+
+.. prompt:: bash #
+
+   radosgw-admin bucket logging info --bucket <bucket>
+
+When run on a source bucket, this displays the logging configuration (target
+bucket, prefix, etc.). When run on a log bucket, this displays which source
+buckets are sending logs to it.
+
 
 Standard
 ````````