Skip to content

Commit cc2bedc

Browse files
SylvainJugeSylvainJuge
authored
add missing units to jmx metrics doc (#15007)
1 parent 7536867 commit cc2bedc

File tree

4 files changed

+67
-67
lines changed

4 files changed

+67
-67
lines changed

‎instrumentation/jmx-metrics/library/jetty.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,31 @@ The metrics captured and their respective attributes depend on the Jetty version
1010

1111
Those metrics require the following Jetty modules to be enabled : `jmx`, `http`, `statistics`, `sessions` and at least one of `ee8-deploy`, `ee9-deploy` or `ee10-deploy`.
1212

13-
| Metric Name | Type | Attributes | Description |
14-
|-------------------------|---------------|---------------|-------------------------------------------|
15-
| jetty.thread.count | UpDownCounter | | The current number of threads |
16-
| jetty.thread.limit | UpDownCounter | | The maximum number of threads in the pool |
17-
| jetty.thread.busy.count | UpDownCounter | | The current number of busy threads |
18-
| jetty.thread.idle.count | UpDownCounter | | The current number of idle threads |
19-
| jetty.thread.queue.size | UpDownCounter | | The current job queue size |
20-
| jetty.io.select.count | Counter | | The number of select calls |
21-
| jetty.session.count | UpDownCounter | jetty.context | Current number of active sessions |
13+
| Metric Name | Type | Unit | Attributes | Description |
14+
|-------------------------|---------------|-------------|---------------|-------------------------------------------|
15+
| jetty.thread.count | UpDownCounter | {thread} | | The current number of threads |
16+
| jetty.thread.limit | UpDownCounter | {thread} | | The maximum number of threads in the pool |
17+
| jetty.thread.busy.count | UpDownCounter | {thread} | | The current number of busy threads |
18+
| jetty.thread.idle.count | UpDownCounter | {thread} | | The current number of idle threads |
19+
| jetty.thread.queue.size | UpDownCounter | {thread} | | The current job queue size |
20+
| jetty.io.select.count | Counter | {operation} | | The number of select calls |
21+
| jetty.session.count | UpDownCounter | {session} | jetty.context | Current number of active sessions |
2222

2323
- `jetty.context` corresponds to the deployed application subfolder in `webapps` folder.
2424

2525
## Jetty 9 to 11
2626

2727
Those metrics require the following Jetty modules to be enabled : `jmx`, `http` and `stats`.
2828

29-
| Metric Name | Type | Attributes | Description |
30-
|-----------------------------|---------------|---------------|-------------------------------------------|
31-
| jetty.thread.count | UpDownCounter | | The current number of threads |
32-
| jetty.thread.limit | UpDownCounter | | The maximum number of threads in the pool |
33-
| jetty.thread.busy.count | UpDownCounter | | The current number of busy threads |
34-
| jetty.thread.idle.count | UpDownCounter | | The current number of idle threads |
35-
| jetty.thread.queue.size | UpDownCounter | | The current job queue size |
36-
| jetty.io.select.count | Counter | | The number of select calls |
37-
| jetty.session.created.count | Counter | jetty.context | The total number of created sessions |
38-
| jetty.session.duration.sum | Counter | jetty.context | The cumulated session duration |
29+
| Metric Name | Type | Unit | Attributes | Description |
30+
|-----------------------------|---------------|-------------|---------------|-------------------------------------------|
31+
| jetty.thread.count | UpDownCounter | {thread} | | The current number of threads |
32+
| jetty.thread.limit | UpDownCounter | {thread} | | The maximum number of threads in the pool |
33+
| jetty.thread.busy.count | UpDownCounter | {thread} | | The current number of busy threads |
34+
| jetty.thread.idle.count | UpDownCounter | {thread} | | The current number of idle threads |
35+
| jetty.thread.queue.size | UpDownCounter | {thread} | | The current job queue size |
36+
| jetty.io.select.count | Counter | {operation} | | The number of select calls |
37+
| jetty.session.created.count | Counter | {session} | jetty.context | The total number of created sessions |
38+
| jetty.session.duration.sum | Counter | {session} | jetty.context | The cumulated session duration |
3939

4040
- `jetty.context` corresponds to the deployed application subfolder in `webapps` folder.

‎instrumentation/jmx-metrics/library/jvm.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@ Here is the list of metrics based on MBeans exposed by the JVM and that are defi
44

55
Those metrics are defined in the [JVM runtime metrics semantic conventions](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/).
66

7-
| Metric Name | semconv maturity | Type | Attributes | Description |
8-
|---------------------------------------------------------------------------------------------------------------------------------------|:-----------------|---------------|---------------------------------------|-----------------------------------------------------|
9-
| [jvm.memory.used](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemoryused) | stable | UpDownCounter | jvm.memory.pool.name, jvm.memory.type | Used memory |
10-
| [jvm.memory.committed](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemorycommitted) | stable | UpDownCounter | jvm.memory.pool.name, jvm.memory.type | Committed memory |
11-
| [jvm.memory.limit](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemorylimit) | stable | UpDownCounter | jvm.memory.pool.name, jvm.memory.type | Max obtainable memory |
12-
| [jvm.memory.init](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemoryinit) | experimental | UpDownCounter | jvm.memory.pool.name, jvm.memory.type | Initial memory requested |
13-
| [jvm.memory.used_after_last_gc](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemoryused_after_last_gc) | stable | UpDownCounter | jvm.memory.pool.name, jvm.memory.type | Memory used after latest GC |
14-
| [jvm.thread.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmthreadcount) | stable | UpDownCounter | [^1] | Threads count |
15-
| [jvm.class.loaded](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclassloaded) | stable | Counter | | Classes loaded since JVM start |
16-
| [jvm.class.unloaded](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclassunloaded) | stable | Counter | | Classes unloaded since JVM start |
17-
| [jvm.class.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclasscount) | stable | UpDownCounter | | Classes currently loaded count |
18-
| [jvm.cpu.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcpucount) | stable | UpDownCounter | | Number of CPUs available |
19-
| [jvm.cpu.time](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcputime) | stable | Counter | | CPU time used by the process as reported by the JVM |
20-
| [jvm.cpu.recent_utilization](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcpurecent_utilization) | stable | Gauge | | Recent CPU utilization for process reported by JVM |
21-
| [jvm.file_descriptor.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmfile_descriptorcount) | experimental | UpDownCounter | | Number of open file descriptors |
22-
| [jvm.system.cpu.load_1m](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmsystemcpuload_1m) | experimental | Gauge | | Average CPU load reported by JVM |
23-
| [jvm.system.cpu.recent_utilization](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcpurecent_utilization) | experimental | Gauge | | Recent CPU utilization reported by JVM |
24-
| [jvm.buffer.memory.used](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmbuffermemoryused) | experimental | UpDownCounter | jvm.buffer.pool.name | Memory used by buffers |
25-
| [jvm.buffer.memory.limit](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmbuffermemorylimit) | experimental | UpDownCounter | jvm.buffer.pool.name | Maximum memory usage for buffers |
7+
| Metric Name | semconv maturity | Type | Unit | Attributes | Description |
8+
|---------------------------------------------------------------------------------------------------------------------------------------|:-----------------|---------------|-------------------|---------------------------------------|-----------------------------------------------------|
9+
| [jvm.memory.used](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemoryused) | stable | UpDownCounter | By | jvm.memory.pool.name, jvm.memory.type | Used memory |
10+
| [jvm.memory.committed](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemorycommitted) | stable | UpDownCounter | By | jvm.memory.pool.name, jvm.memory.type | Committed memory |
11+
| [jvm.memory.limit](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemorylimit) | stable | UpDownCounter | By | jvm.memory.pool.name, jvm.memory.type | Max obtainable memory |
12+
| [jvm.memory.init](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemoryinit) | experimental | UpDownCounter | By | jvm.memory.pool.name, jvm.memory.type | Initial memory requested |
13+
| [jvm.memory.used_after_last_gc](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmmemoryused_after_last_gc) | stable | UpDownCounter | By | jvm.memory.pool.name, jvm.memory.type | Memory used after latest GC |
14+
| [jvm.thread.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmthreadcount) | stable | UpDownCounter | {thread} | [^1] | Threads count |
15+
| [jvm.class.loaded](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclassloaded) | stable | Counter | {class} | | Classes loaded since JVM start |
16+
| [jvm.class.unloaded](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclassunloaded) | stable | Counter | {class} | | Classes unloaded since JVM start |
17+
| [jvm.class.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclasscount) | stable | UpDownCounter | {class} | | Classes currently loaded count |
18+
| [jvm.cpu.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcpucount) | stable | UpDownCounter | {cpu} | | Number of CPUs available |
19+
| [jvm.cpu.time](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcputime) | stable | Counter | s | | CPU time used by the process as reported by the JVM |
20+
| [jvm.cpu.recent_utilization](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcpurecent_utilization) | stable | Gauge | 1 | | Recent CPU utilization for process reported by JVM |
21+
| [jvm.file_descriptor.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmfile_descriptorcount) | experimental | UpDownCounter | {file_descriptor} | | Number of open file descriptors |
22+
| [jvm.system.cpu.load_1m](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmsystemcpuload_1m) | experimental | Gauge | {run_queue_item} | | Average CPU load reported by JVM |
23+
| [jvm.system.cpu.recent_utilization](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcpurecent_utilization) | experimental | Gauge | 1 | | Recent CPU utilization reported by JVM |
24+
| [jvm.buffer.memory.used](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmbuffermemoryused) | experimental | UpDownCounter | By | jvm.buffer.pool.name | Memory used by buffers |
25+
| [jvm.buffer.memory.limit](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmbuffermemorylimit) | experimental | UpDownCounter | By | jvm.buffer.pool.name | Maximum memory usage for buffers |
2626

2727
## Limitations and unsupported metrics
2828

‎instrumentation/jmx-metrics/library/tomcat.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
Here is the list of metrics based on MBeans exposed by Tomcat.
44

5-
| Metric Name | Type | Attributes | Description |
6-
|-----------------------------|---------------|-----------------------------------------------------|--------------------------------------------------------|
7-
| tomcat.session.active.count | UpDownCounter | tomcat.context | The number of currently active sessions. |
8-
| tomcat.session.active.limit | UpDownCounter | tomcat.context | Maximum possible number of active sessions. |
9-
| tomcat.error.count | Counter | tomcat.request.processor.name | The number of errors. |
10-
| tomcat.request.count | Counter | tomcat.request.processor.name | The number of requests processed. |
11-
| tomcat.request.duration.max | Gauge | tomcat.request.processor.name | The longest request processing time. |
12-
| tomcat.request.duration.sum | Counter | tomcat.request.processor.name | Total time of processing all requests. |
13-
| tomcat.network.io | Counter | tomcat.request.processor.name, network.io.direction | The number of bytes transmitted. |
14-
| tomcat.thread.count | UpDownCounter | tomcat.thread.pool.name | Total thread count of the thread pool. |
15-
| tomcat.thread.limit | UpDownCounter | tomcat.thread.pool.name | Maximum possible number of threads in the thread pool. |
16-
| tomcat.thread.busy.count | UpDownCounter | tomcat.thread.pool.name | Number of busy threads in the thread pool. |
5+
| Metric Name | Type | Unit | Attributes | Description |
6+
|-----------------------------|---------------|-----------|-----------------------------------------------------|--------------------------------------------------------|
7+
| tomcat.session.active.count | UpDownCounter | {session} | tomcat.context | The number of currently active sessions. |
8+
| tomcat.session.active.limit | UpDownCounter | {session} | tomcat.context | Maximum possible number of active sessions. |
9+
| tomcat.error.count | Counter | {error} | tomcat.request.processor.name | The number of errors. |
10+
| tomcat.request.count | Counter | {request} | tomcat.request.processor.name | The number of requests processed. |
11+
| tomcat.request.duration.max | Gauge | s | tomcat.request.processor.name | The longest request processing time. |
12+
| tomcat.request.duration.sum | Counter | s | tomcat.request.processor.name | Total time of processing all requests. |
13+
| tomcat.network.io | Counter | By | tomcat.request.processor.name, network.io.direction | The number of bytes transmitted. |
14+
| tomcat.thread.count | UpDownCounter | {thread} | tomcat.thread.pool.name | Total thread count of the thread pool. |
15+
| tomcat.thread.limit | UpDownCounter | {thread} | tomcat.thread.pool.name | Maximum possible number of threads in the thread pool. |
16+
| tomcat.thread.busy.count | UpDownCounter | {thread} | tomcat.thread.pool.name | Number of busy threads in the thread pool. |

0 commit comments

Comments
 (0)