diff options
author | Zuul <zuul@review.opendev.org> | 2021-04-02 00:27:31 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2021-04-02 00:27:31 +0000 |
commit | b79ca57fa98323b17f896af86c617d465066d544 (patch) | |
tree | 2eacefe70b91e8951927d7ec219a300226dc6acc /doc | |
parent | 7594d97f38826d1dfddfb7e6084aa16cfd388386 (diff) | |
parent | 46a6a09d5b15dbcd7ce7244a6c18a8edbb96013e (diff) | |
download | swift-b79ca57fa98323b17f896af86c617d465066d544.tar.gz |
Merge "Create a separate doc for audit watcher"
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/audit_watchers.rst | 12 | ||||
-rw-r--r-- | doc/source/development_watchers.rst | 26 | ||||
-rw-r--r-- | doc/source/index.rst | 1 |
3 files changed, 19 insertions, 20 deletions
diff --git a/doc/source/audit_watchers.rst b/doc/source/audit_watchers.rst new file mode 100644 index 000000000..51ca39537 --- /dev/null +++ b/doc/source/audit_watchers.rst @@ -0,0 +1,12 @@ +.. _common_audit_watchers: + +********************* +Object Audit Watchers +********************* + +.. _dark_data: + +Dark Data +========= + +.. automodule:: swift.obj.watchers.dark_data diff --git a/doc/source/development_watchers.rst b/doc/source/development_watchers.rst index 48e9310b1..6aee25439 100644 --- a/doc/source/development_watchers.rst +++ b/doc/source/development_watchers.rst @@ -104,23 +104,9 @@ Dark Data Watcher The watcher API is assumed to be under development. Operators who need extensions are welcome to report any needs for more arguments -to see_object(). For now, start by copying the provided template watcher -swift/obj/watchers/dark_data.py and see if it is sufficient. - -The name of "Dark Data" refers to the scientific hypothesis of Dark Matter, -which supposes that the universe contains a lot of matter than we cannot -observe. The Dark Data in Swift is the name of objects that are not -accounted in the containers. - -The experience of running large scale clusters suggests that Swift does -not have any particular bugs that trigger creation of dark data. So, -this is an excercise in writing watchers, with a plausible function. - -When enabled, Dark Data watcher definitely drags down the cluster's overall -performance, as mentioned above. Of course, the load increase can be -mitigated as usual, but at the expense of the total time taken by -the pass of auditor. - -Finally, keep in mind that Dark Data watcher needs the container -ring to operate, but runs on an object node. This can come up if -cluster has nodes separated by function. +to see_object(). + +The :ref:`dark_data` watcher has been provided as an example. If an +operator wants to create their own watcher, start by copying +the provided example template ``swift/obj/watchers/dark_data.py`` and see +if it is sufficient. diff --git a/doc/source/index.rst b/doc/source/index.rst index f9f23e464..f1b6bee6f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -166,6 +166,7 @@ Source Documentation object misc middleware + audit_watchers Indices and tables |