summaryrefslogtreecommitdiff
path: root/src/mongo/util/perfctr_collect.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/util/perfctr_collect.h')
-rw-r--r--src/mongo/util/perfctr_collect.h18
1 files changed, 10 insertions, 8 deletions
diff --git a/src/mongo/util/perfctr_collect.h b/src/mongo/util/perfctr_collect.h
index 72c74f9833a..4c29fabd1cc 100644
--- a/src/mongo/util/perfctr_collect.h
+++ b/src/mongo/util/perfctr_collect.h
@@ -148,11 +148,13 @@ public:
static StatusWith<std::unique_ptr<PerfCounterCollector>> create(PerfCounterCollection builder);
/**
- * Collect the counters from PDH, and output their raw values into builder.
+ * Collect the counters from PDH, and output their raw values into builder. The exception is
+ * elapsed time counters which returns computed values instead of raw values.
*
- * For each counters, if the counter is a delta, rate, or fraction counter, the second value is
- * output under the name "<counter> Base". Also, a single field is output called "timebase" if
- * any counter depends on system ticks per second.
+ * For each counters, if the counter is a precision counter (see PERF_COUNTER_PRECISION), the
+ * second value is output under the name "<counter> Base". Also, a single field is output called
+ * "timebase" if any counter depends on system ticks per second. See counterHasTickBasedTimeBase
+ * for more details about timebase.
*/
Status collect(BSONObjBuilder* builder);
@@ -169,14 +171,14 @@ private:
std::string firstName;
/**
- * The name of the second value of a counter if the counter is a delta, rate, or fraction
- * counter. This is output as: "\<Object Name>\<Counter Name> Base".
+ * The name of the second value of a counter if the counter is a precision counter. This is
+ * output as: "\<Object Name>\<Counter Name> Base".
*/
std::string secondName;
/**
- * True if the counter is a delta, rate, or fraction counter, and its value should be output
- * in the output BSON document.
+ * True if the counter is a precision counter, and its value should be output in the output
+ * BSON document.
*/
bool hasSecondValue;