---
title: "JMS Metrics Reference"
description: "Reference guide for Aerospike JMS Connector metrics, covering inbound/outbound connections and JVM performance."
---

# JMS Metrics Reference

> For the complete documentation index see: [llms.txt](https://aerospike.com/docs/llms.txt)
> 
> All documentation pages available in markdown.

Metrics reference for the JMS Connector

## Inbound

#### `consumer`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_consumer`

Description: Count of active consumers for the given JMS destination.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_namestatus=activesource

---

#### `jms_connections`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jms_connections`

Description: Count of active or closed connections to the JMS broker.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_namestatus=activestatus=closed

---

#### `jvm_attribute_uptime`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_attribute_uptime`

Description: Uptime of the Java virtual machine in milliseconds.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

---

#### `jvm_buffers_direct_capacity`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_buffers_direct_capacity`

Description: Total capacity in bytes of the buffers in the JVM direct buffer pool.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_buffers\_direct\_count](#inbound__jvm_buffers_direct_count)[jvm\_buffers\_direct\_used](#inbound__jvm_buffers_direct_used)

---

#### `jvm_buffers_direct_count`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_buffers_direct_count`

Description: Number of direct buffers currently allocated by the connector.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_buffers\_direct\_capacity](#inbound__jvm_buffers_direct_capacity)[jvm\_buffers\_direct\_used](#inbound__jvm_buffers_direct_used)

---

#### `jvm_buffers_direct_used`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_buffers_direct_used`

Description: Memory in bytes that the Java Virtual Machine is using for the direct buffer pool.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_buffers\_direct\_capacity](#inbound__jvm_buffers_direct_capacity)[jvm\_buffers\_direct\_count](#inbound__jvm_buffers_direct_count)

---

#### `jvm_files_max`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_files_max`

Description: Maximum number of file descriptors.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_files\_open](#inbound__jvm_files_open)

---

#### `jvm_files_open`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_files_open`

Description: Number of open file descriptors.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_files\_max](#inbound__jvm_files_max)

---

#### `jvm_gc_count`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_gc_count`

Description: Total number of collections that have occurred for the `Old Generation` or the `Young Generation`. Name of a GC may differ.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_namegc

Related: [jvm\_gc\_time](#inbound__jvm_gc_time)

---

#### `jvm_gc_time`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_gc_time`

Description: Approximate accumulated collection elapsed time in milliseconds for the `Old Generation` or `Young Generation` GC.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_namegc

Related: [jvm\_gc\_count](#inbound__jvm_gc_count)

---

#### `jvm_memory_heap_max`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_memory_heap_max`

Description: Maximum amount of `heap` memory in bytes that can be used by the Java Virtual Machine.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_memory\_heap\_used](#inbound__jvm_memory_heap_used)[jvm\_memory\_non\_heap\_used](#inbound__jvm_memory_non_heap_used)[jvm\_memory\_total\_max](#inbound__jvm_memory_total_max)[jvm\_memory\_total\_used](#inbound__jvm_memory_total_used)

---

#### `jvm_memory_heap_used`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_memory_heap_used`

Description: Amount of used `heap` memory in bytes.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_memory\_heap\_max](#inbound__jvm_memory_heap_max)[jvm\_memory\_non\_heap\_used](#inbound__jvm_memory_non_heap_used)[jvm\_memory\_total\_max](#inbound__jvm_memory_total_max)[jvm\_memory\_total\_used](#inbound__jvm_memory_total_used)

---

#### `jvm_memory_non_heap_used`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_memory_non_heap_used`

Description: Amount of used `non-heap` memory in bytes.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_memory\_heap\_max](#inbound__jvm_memory_heap_max)[jvm\_memory\_heap\_used](#inbound__jvm_memory_heap_used)[jvm\_memory\_total\_max](#inbound__jvm_memory_total_max)[jvm\_memory\_total\_used](#inbound__jvm_memory_total_used)

---

#### `jvm_memory_total_max`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_memory_total_max`

Description: Maximum amount of `heap` and `non-heap` memory in bytes that can be used by the Java Virtual Machine. The value is `-1` when the maximum `non-heap` memory is undefined.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_memory\_heap\_max](#inbound__jvm_memory_heap_max)[jvm\_memory\_heap\_used](#inbound__jvm_memory_heap_used)[jvm\_memory\_non\_heap\_used](#inbound__jvm_memory_non_heap_used)[jvm\_memory\_total\_used](#inbound__jvm_memory_total_used)

---

#### `jvm_memory_total_used`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_memory_total_used`

Description: Amount of used `heap` and `non-heap` memory in bytes.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

Related: [jvm\_memory\_heap\_max](#inbound__jvm_memory_heap_max)[jvm\_memory\_heap\_used](#inbound__jvm_memory_heap_used)[jvm\_memory\_non\_heap\_used](#inbound__jvm_memory_non_heap_used)[jvm\_memory\_total\_max](#inbound__jvm_memory_total_max)

---

#### `jvm_os_processCpuLoad`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_os_processCpuLoad`

Description: The `recent CPU usage` for the Java Virtual Machine process.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `decimal`

Labels: cluster\_name

Related: [jvm\_os\_systemCpuLoad](#inbound__jvm_os_systemCpuLoad)

---

#### `jvm_os_systemCpuLoad`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_os_systemCpuLoad`

Description: The `recent CPU usage` for the whole system.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `decimal`

Labels: cluster\_name

Related: [jvm\_os\_processCpuLoad](#inbound__jvm_os_processCpuLoad)

---

#### `jvm_threads_total_count`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_jvm_threads_total_count`

Description: Current number of live threads, including both daemon and non-daemon threads.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_name

---

#### `message`

`watch`

Context: inbound

Prometheus Name: `aerospike_jms_inbound_message`

Description: Count of successfully processed incoming JMS messages and various error conditions.

Introduced: 2.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_namestatus=successstatus=errorcause=aerospike-errorcause=conversion-errorcause=parse-errorsource

Detail:
-   Counts message handling errors which are neither parsing nor conversion errors.
-   Counts errors which occurred while converting JMS message to an Aerospike message.
-   Counts errors which occurred while parsing an incoming JMS message.

---

## Outbound

#### `connections`

`watch`

Context: outbound

Prometheus Name: `aerospike_jms_outbound_connections`

Description: Count of active or closed XDR connections to the outbound connector.

Introduced: 3.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_namestatus=activestatus=closed

---

#### `jms_connections`

`watch`

Context: outbound

Prometheus Name: `aerospike_jms_outbound_jms_connections`

Description: Count of active or closed connections to the JMS broker.

Introduced: 3.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_namestatus=activestatus=closed

---

#### `requests`

`watch`

Context: outbound

Prometheus Name: `aerospike_jms_outbound_requests`

Description: Count of XDR records handled by the connector, by `status`. `success` counts records written to the external system. `error` counts records that failed, including records that were skipped or could not be parsed. `parse-error` counts records that could not be parsed. `skipped` counts records that were not written. `queued` counts requests that are queued or in flight.

Introduced: 3.0

Removed: \-

Measurement type: `gauge`

Data type: `integer`

Labels: cluster\_namestatus=errorstatus=parse-errorstatus=queuedstatus=skippedstatus=success

---