Unit descriptions tuning

Author: robsunday

instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/tomcat.yaml

@@ -63,7 +63,7 @@ rules:
         metric: session.active.limit
         type: updowncounter
         unit: "{session}"
-        desc: Maximum number of active sessions.
+        desc: Maximum possible number of active sessions.
 
   - beans:
     - Catalina:type=ThreadPool,name=*
@@ -79,7 +79,7 @@ rules:
         desc: Total thread count of the thread pool.
       maxThreads:
         metric: limit
-        desc: Maximum thread count of the thread pool.
+        desc: Maximum possible number of threads in the thread pool.
       currentThreadsBusy:
         metric: busy.count
         desc: Number of busy threads in the thread pool.

instrumentation/jmx-metrics/library/src/test/java/io/opentelemetry/instrumentation/jmx/rules/TomcatIntegrationTest.java

@@ -122,7 +122,7 @@ private static MetricsVerifier createMetricsVerifier() {
             "tomcat.session.active.limit",
             metric ->
                 metric
-                    .hasDescription("Maximum number of active sessions.")
+                    .hasDescription("Maximum possible number of active sessions.")
                     .hasUnit("{session}")
                     .isUpDownCounter()
                     .hasDataPointsWithOneAttribute(attributeWithAnyValue("tomcat.context")))
@@ -138,7 +138,7 @@ private static MetricsVerifier createMetricsVerifier() {
             "tomcat.thread.limit",
             metric ->
                 metric
-                    .hasDescription("Maximum thread count of the thread pool.")
+                    .hasDescription("Maximum possible number of threads in the thread pool.")
                     .hasUnit("{thread}")
                     .isUpDownCounter()
                     .hasDataPointsWithOneAttribute(threadPoolNameAttribute))

instrumentation/jmx-metrics/library/tomcat.md

@@ -2,15 +2,15 @@
 
 Here is the list of metrics based on MBeans exposed by Tomcat.
 
-| Metric Name                 | Type          | Attributes                                          | Description                                |
-|-----------------------------|---------------|-----------------------------------------------------|--------------------------------------------|
-| tomcat.session.active.count | UpDownCounter | tomcat.context                                      | The number of currently active sessions.   |
-| tomcat.session.active.limit | UpDownCounter | tomcat.context                                      | Maximum number of active sessions.         |
-| tomcat.error.count          | Counter       | tomcat.request.processor.name                       | The number of errors.                      |
-| tomcat.request.count        | Counter       | tomcat.request.processor.name                       | The number of requests processed.          |
-| tomcat.request.duration.max | Gauge         | tomcat.request.processor.name                       | The longest request processing time.       |
-| tomcat.request.duration.sum | Counter       | tomcat.request.processor.name                       | Total time of processing all requests.     |
-| tomcat.network.io           | Counter       | tomcat.request.processor.name, network.io.direction | The number of bytes transmitted.           |
-| tomcat.thread.count         | UpDownCounter | tomcat.thread.pool.name                             | Total thread count of the thread pool.     |
-| tomcat.thread.limit         | UpDownCounter | tomcat.thread.pool.name                             | Maximum thread count of the thread pool.   |
-| tomcat.thread.busy.count    | UpDownCounter | tomcat.thread.pool.name                             | Number of busy threads in the thread pool. |
+| Metric Name                 | Type          | Attributes                                          | Description                                            |
+|-----------------------------|---------------|-----------------------------------------------------|--------------------------------------------------------|
+| tomcat.session.active.count | UpDownCounter | tomcat.context                                      | The number of currently active sessions.               |
+| tomcat.session.active.limit | UpDownCounter | tomcat.context                                      | Maximum possible number of active sessions.            |
+| tomcat.error.count          | Counter       | tomcat.request.processor.name                       | The number of errors.                                  |
+| tomcat.request.count        | Counter       | tomcat.request.processor.name                       | The number of requests processed.                      |
+| tomcat.request.duration.max | Gauge         | tomcat.request.processor.name                       | The longest request processing time.                   |
+| tomcat.request.duration.sum | Counter       | tomcat.request.processor.name                       | Total time of processing all requests.                 |
+| tomcat.network.io           | Counter       | tomcat.request.processor.name, network.io.direction | The number of bytes transmitted.                       |
+| tomcat.thread.count         | UpDownCounter | tomcat.thread.pool.name                             | Total thread count of the thread pool.                 |
+| tomcat.thread.limit         | UpDownCounter | tomcat.thread.pool.name                             | Maximum possible number of threads in the thread pool. |
+| tomcat.thread.busy.count    | UpDownCounter | tomcat.thread.pool.name                             | Number of busy threads in the thread pool.             |