From 5be20af9b87d3beb2e5f05a7c3eb07b0e625b105 Mon Sep 17 00:00:00 2001
From: Jeffrey Mendelsohn <JMENDELSOHN4@bloomberg.net>
Date: Thu, 30 Jan 2025 10:13:52 -0500
Subject: [PATCH] Add metric section in doc (#5187)

---
 groups/bdl/bdlmt/bdlmt_eventscheduler.h      |  9 +++++++++
 groups/bdl/bdlmt/bdlmt_fixedthreadpool.h     | 13 +++++++++++++
 groups/bdl/bdlmt/bdlmt_threadpool.h          | 10 ++++++++++
 groups/bdl/bdlmt/bdlmt_timereventscheduler.h |  9 +++++++++
 4 files changed, 41 insertions(+)

diff --git a/groups/bdl/bdlmt/bdlmt_eventscheduler.h b/groups/bdl/bdlmt/bdlmt_eventscheduler.h
index 6494321229..9ab43ac09b 100644
--- a/groups/bdl/bdlmt/bdlmt_eventscheduler.h
+++ b/groups/bdl/bdlmt/bdlmt_eventscheduler.h
@@ -13,6 +13,15 @@ BSLS_IDENT("$Id: $")
 //  bdlmt::EventSchedulerRecurringEventHandle: handle to a recurring event
 //  bdlmt::EventSchedulerTestTimeSource: class for testing time changes
 //
+//@METRICS:
+//
+// * `bde.startlag`
+//   > seconds of delay in starting the next event (may be 0.0)
+//
+// Associated Metric Attributes:
+//  * object type name: "bdlmt.eventscheduler"
+//  * object type abbreviation: "es"
+//
 //@SEE_ALSO: bdlmt_timereventscheduler
 //
 //@DESCRIPTION: This component provides a thread-safe event scheduler.
diff --git a/groups/bdl/bdlmt/bdlmt_fixedthreadpool.h b/groups/bdl/bdlmt/bdlmt_fixedthreadpool.h
index 04c266e61f..098383c6e8 100644
--- a/groups/bdl/bdlmt/bdlmt_fixedthreadpool.h
+++ b/groups/bdl/bdlmt/bdlmt_fixedthreadpool.h
@@ -10,6 +10,19 @@ BSLS_IDENT("$Id: $")
 //@CLASSES:
 //   bdlmt::FixedThreadPool: portable fixed-size thread pool
 //
+//@METRICS:
+//
+// * `bde.backlog`
+//   > number of pending jobs minus number of "idle" threads in the thread pool
+//   > (may be negative)
+//
+// * `bde.usedcapacity`
+//   > number of pending jobs divided by queue capacity
+//
+// Associated Metric Attributes:
+//  * object type name: "bdlmt.fixedthreadpool"
+//  * object type abbreviation: "ftp"
+//
 //@SEE_ALSO: bdlmt_threadpool
 //
 //@DESCRIPTION: This component defines a portable and efficient implementation
diff --git a/groups/bdl/bdlmt/bdlmt_threadpool.h b/groups/bdl/bdlmt/bdlmt_threadpool.h
index 226ea67b38..07cf190368 100644
--- a/groups/bdl/bdlmt/bdlmt_threadpool.h
+++ b/groups/bdl/bdlmt/bdlmt_threadpool.h
@@ -10,6 +10,16 @@ BSLS_IDENT("$Id: $")
 //@CLASSES:
 //   bdlmt::ThreadPool: portable dynamic thread pool
 //
+//@METRICS:
+//
+// * `bde.backlog`
+//   > number of pending jobs minus number of "idle" threads in the thread pool
+//   > (may be negative)
+//
+// Associated Metric Attributes:
+//  * object type name: "bdlmt.threadpool"
+//  * object type abbreviation: "tp"
+//
 //@SEE_ALSO:
 //
 //@DESCRIPTION: This component defines a portable and efficient implementation
diff --git a/groups/bdl/bdlmt/bdlmt_timereventscheduler.h b/groups/bdl/bdlmt/bdlmt_timereventscheduler.h
index c4df508748..751105c6e2 100644
--- a/groups/bdl/bdlmt/bdlmt_timereventscheduler.h
+++ b/groups/bdl/bdlmt/bdlmt_timereventscheduler.h
@@ -10,6 +10,15 @@ BSLS_IDENT("$Id: $")
 //@CLASSES:
 //  bdlmt::TimerEventScheduler: thread-safe event scheduler
 //
+//@METRICS:
+//
+// * `bde.startlag`
+//   > seconds of delay in starting the next event (may be 0.0)
+//
+// Associated Metric Attributes:
+//  * object type name: "bdlmt.timereventscheduler"
+//  * object type abbreviation: "tes"
+//
 //@SEE_ALSO: bdlmt_eventscheduler, bdlcc_timequeue
 //
 //@DESCRIPTION: This component provides a thread-safe event scheduler,