From 1f298714aff931b8041bbfeb2d87e9547dcaefee Mon Sep 17 00:00:00 2001 From: Tim Burke Date: Thu, 25 May 2023 13:59:08 -0700 Subject: [PATCH] docs: Format metrics in fixed-width font, not italics Change-Id: I6fc9eaf0903bdbe4ccb82c4e7647478a1eef9785 --- doc/source/metrics/account_auditor.rst | 18 +-- doc/source/metrics/account_reaper.rst | 44 ++++---- doc/source/metrics/account_replicator.rst | 56 +++++----- doc/source/metrics/account_server.rst | 62 +++++----- doc/source/metrics/container_auditor.rst | 18 +-- doc/source/metrics/container_replicator.rst | 56 +++++----- doc/source/metrics/container_server.rst | 58 +++++----- doc/source/metrics/container_sync.rst | 30 ++--- doc/source/metrics/container_updater.rst | 28 ++--- doc/source/metrics/object_auditor.rst | 20 ++-- doc/source/metrics/object_expirer.rst | 18 +-- doc/source/metrics/object_reconstructor.rst | 44 ++++---- doc/source/metrics/object_replicator.rst | 44 ++++---- doc/source/metrics/object_server.rst | 92 +++++++-------- doc/source/metrics/object_updater.rst | 38 +++---- doc/source/metrics/proxy_server.rst | 118 ++++++++++---------- 16 files changed, 372 insertions(+), 372 deletions(-) diff --git a/doc/source/metrics/account_auditor.rst b/doc/source/metrics/account_auditor.rst index 896908a517..83fbd74408 100644 --- a/doc/source/metrics/account_auditor.rst +++ b/doc/source/metrics/account_auditor.rst @@ -1,12 +1,12 @@ ``account-auditor`` Metrics =========================== -========================== ========================================================= -Metric Name Description --------------------------- --------------------------------------------------------- -`account-auditor.errors` Count of audit runs (across all account databases) which - caught an Exception. -`account-auditor.passes` Count of individual account databases which passed audit. -`account-auditor.failures` Count of individual account databases which failed audit. -`account-auditor.timing` Timing data for individual account database audits. -========================== ========================================================= +============================ ========================================================= +Metric Name Description +---------------------------- --------------------------------------------------------- +``account-auditor.errors`` Count of audit runs (across all account databases) which + caught an Exception. +``account-auditor.passes`` Count of individual account databases which passed audit. +``account-auditor.failures`` Count of individual account databases which failed audit. +``account-auditor.timing`` Timing data for individual account database audits. +============================ ========================================================= diff --git a/doc/source/metrics/account_reaper.rst b/doc/source/metrics/account_reaper.rst index f73b0db218..a95f8b2c12 100644 --- a/doc/source/metrics/account_reaper.rst +++ b/doc/source/metrics/account_reaper.rst @@ -1,25 +1,25 @@ ``account-reaper`` Metrics ========================== -============================================== ==================================================== -Metric Name Description ----------------------------------------------- ---------------------------------------------------- -`account-reaper.errors` Count of devices failing the mount check. -`account-reaper.timing` Timing data for each reap_account() call. -`account-reaper.return_codes.X` Count of HTTP return codes from various operations - (e.g. object listing, container deletion, etc.). The - value for X is the first digit of the return code - (2 for 201, 4 for 404, etc.). -`account-reaper.containers_failures` Count of failures to delete a container. -`account-reaper.containers_deleted` Count of containers successfully deleted. -`account-reaper.containers_remaining` Count of containers which failed to delete with - zero successes. -`account-reaper.containers_possibly_remaining` Count of containers which failed to delete with - at least one success. -`account-reaper.objects_failures` Count of failures to delete an object. -`account-reaper.objects_deleted` Count of objects successfully deleted. -`account-reaper.objects_remaining` Count of objects which failed to delete with zero - successes. -`account-reaper.objects_possibly_remaining` Count of objects which failed to delete with at - least one success. -============================================== ==================================================== +================================================ ==================================================== +Metric Name Description +------------------------------------------------ ---------------------------------------------------- +``account-reaper.errors`` Count of devices failing the mount check. +``account-reaper.timing`` Timing data for each reap_account() call. +``account-reaper.return_codes.X`` Count of HTTP return codes from various operations + (e.g. object listing, container deletion, etc.). The + value for X is the first digit of the return code + (2 for 201, 4 for 404, etc.). +``account-reaper.containers_failures`` Count of failures to delete a container. +``account-reaper.containers_deleted`` Count of containers successfully deleted. +``account-reaper.containers_remaining`` Count of containers which failed to delete with + zero successes. +``account-reaper.containers_possibly_remaining`` Count of containers which failed to delete with + at least one success. +``account-reaper.objects_failures`` Count of failures to delete an object. +``account-reaper.objects_deleted`` Count of objects successfully deleted. +``account-reaper.objects_remaining`` Count of objects which failed to delete with zero + successes. +``account-reaper.objects_possibly_remaining`` Count of objects which failed to delete with at + least one success. +================================================ ==================================================== diff --git a/doc/source/metrics/account_replicator.rst b/doc/source/metrics/account_replicator.rst index dd1204caf7..19127953b0 100644 --- a/doc/source/metrics/account_replicator.rst +++ b/doc/source/metrics/account_replicator.rst @@ -1,31 +1,31 @@ ``account-replicator`` Metrics ============================== -===================================== ==================================================== -Metric Name Description -------------------------------------- ---------------------------------------------------- -`account-replicator.diffs` Count of syncs handled by sending differing rows. -`account-replicator.diff_caps` Count of "diffs" operations which failed because - "max_diffs" was hit. -`account-replicator.no_changes` Count of accounts found to be in sync. -`account-replicator.hashmatches` Count of accounts found to be in sync via hash - comparison (`broker.merge_syncs` was called). -`account-replicator.rsyncs` Count of completely missing accounts which were sent - via rsync. -`account-replicator.remote_merges` Count of syncs handled by sending entire database - via rsync. -`account-replicator.attempts` Count of database replication attempts. -`account-replicator.failures` Count of database replication attempts which failed - due to corruption (quarantined) or inability to read - as well as attempts to individual nodes which - failed. -`account-replicator.removes.` Count of databases on deleted because the - delete_timestamp was greater than the put_timestamp - and the database had no rows or because it was - successfully sync'ed to other locations and doesn't - belong here anymore. -`account-replicator.successes` Count of replication attempts to an individual node - which were successful. -`account-replicator.timing` Timing data for each database replication attempt - not resulting in a failure. -===================================== ==================================================== +======================================= ==================================================== +Metric Name Description +--------------------------------------- ---------------------------------------------------- +``account-replicator.diffs`` Count of syncs handled by sending differing rows. +``account-replicator.diff_caps`` Count of "diffs" operations which failed because + "max_diffs" was hit. +``account-replicator.no_changes`` Count of accounts found to be in sync. +``account-replicator.hashmatches`` Count of accounts found to be in sync via hash + comparison (``broker.merge_syncs`` was called). +``account-replicator.rsyncs`` Count of completely missing accounts which were sent + via rsync. +``account-replicator.remote_merges`` Count of syncs handled by sending entire database + via rsync. +``account-replicator.attempts`` Count of database replication attempts. +``account-replicator.failures`` Count of database replication attempts which failed + due to corruption (quarantined) or inability to read + as well as attempts to individual nodes which + failed. +``account-replicator.removes.`` Count of databases on deleted because the + delete_timestamp was greater than the put_timestamp + and the database had no rows or because it was + successfully sync'ed to other locations and doesn't + belong here anymore. +``account-replicator.successes`` Count of replication attempts to an individual node + which were successful. +``account-replicator.timing`` Timing data for each database replication attempt + not resulting in a failure. +======================================= ==================================================== diff --git a/doc/source/metrics/account_server.rst b/doc/source/metrics/account_server.rst index 66110fd99c..6bf75f0558 100644 --- a/doc/source/metrics/account_server.rst +++ b/doc/source/metrics/account_server.rst @@ -3,35 +3,35 @@ ..note:: "Not Found" is not considered an error and requests - which increment `errors` are not included in the timing data. + which increment ``errors`` are not included in the timing data. -======================================== ======================================================= -Metric Name Description ----------------------------------------- ------------------------------------------------------- -`account-server.DELETE.errors.timing` Timing data for each DELETE request resulting in an - error: bad request, not mounted, missing timestamp. -`account-server.DELETE.timing` Timing data for each DELETE request not resulting in - an error. -`account-server.PUT.errors.timing` Timing data for each PUT request resulting in an error: - bad request, not mounted, conflict, recently-deleted. -`account-server.PUT.timing` Timing data for each PUT request not resulting in an - error. -`account-server.HEAD.errors.timing` Timing data for each HEAD request resulting in an - error: bad request, not mounted. -`account-server.HEAD.timing` Timing data for each HEAD request not resulting in - an error. -`account-server.GET.errors.timing` Timing data for each GET request resulting in an - error: bad request, not mounted, bad delimiter, - account listing limit too high, bad accept header. -`account-server.GET.timing` Timing data for each GET request not resulting in - an error. -`account-server.REPLICATE.errors.timing` Timing data for each REPLICATE request resulting in an - error: bad request, not mounted. -`account-server.REPLICATE.timing` Timing data for each REPLICATE request not resulting - in an error. -`account-server.POST.errors.timing` Timing data for each POST request resulting in an - error: bad request, bad or missing timestamp, not - mounted. -`account-server.POST.timing` Timing data for each POST request not resulting in - an error. -======================================== ======================================================= +========================================== ======================================================= +Metric Name Description +------------------------------------------ ------------------------------------------------------- +``account-server.DELETE.errors.timing`` Timing data for each DELETE request resulting in an + error: bad request, not mounted, missing timestamp. +``account-server.DELETE.timing`` Timing data for each DELETE request not resulting in + an error. +``account-server.PUT.errors.timing`` Timing data for each PUT request resulting in an error: + bad request, not mounted, conflict, recently-deleted. +``account-server.PUT.timing`` Timing data for each PUT request not resulting in an + error. +``account-server.HEAD.errors.timing`` Timing data for each HEAD request resulting in an + error: bad request, not mounted. +``account-server.HEAD.timing`` Timing data for each HEAD request not resulting in + an error. +``account-server.GET.errors.timing`` Timing data for each GET request resulting in an + error: bad request, not mounted, bad delimiter, + account listing limit too high, bad accept header. +``account-server.GET.timing`` Timing data for each GET request not resulting in + an error. +``account-server.REPLICATE.errors.timing`` Timing data for each REPLICATE request resulting in an + error: bad request, not mounted. +``account-server.REPLICATE.timing`` Timing data for each REPLICATE request not resulting + in an error. +``account-server.POST.errors.timing`` Timing data for each POST request resulting in an + error: bad request, bad or missing timestamp, not + mounted. +``account-server.POST.timing`` Timing data for each POST request not resulting in + an error. +========================================== ======================================================= diff --git a/doc/source/metrics/container_auditor.rst b/doc/source/metrics/container_auditor.rst index 9c1043c082..4054337098 100644 --- a/doc/source/metrics/container_auditor.rst +++ b/doc/source/metrics/container_auditor.rst @@ -1,12 +1,12 @@ ``container-auditor`` Metrics ============================= -============================ ==================================================== -Metric Name Description ----------------------------- ---------------------------------------------------- -`container-auditor.errors` Incremented when an Exception is caught in an audit - pass (only once per pass, max). -`container-auditor.passes` Count of individual containers passing an audit. -`container-auditor.failures` Count of individual containers failing an audit. -`container-auditor.timing` Timing data for each container audit. -============================ ==================================================== +============================== ==================================================== +Metric Name Description +------------------------------ ---------------------------------------------------- +``container-auditor.errors`` Incremented when an Exception is caught in an audit + pass (only once per pass, max). +``container-auditor.passes`` Count of individual containers passing an audit. +``container-auditor.failures`` Count of individual containers failing an audit. +``container-auditor.timing`` Timing data for each container audit. +============================== ==================================================== diff --git a/doc/source/metrics/container_replicator.rst b/doc/source/metrics/container_replicator.rst index 2f9463be68..c575190638 100644 --- a/doc/source/metrics/container_replicator.rst +++ b/doc/source/metrics/container_replicator.rst @@ -1,31 +1,31 @@ ``container-replicator`` Metrics ================================ -======================================= ==================================================== -Metric Name Description ---------------------------------------- ---------------------------------------------------- -`container-replicator.diffs` Count of syncs handled by sending differing rows. -`container-replicator.diff_caps` Count of "diffs" operations which failed because - "max_diffs" was hit. -`container-replicator.no_changes` Count of containers found to be in sync. -`container-replicator.hashmatches` Count of containers found to be in sync via hash - comparison (`broker.merge_syncs` was called). -`container-replicator.rsyncs` Count of completely missing containers where were sent - via rsync. -`container-replicator.remote_merges` Count of syncs handled by sending entire database - via rsync. -`container-replicator.attempts` Count of database replication attempts. -`container-replicator.failures` Count of database replication attempts which failed - due to corruption (quarantined) or inability to read - as well as attempts to individual nodes which - failed. -`container-replicator.removes.` Count of databases deleted on because the - delete_timestamp was greater than the put_timestamp - and the database had no rows or because it was - successfully sync'ed to other locations and doesn't - belong here anymore. -`container-replicator.successes` Count of replication attempts to an individual node - which were successful. -`container-replicator.timing` Timing data for each database replication attempt - not resulting in a failure. -======================================= ==================================================== +========================================= ==================================================== +Metric Name Description +----------------------------------------- ---------------------------------------------------- +``container-replicator.diffs`` Count of syncs handled by sending differing rows. +``container-replicator.diff_caps`` Count of "diffs" operations which failed because + "max_diffs" was hit. +``container-replicator.no_changes`` Count of containers found to be in sync. +``container-replicator.hashmatches`` Count of containers found to be in sync via hash + comparison (``broker.merge_syncs`` was called). +``container-replicator.rsyncs`` Count of completely missing containers where were sent + via rsync. +``container-replicator.remote_merges`` Count of syncs handled by sending entire database + via rsync. +``container-replicator.attempts`` Count of database replication attempts. +``container-replicator.failures`` Count of database replication attempts which failed + due to corruption (quarantined) or inability to read + as well as attempts to individual nodes which + failed. +``container-replicator.removes.`` Count of databases deleted on because the + delete_timestamp was greater than the put_timestamp + and the database had no rows or because it was + successfully sync'ed to other locations and doesn't + belong here anymore. +``container-replicator.successes`` Count of replication attempts to an individual node + which were successful. +``container-replicator.timing`` Timing data for each database replication attempt + not resulting in a failure. +========================================= ==================================================== diff --git a/doc/source/metrics/container_server.rst b/doc/source/metrics/container_server.rst index 95a94509ea..a5c41daf87 100644 --- a/doc/source/metrics/container_server.rst +++ b/doc/source/metrics/container_server.rst @@ -3,33 +3,33 @@ .. note:: "Not Found" is not considered an error and requests - which increment `errors` are not included in the timing data. + which increment ``errors`` are not included in the timing data. -========================================== ==================================================== -Metric Name Description ------------------------------------------- ---------------------------------------------------- -`container-server.DELETE.errors.timing` Timing data for DELETE request errors: bad request, - not mounted, missing timestamp, conflict. -`container-server.DELETE.timing` Timing data for each DELETE request not resulting in - an error. -`container-server.PUT.errors.timing` Timing data for PUT request errors: bad request, - missing timestamp, not mounted, conflict. -`container-server.PUT.timing` Timing data for each PUT request not resulting in an - error. -`container-server.HEAD.errors.timing` Timing data for HEAD request errors: bad request, - not mounted. -`container-server.HEAD.timing` Timing data for each HEAD request not resulting in - an error. -`container-server.GET.errors.timing` Timing data for GET request errors: bad request, - not mounted, parameters not utf8, bad accept header. -`container-server.GET.timing` Timing data for each GET request not resulting in - an error. -`container-server.REPLICATE.errors.timing` Timing data for REPLICATE request errors: bad - request, not mounted. -`container-server.REPLICATE.timing` Timing data for each REPLICATE request not resulting - in an error. -`container-server.POST.errors.timing` Timing data for POST request errors: bad request, - bad x-container-sync-to, not mounted. -`container-server.POST.timing` Timing data for each POST request not resulting in - an error. -========================================== ==================================================== +============================================ ==================================================== +Metric Name Description +-------------------------------------------- ---------------------------------------------------- +``container-server.DELETE.errors.timing`` Timing data for DELETE request errors: bad request, + not mounted, missing timestamp, conflict. +``container-server.DELETE.timing`` Timing data for each DELETE request not resulting in + an error. +``container-server.PUT.errors.timing`` Timing data for PUT request errors: bad request, + missing timestamp, not mounted, conflict. +``container-server.PUT.timing`` Timing data for each PUT request not resulting in an + error. +``container-server.HEAD.errors.timing`` Timing data for HEAD request errors: bad request, + not mounted. +``container-server.HEAD.timing`` Timing data for each HEAD request not resulting in + an error. +``container-server.GET.errors.timing`` Timing data for GET request errors: bad request, + not mounted, parameters not utf8, bad accept header. +``container-server.GET.timing`` Timing data for each GET request not resulting in + an error. +``container-server.REPLICATE.errors.timing`` Timing data for REPLICATE request errors: bad + request, not mounted. +``container-server.REPLICATE.timing`` Timing data for each REPLICATE request not resulting + in an error. +``container-server.POST.errors.timing`` Timing data for POST request errors: bad request, + bad x-container-sync-to, not mounted. +``container-server.POST.timing`` Timing data for each POST request not resulting in + an error. +============================================ ==================================================== diff --git a/doc/source/metrics/container_sync.rst b/doc/source/metrics/container_sync.rst index 40a291ea73..e36a15fef1 100644 --- a/doc/source/metrics/container_sync.rst +++ b/doc/source/metrics/container_sync.rst @@ -1,18 +1,18 @@ ``container-sync`` Metrics ========================== -=============================== ==================================================== -Metric Name Description -------------------------------- ---------------------------------------------------- -`container-sync.skips` Count of containers skipped because they don't have - sync'ing enabled. -`container-sync.failures` Count of failures sync'ing of individual containers. -`container-sync.syncs` Count of individual containers sync'ed successfully. -`container-sync.deletes` Count of container database rows sync'ed by - deletion. -`container-sync.deletes.timing` Timing data for each container database row - synchronization via deletion. -`container-sync.puts` Count of container database rows sync'ed by Putting. -`container-sync.puts.timing` Timing data for each container database row - synchronization via Putting. -=============================== ==================================================== +================================= ==================================================== +Metric Name Description +--------------------------------- ---------------------------------------------------- +``container-sync.skips`` Count of containers skipped because they don't have + sync'ing enabled. +``container-sync.failures`` Count of failures sync'ing of individual containers. +``container-sync.syncs`` Count of individual containers sync'ed successfully. +``container-sync.deletes`` Count of container database rows sync'ed by + deletion. +``container-sync.deletes.timing`` Timing data for each container database row + synchronization via deletion. +``container-sync.puts`` Count of container database rows sync'ed by Putting. +``container-sync.puts.timing`` Timing data for each container database row + synchronization via Putting. +================================= ==================================================== diff --git a/doc/source/metrics/container_updater.rst b/doc/source/metrics/container_updater.rst index b1ce46ef9f..d498266f21 100644 --- a/doc/source/metrics/container_updater.rst +++ b/doc/source/metrics/container_updater.rst @@ -1,17 +1,17 @@ ``container-updater`` Metrics ============================= -============================== ==================================================== -Metric Name Description ------------------------------- ---------------------------------------------------- -`container-updater.successes` Count of containers which successfully updated their - account. -`container-updater.failures` Count of containers which failed to update their - account. -`container-updater.no_changes` Count of containers which didn't need to update - their account. -`container-updater.timing` Timing data for processing a container; only - includes timing for containers which needed to - update their accounts (i.e. "successes" and - "failures" but not "no_changes"). -============================== ==================================================== +================================ ==================================================== +Metric Name Description +-------------------------------- ---------------------------------------------------- +``container-updater.successes`` Count of containers which successfully updated their + account. +``container-updater.failures`` Count of containers which failed to update their + account. +``container-updater.no_changes`` Count of containers which didn't need to update + their account. +``container-updater.timing`` Timing data for processing a container; only + includes timing for containers which needed to + update their accounts (i.e. "successes" and + "failures" but not "no_changes"). +================================ ==================================================== diff --git a/doc/source/metrics/object_auditor.rst b/doc/source/metrics/object_auditor.rst index ea0751d727..4baa040075 100644 --- a/doc/source/metrics/object_auditor.rst +++ b/doc/source/metrics/object_auditor.rst @@ -1,13 +1,13 @@ ``object-auditor`` Metrics ========================== -============================ ==================================================== -Metric Name Description ----------------------------- ---------------------------------------------------- -`object-auditor.quarantines` Count of objects failing audit and quarantined. -`object-auditor.errors` Count of errors encountered while auditing objects. -`object-auditor.timing` Timing data for each object audit (does not include - any rate-limiting sleep time for - max_files_per_second, but does include rate-limiting - sleep time for max_bytes_per_second). -============================ ==================================================== +============================== ==================================================== +Metric Name Description +------------------------------ ---------------------------------------------------- +``object-auditor.quarantines`` Count of objects failing audit and quarantined. +``object-auditor.errors`` Count of errors encountered while auditing objects. +``object-auditor.timing`` Timing data for each object audit (does not include + any rate-limiting sleep time for + max_files_per_second, but does include rate-limiting + sleep time for max_bytes_per_second). +============================== ==================================================== diff --git a/doc/source/metrics/object_expirer.rst b/doc/source/metrics/object_expirer.rst index 3026ec9165..71e725ec8f 100644 --- a/doc/source/metrics/object_expirer.rst +++ b/doc/source/metrics/object_expirer.rst @@ -1,12 +1,12 @@ ``object-expirer`` Metrics ========================== -======================== ==================================================== -Metric Name Description ------------------------- ---------------------------------------------------- -`object-expirer.objects` Count of objects expired. -`object-expirer.errors` Count of errors encountered while attempting to - expire an object. -`object-expirer.timing` Timing data for each object expiration attempt, - including ones resulting in an error. -======================== ==================================================== +========================== ==================================================== +Metric Name Description +-------------------------- ---------------------------------------------------- +``object-expirer.objects`` Count of objects expired. +``object-expirer.errors`` Count of errors encountered while attempting to + expire an object. +``object-expirer.timing`` Timing data for each object expiration attempt, + including ones resulting in an error. +========================== ==================================================== diff --git a/doc/source/metrics/object_reconstructor.rst b/doc/source/metrics/object_reconstructor.rst index e726f74cb3..66ec0bec8b 100644 --- a/doc/source/metrics/object_reconstructor.rst +++ b/doc/source/metrics/object_reconstructor.rst @@ -1,25 +1,25 @@ ``object-reconstructor`` Metrics ================================ -====================================================== ====================================================== -Metric Name Description ------------------------------------------------------- ------------------------------------------------------ -`object-reconstructor.partition.delete.count.` A count of partitions on which were - reconstructed and synced to another node because they - didn't belong on this node. This metric is tracked - per-device to allow for "quiescence detection" for - object reconstruction activity on each device. -`object-reconstructor.partition.delete.timing` Timing data for partitions reconstructed and synced to - another node because they didn't belong on this node. - This metric is not tracked per device. -`object-reconstructor.partition.update.count.` A count of partitions on which were - reconstructed and synced to another node, but also - belong on this node. As with delete.count, this metric - is tracked per-device. -`object-reconstructor.partition.update.timing` Timing data for partitions reconstructed which also - belong on this node. This metric is not tracked - per-device. -`object-reconstructor.suffix.hashes` Count of suffix directories whose hash (of filenames) - was recalculated. -`object-reconstructor.suffix.syncs` Count of suffix directories reconstructed with ssync. -====================================================== ====================================================== +======================================================== ====================================================== +Metric Name Description +-------------------------------------------------------- ------------------------------------------------------ +``object-reconstructor.partition.delete.count.`` A count of partitions on which were + reconstructed and synced to another node because they + didn't belong on this node. This metric is tracked + per-device to allow for "quiescence detection" for + object reconstruction activity on each device. +``object-reconstructor.partition.delete.timing`` Timing data for partitions reconstructed and synced to + another node because they didn't belong on this node. + This metric is not tracked per device. +``object-reconstructor.partition.update.count.`` A count of partitions on which were + reconstructed and synced to another node, but also + belong on this node. As with delete.count, this metric + is tracked per-device. +``object-reconstructor.partition.update.timing`` Timing data for partitions reconstructed which also + belong on this node. This metric is not tracked + per-device. +``object-reconstructor.suffix.hashes`` Count of suffix directories whose hash (of filenames) + was recalculated. +``object-reconstructor.suffix.syncs`` Count of suffix directories reconstructed with ssync. +======================================================== ====================================================== diff --git a/doc/source/metrics/object_replicator.rst b/doc/source/metrics/object_replicator.rst index d0267d4e3c..934c1c3f5a 100644 --- a/doc/source/metrics/object_replicator.rst +++ b/doc/source/metrics/object_replicator.rst @@ -1,25 +1,25 @@ ``object-replicator`` Metrics ============================= -=================================================== ==================================================== -Metric Name Description ---------------------------------------------------- ---------------------------------------------------- -`object-replicator.partition.delete.count.` A count of partitions on which were - replicated to another node because they didn't - belong on this node. This metric is tracked - per-device to allow for "quiescence detection" for - object replication activity on each device. -`object-replicator.partition.delete.timing` Timing data for partitions replicated to another - node because they didn't belong on this node. This - metric is not tracked per device. -`object-replicator.partition.update.count.` A count of partitions on which were - replicated to another node, but also belong on this - node. As with delete.count, this metric is tracked - per-device. -`object-replicator.partition.update.timing` Timing data for partitions replicated which also - belong on this node. This metric is not tracked - per-device. -`object-replicator.suffix.hashes` Count of suffix directories whose hash (of filenames) - was recalculated. -`object-replicator.suffix.syncs` Count of suffix directories replicated with rsync. -=================================================== ==================================================== +===================================================== ==================================================== +Metric Name Description +----------------------------------------------------- ---------------------------------------------------- +``object-replicator.partition.delete.count.`` A count of partitions on which were + replicated to another node because they didn't + belong on this node. This metric is tracked + per-device to allow for "quiescence detection" for + object replication activity on each device. +``object-replicator.partition.delete.timing`` Timing data for partitions replicated to another + node because they didn't belong on this node. This + metric is not tracked per device. +``object-replicator.partition.update.count.`` A count of partitions on which were + replicated to another node, but also belong on this + node. As with delete.count, this metric is tracked + per-device. +``object-replicator.partition.update.timing`` Timing data for partitions replicated which also + belong on this node. This metric is not tracked + per-device. +``object-replicator.suffix.hashes`` Count of suffix directories whose hash (of filenames) + was recalculated. +``object-replicator.suffix.syncs`` Count of suffix directories replicated with rsync. +===================================================== ==================================================== diff --git a/doc/source/metrics/object_server.rst b/doc/source/metrics/object_server.rst index afc56408d7..ef4c5e07ad 100644 --- a/doc/source/metrics/object_server.rst +++ b/doc/source/metrics/object_server.rst @@ -1,49 +1,49 @@ ``object-server`` Metrics ========================= -======================================= ==================================================== -Metric Name Description ---------------------------------------- ---------------------------------------------------- -`object-server.quarantines` Count of objects (files) found bad and moved to - quarantine. -`object-server.async_pendings` Count of container updates saved as async_pendings - (may result from PUT or DELETE requests). -`object-server.POST.errors.timing` Timing data for POST request errors: bad request, - missing timestamp, delete-at in past, not mounted. -`object-server.POST.timing` Timing data for each POST request not resulting in - an error. -`object-server.PUT.errors.timing` Timing data for PUT request errors: bad request, - not mounted, missing timestamp, object creation - constraint violation, delete-at in past. -`object-server.PUT.timeouts` Count of object PUTs which exceeded max_upload_time. -`object-server.PUT.timing` Timing data for each PUT request not resulting in an - error. -`object-server.PUT..timing` Timing data per kB transferred (ms/kB) for each - non-zero-byte PUT request on each device. - Monitoring problematic devices, higher is bad. -`object-server.GET.errors.timing` Timing data for GET request errors: bad request, - not mounted, header timestamps before the epoch, - precondition failed. - File errors resulting in a quarantine are not - counted here. -`object-server.GET.timing` Timing data for each GET request not resulting in an - error. Includes requests which couldn't find the - object (including disk errors resulting in file - quarantine). -`object-server.HEAD.errors.timing` Timing data for HEAD request errors: bad request, - not mounted. -`object-server.HEAD.timing` Timing data for each HEAD request not resulting in - an error. Includes requests which couldn't find the - object (including disk errors resulting in file - quarantine). -`object-server.DELETE.errors.timing` Timing data for DELETE request errors: bad request, - missing timestamp, not mounted, precondition - failed. Includes requests which couldn't find or - match the object. -`object-server.DELETE.timing` Timing data for each DELETE request not resulting - in an error. -`object-server.REPLICATE.errors.timing` Timing data for REPLICATE request errors: bad - request, not mounted. -`object-server.REPLICATE.timing` Timing data for each REPLICATE request not resulting - in an error. -======================================= ==================================================== +========================================= ==================================================== +Metric Name Description +----------------------------------------- ---------------------------------------------------- +``object-server.quarantines`` Count of objects (files) found bad and moved to + quarantine. +``object-server.async_pendings`` Count of container updates saved as async_pendings + (may result from PUT or DELETE requests). +``object-server.POST.errors.timing`` Timing data for POST request errors: bad request, + missing timestamp, delete-at in past, not mounted. +``object-server.POST.timing`` Timing data for each POST request not resulting in + an error. +``object-server.PUT.errors.timing`` Timing data for PUT request errors: bad request, + not mounted, missing timestamp, object creation + constraint violation, delete-at in past. +``object-server.PUT.timeouts`` Count of object PUTs which exceeded max_upload_time. +``object-server.PUT.timing`` Timing data for each PUT request not resulting in an + error. +``object-server.PUT..timing`` Timing data per kB transferred (ms/kB) for each + non-zero-byte PUT request on each device. + Monitoring problematic devices, higher is bad. +``object-server.GET.errors.timing`` Timing data for GET request errors: bad request, + not mounted, header timestamps before the epoch, + precondition failed. + File errors resulting in a quarantine are not + counted here. +``object-server.GET.timing`` Timing data for each GET request not resulting in an + error. Includes requests which couldn't find the + object (including disk errors resulting in file + quarantine). +``object-server.HEAD.errors.timing`` Timing data for HEAD request errors: bad request, + not mounted. +``object-server.HEAD.timing`` Timing data for each HEAD request not resulting in + an error. Includes requests which couldn't find the + object (including disk errors resulting in file + quarantine). +``object-server.DELETE.errors.timing`` Timing data for DELETE request errors: bad request, + missing timestamp, not mounted, precondition + failed. Includes requests which couldn't find or + match the object. +``object-server.DELETE.timing`` Timing data for each DELETE request not resulting + in an error. +``object-server.REPLICATE.errors.timing`` Timing data for REPLICATE request errors: bad + request, not mounted. +``object-server.REPLICATE.timing`` Timing data for each REPLICATE request not resulting + in an error. +========================================= ==================================================== diff --git a/doc/source/metrics/object_updater.rst b/doc/source/metrics/object_updater.rst index ca0eb2ad98..ca223e4994 100644 --- a/doc/source/metrics/object_updater.rst +++ b/doc/source/metrics/object_updater.rst @@ -1,22 +1,22 @@ ``object-updater`` Metrics ========================== -============================ ==================================================== -Metric Name Description ----------------------------- ---------------------------------------------------- -`object-updater.errors` Count of drives not mounted or async_pending files - with an unexpected name. -`object-updater.timing` Timing data for object sweeps to flush async_pending - container updates. Does not include object sweeps - which did not find an existing async_pending storage - directory. -`object-updater.quarantines` Count of async_pending container updates which were - corrupted and moved to quarantine. -`object-updater.successes` Count of successful container updates. -`object-updater.failures` Count of failed container updates. -`object-updater.unlinks` Count of async_pending files unlinked. An - async_pending file is unlinked either when it is - successfully processed or when the replicator sees - that there is a newer async_pending file for the - same object. -============================ ==================================================== +============================== ==================================================== +Metric Name Description +------------------------------ ---------------------------------------------------- +``object-updater.errors`` Count of drives not mounted or async_pending files + with an unexpected name. +``object-updater.timing`` Timing data for object sweeps to flush async_pending + container updates. Does not include object sweeps + which did not find an existing async_pending storage + directory. +``object-updater.quarantines`` Count of async_pending container updates which were + corrupted and moved to quarantine. +``object-updater.successes`` Count of successful container updates. +``object-updater.failures`` Count of failed container updates. +``object-updater.unlinks`` Count of async_pending files unlinked. An + async_pending file is unlinked either when it is + successfully processed or when the replicator sees + that there is a newer async_pending file for the + same object. +============================== ==================================================== diff --git a/doc/source/metrics/proxy_server.rst b/doc/source/metrics/proxy_server.rst index 56a10773ab..c457478a48 100644 --- a/doc/source/metrics/proxy_server.rst +++ b/doc/source/metrics/proxy_server.rst @@ -4,27 +4,27 @@ In the table, ```` is the proxy-server controller responsible for the request and will be one of ``account``, ``container``, or ``object``. -======================================== ==================================================== -Metric Name Description ----------------------------------------- ---------------------------------------------------- -`proxy-server.errors` Count of errors encountered while serving requests - before the controller type is determined. Includes - invalid Content-Length, errors finding the internal - controller to handle the request, invalid utf8, and - bad URLs. -`proxy-server..handoff_count` Count of node hand-offs; only tracked if log_handoffs - is set in the proxy-server config. -`proxy-server..handoff_all_count` Count of times *only* hand-off locations were - utilized; only tracked if log_handoffs is set in the - proxy-server config. -`proxy-server..client_timeouts` Count of client timeouts (client did not read within - `client_timeout` seconds during a GET or did not - supply data within `client_timeout` seconds during - a PUT). -`proxy-server..client_disconnects` Count of detected client disconnects during PUT - operations (does NOT include caught Exceptions in - the proxy-server which caused a client disconnect). -======================================== ==================================================== +========================================== ==================================================== +Metric Name Description +------------------------------------------ ---------------------------------------------------- +``proxy-server.errors`` Count of errors encountered while serving requests + before the controller type is determined. Includes + invalid Content-Length, errors finding the internal + controller to handle the request, invalid utf8, and + bad URLs. +``proxy-server..handoff_count`` Count of node hand-offs; only tracked if log_handoffs + is set in the proxy-server config. +``proxy-server..handoff_all_count`` Count of times *only* hand-off locations were + utilized; only tracked if log_handoffs is set in the + proxy-server config. +``proxy-server..client_timeouts`` Count of client timeouts (client did not read within + ``client_timeout`` seconds during a GET or did not + supply data within ``client_timeout`` seconds during + a PUT). +``proxy-server..client_disconnects`` Count of detected client disconnects during PUT + operations (does NOT include caught Exceptions in + the proxy-server which caused a client disconnect). +========================================== ==================================================== Additionally, middleware often emit their own metrics @@ -41,51 +41,51 @@ config variable and the default setting yields the above behavior. .. _Swift Origin Server: https://github.com/dpgoetz/sos -==================================================== ============================================ -Metric Name Description ----------------------------------------------------- -------------------------------------------- -`proxy-server....timing` Timing data for requests, start to finish. - The portion is the numeric HTTP - status code for the request (e.g. "200" or - "404"). -`proxy-server..GET..first-byte.timing` Timing data up to completion of sending the - response headers (only for GET requests). - and are as for the main - timing metric. -`proxy-server....xfer` This counter metric is the sum of bytes - transferred in (from clients) and out (to - clients) for requests. The , , - and portions of the metric are just - like the main timing metric. -==================================================== ============================================ +====================================================== ============================================ +Metric Name Description +------------------------------------------------------ -------------------------------------------- +``proxy-server....timing`` Timing data for requests, start to finish. + The portion is the numeric HTTP + status code for the request (e.g. "200" or + "404"). +``proxy-server..GET..first-byte.timing`` Timing data up to completion of sending the + response headers (only for GET requests). + and are as for the main + timing metric. +``proxy-server....xfer`` This counter metric is the sum of bytes + transferred in (from clients) and out (to + clients) for requests. The , , + and portions of the metric are just + like the main timing metric. +====================================================== ============================================ The ``proxy-logging`` middleware also groups these metrics by policy. The ```` portion represents a policy index: -========================================================================== ===================================== -Metric Name Description --------------------------------------------------------------------------- ------------------------------------- -`proxy-server.object.policy....timing` Timing data for requests, aggregated - by policy index. -`proxy-server.object.policy..GET..first-byte.timing` Timing data up to completion of - sending the response headers, - aggregated by policy index. -`proxy-server.object.policy....xfer` Sum of bytes transferred in and out, - aggregated by policy index. -========================================================================== ===================================== +============================================================================ ===================================== +Metric Name Description +---------------------------------------------------------------------------- ------------------------------------- +``proxy-server.object.policy....timing`` Timing data for requests, aggregated + by policy index. +``proxy-server.object.policy..GET..first-byte.timing`` Timing data up to completion of + sending the response headers, + aggregated by policy index. +``proxy-server.object.policy....xfer`` Sum of bytes transferred in and out, + aggregated by policy index. +============================================================================ ===================================== ``tempauth`` Middleware ----------------------- In the table, ```` represents the actual configured reseller_prefix or ``NONE`` if the reseller_prefix is the empty string: -========================================= ==================================================== -Metric Name Description ------------------------------------------ ---------------------------------------------------- -`tempauth..unauthorized` Count of regular requests which were denied with - HTTPUnauthorized. -`tempauth..forbidden` Count of regular requests which were denied with - HTTPForbidden. -`tempauth..token_denied` Count of token requests which were denied. -`tempauth..errors` Count of errors. -========================================= ==================================================== +=========================================== ==================================================== +Metric Name Description +------------------------------------------- ---------------------------------------------------- +``tempauth..unauthorized`` Count of regular requests which were denied with + HTTPUnauthorized. +``tempauth..forbidden`` Count of regular requests which were denied with + HTTPForbidden. +``tempauth..token_denied`` Count of token requests which were denied. +``tempauth..errors`` Count of errors. +=========================================== ====================================================