diff --git a/instrumentation/jmx-metrics/library/jetty.md b/instrumentation/jmx-metrics/library/jetty.md index 0a5d2fb5d655..a0b9c5a9bd30 100644 --- a/instrumentation/jmx-metrics/library/jetty.md +++ b/instrumentation/jmx-metrics/library/jetty.md @@ -10,15 +10,15 @@ The metrics captured and their respective attributes depend on the Jetty version 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`. -| Metric Name | Type | Attributes | Description | -|-------------------------|---------------|---------------|-------------------------------------------| -| jetty.thread.count | UpDownCounter | | The current number of threads | -| jetty.thread.limit | UpDownCounter | | The maximum number of threads in the pool | -| jetty.thread.busy.count | UpDownCounter | | The current number of busy threads | -| jetty.thread.idle.count | UpDownCounter | | The current number of idle threads | -| jetty.thread.queue.size | UpDownCounter | | The current job queue size | -| jetty.io.select.count | Counter | | The number of select calls | -| jetty.session.count | UpDownCounter | jetty.context | Current number of active sessions | +| Metric Name | Type | Unit | Attributes | Description | +|-------------------------|---------------|-------------|---------------|-------------------------------------------| +| jetty.thread.count | UpDownCounter | {thread} | | The current number of threads | +| jetty.thread.limit | UpDownCounter | {thread} | | The maximum number of threads in the pool | +| jetty.thread.busy.count | UpDownCounter | {thread} | | The current number of busy threads | +| jetty.thread.idle.count | UpDownCounter | {thread} | | The current number of idle threads | +| jetty.thread.queue.size | UpDownCounter | {thread} | | The current job queue size | +| jetty.io.select.count | Counter | {operation} | | The number of select calls | +| jetty.session.count | UpDownCounter | {session} | jetty.context | Current number of active sessions | - `jetty.context` corresponds to the deployed application subfolder in `webapps` folder. @@ -26,15 +26,15 @@ Those metrics require the following Jetty modules to be enabled : `jmx`, `http`, Those metrics require the following Jetty modules to be enabled : `jmx`, `http` and `stats`. -| Metric Name | Type | Attributes | Description | -|-----------------------------|---------------|---------------|-------------------------------------------| -| jetty.thread.count | UpDownCounter | | The current number of threads | -| jetty.thread.limit | UpDownCounter | | The maximum number of threads in the pool | -| jetty.thread.busy.count | UpDownCounter | | The current number of busy threads | -| jetty.thread.idle.count | UpDownCounter | | The current number of idle threads | -| jetty.thread.queue.size | UpDownCounter | | The current job queue size | -| jetty.io.select.count | Counter | | The number of select calls | -| jetty.session.created.count | Counter | jetty.context | The total number of created sessions | -| jetty.session.duration.sum | Counter | jetty.context | The cumulated session duration | +| Metric Name | Type | Unit | Attributes | Description | +|-----------------------------|---------------|-------------|---------------|-------------------------------------------| +| jetty.thread.count | UpDownCounter | {thread} | | The current number of threads | +| jetty.thread.limit | UpDownCounter | {thread} | | The maximum number of threads in the pool | +| jetty.thread.busy.count | UpDownCounter | {thread} | | The current number of busy threads | +| jetty.thread.idle.count | UpDownCounter | {thread} | | The current number of idle threads | +| jetty.thread.queue.size | UpDownCounter | {thread} | | The current job queue size | +| jetty.io.select.count | Counter | {operation} | | The number of select calls | +| jetty.session.created.count | Counter | {session} | jetty.context | The total number of created sessions | +| jetty.session.duration.sum | Counter | {session} | jetty.context | The cumulated session duration | - `jetty.context` corresponds to the deployed application subfolder in `webapps` folder. diff --git a/instrumentation/jmx-metrics/library/jvm.md b/instrumentation/jmx-metrics/library/jvm.md index 6a67222ac1fa..b8f1cbb8577f 100644 --- a/instrumentation/jmx-metrics/library/jvm.md +++ b/instrumentation/jmx-metrics/library/jvm.md @@ -4,25 +4,25 @@ Here is the list of metrics based on MBeans exposed by the JVM and that are defi Those metrics are defined in the [JVM runtime metrics semantic conventions](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/). -| Metric Name | semconv maturity | Type | Attributes | Description | -|---------------------------------------------------------------------------------------------------------------------------------------|:-----------------|---------------|---------------------------------------|-----------------------------------------------------| -| [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 | -| [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 | -| [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 | -| [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 | -| [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 | -| [jvm.thread.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmthreadcount) | stable | UpDownCounter | [^1] | Threads count | -| [jvm.class.loaded](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclassloaded) | stable | Counter | | Classes loaded since JVM start | -| [jvm.class.unloaded](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclassunloaded) | stable | Counter | | Classes unloaded since JVM start | -| [jvm.class.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclasscount) | stable | UpDownCounter | | Classes currently loaded count | -| [jvm.cpu.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcpucount) | stable | UpDownCounter | | Number of CPUs available | -| [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 | -| [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 | -| [jvm.file_descriptor.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmfile_descriptorcount) | experimental | UpDownCounter | | Number of open file descriptors | -| [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 | -| [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 | -| [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 | -| [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 | +| Metric Name | semconv maturity | Type | Unit | Attributes | Description | +|---------------------------------------------------------------------------------------------------------------------------------------|:-----------------|---------------|-------------------|---------------------------------------|-----------------------------------------------------| +| [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 | +| [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 | +| [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 | +| [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 | +| [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 | +| [jvm.thread.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmthreadcount) | stable | UpDownCounter | {thread} | [^1] | Threads count | +| [jvm.class.loaded](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclassloaded) | stable | Counter | {class} | | Classes loaded since JVM start | +| [jvm.class.unloaded](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclassunloaded) | stable | Counter | {class} | | Classes unloaded since JVM start | +| [jvm.class.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmclasscount) | stable | UpDownCounter | {class} | | Classes currently loaded count | +| [jvm.cpu.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcpucount) | stable | UpDownCounter | {cpu} | | Number of CPUs available | +| [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 | +| [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 | +| [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 | +| [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 | +| [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 | +| [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 | +| [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 | ## Limitations and unsupported metrics diff --git a/instrumentation/jmx-metrics/library/tomcat.md b/instrumentation/jmx-metrics/library/tomcat.md index 9738ad9ed71a..2c0b3499c42a 100644 --- a/instrumentation/jmx-metrics/library/tomcat.md +++ b/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 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. | +| Metric Name | Type | Unit | Attributes | Description | +|-----------------------------|---------------|-----------|-----------------------------------------------------|--------------------------------------------------------| +| tomcat.session.active.count | UpDownCounter | {session} | tomcat.context | The number of currently active sessions. | +| tomcat.session.active.limit | UpDownCounter | {session} | tomcat.context | Maximum possible number of active sessions. | +| tomcat.error.count | Counter | {error} | tomcat.request.processor.name | The number of errors. | +| tomcat.request.count | Counter | {request} | tomcat.request.processor.name | The number of requests processed. | +| tomcat.request.duration.max | Gauge | s | tomcat.request.processor.name | The longest request processing time. | +| tomcat.request.duration.sum | Counter | s | tomcat.request.processor.name | Total time of processing all requests. | +| tomcat.network.io | Counter | By | tomcat.request.processor.name, network.io.direction | The number of bytes transmitted. | +| tomcat.thread.count | UpDownCounter | {thread} | tomcat.thread.pool.name | Total thread count of the thread pool. | +| tomcat.thread.limit | UpDownCounter | {thread} | tomcat.thread.pool.name | Maximum possible number of threads in the thread pool. | +| tomcat.thread.busy.count | UpDownCounter | {thread} | tomcat.thread.pool.name | Number of busy threads in the thread pool. | diff --git a/instrumentation/jmx-metrics/library/wildfly.md b/instrumentation/jmx-metrics/library/wildfly.md index 1bc42f0f26a2..3ead13fdc8fa 100644 --- a/instrumentation/jmx-metrics/library/wildfly.md +++ b/instrumentation/jmx-metrics/library/wildfly.md @@ -2,20 +2,20 @@ Here is the list of metrics based on MBeans exposed by Wildfly. -| Metric Name | Type | Attributes | Description | -|-----------------------------------------|---------------|------------------------------------------------------------|-----------------------------------------------------------------| -| wildfly.network.io | Counter | wildfly.server, wildfly.listener, network.io.direction | Total number of bytes transferred | -| wildfly.error.count | Counter | wildfly.server, wildfly.listener | The number of requests that have resulted in a 5xx response | -| wildfly.request.count | Counter | wildfly.server, wildfly.listener | The number of requests served | -| wildfly.request.duration.sum | Counter | wildfly.server, wildfly.listener | The total amount of time spent processing requests | -| wildfly.session.expired | Counter | wildfly.deployment | The number of expired sessions | -| wildfly.session.rejected | Counter | wildfly.deployment | The number of rejected sessions | -| wildfly.session.created | Counter | wildfly.deployment | The number of sessions created | -| wildfly.session.active.count | UpDownCounter | wildfly.deployment | The number of active sessions | -| wildfly.session.active.limit | UpDownCounter | wildfly.deployment | The maximum supported number of active sessions | -| wildfly.db.client.connection.count | UpDownCounter | db.client.connection.pool.name, db.client.connection.state | The number of open physical database connections | -| wildfly.db.client.connection.wait.count | Counter | db.client.connection.pool.name | The number of connection requests that had to wait to obtain it | -| wildfly.transaction.count | UpDownCounter | | The number of in-flight transactions | -| wildfly.transaction.created | Counter | | The total number of transactions created | -| wildfly.transaction.committed | Counter | | The total number of transactions committed | -| wildfly.transaction.rollback | Counter | wildfly.rollback.cause | The total number of transactions rolled back | +| Metric Name | Type | Unit | Attributes | Description | +|-----------------------------------------|---------------|---------------|------------------------------------------------------------|-----------------------------------------------------------------| +| wildfly.network.io | Counter | By | wildfly.server, wildfly.listener, network.io.direction | Total number of bytes transferred | +| wildfly.error.count | Counter | {error} | wildfly.server, wildfly.listener | The number of requests that have resulted in a 5xx response | +| wildfly.request.count | Counter | {request} | wildfly.server, wildfly.listener | The number of requests served | +| wildfly.request.duration.sum | Counter | s | wildfly.server, wildfly.listener | The total amount of time spent processing requests | +| wildfly.session.expired | Counter | {session} | wildfly.deployment | The number of expired sessions | +| wildfly.session.rejected | Counter | {session} | wildfly.deployment | The number of rejected sessions | +| wildfly.session.created | Counter | {session} | wildfly.deployment | The number of sessions created | +| wildfly.session.active.count | UpDownCounter | {session} | wildfly.deployment | The number of active sessions | +| wildfly.session.active.limit | UpDownCounter | {session} | wildfly.deployment | The maximum supported number of active sessions | +| wildfly.db.client.connection.count | UpDownCounter | {connection} | db.client.connection.pool.name, db.client.connection.state | The number of open physical database connections | +| wildfly.db.client.connection.wait.count | Counter | {request} | db.client.connection.pool.name | The number of connection requests that had to wait to obtain it | +| wildfly.transaction.count | UpDownCounter | {transaction} | | The number of in-flight transactions | +| wildfly.transaction.created | Counter | {transaction} | | The total number of transactions created | +| wildfly.transaction.committed | Counter | {transaction} | | The total number of transactions committed | +| wildfly.transaction.rollback | Counter | {transaction} | wildfly.rollback.cause | The total number of transactions rolled back |