Skip to content
84 changes: 42 additions & 42 deletions receiver/aerospikereceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,69 +16,69 @@ metrics:

Minimum percentage of contiguous disk space free to the namespace across all devices

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Int |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| % | Gauge | Int | development |

### aerospike.namespace.geojson.region_query_cells

Number of cell coverings for query region queried

Number of cell coverings for query region queried. Aerospike metric geo_region_query_cells.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {cells} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {cells} | Sum | Int | Cumulative | true | development |

### aerospike.namespace.geojson.region_query_false_positive

Number of points outside the region.

Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_region_query_falsepos.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {points} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {points} | Sum | Int | Cumulative | true | development |

### aerospike.namespace.geojson.region_query_points

Number of points within the region.

Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_region_query_points.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {points} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {points} | Sum | Int | Cumulative | true | development |

### aerospike.namespace.geojson.region_query_requests

Number of geojson queries on the system since the uptime of the node.

Number of geojson queries on the system since the uptime of the node. Aerospike metric geo_region_query_reqs.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {queries} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {queries} | Sum | Int | Cumulative | true | development |

### aerospike.namespace.memory.free

Percentage of the namespace's memory which is still free

Aerospike metric memory_free_pct

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Int |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| % | Gauge | Int | development |

### aerospike.namespace.memory.usage

Memory currently used by each component of the namespace

Aggregate of Aerospike Metrics memory_used_data_bytes, memory_used_index_bytes, memory_used_set_index_bytes, memory_used_sindex_bytes

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By | Sum | Int | Cumulative | false |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| By | Sum | Int | Cumulative | false | development |

#### Attributes

Expand All @@ -92,9 +92,9 @@ Number of query operations performed on the namespace

Aggregate of Aerospike Metrics query_aggr_abort, query_aggr_complete, query_aggr_error, query_basic_abort, query_basic_complete, query_basic_error, query_ops_bg_abort, query_ops_bg_complete, query_ops_bg_error, query_udf_bg_abort, query_udf_bg_complete, query_udf_bg_error, pi_query_aggr_abort, pi_query_aggr_complete, pi_query_aggr_error, pi_query_long_basic_abort, pi_query_long_basic_complete, pi_query_long_basic_error, pi_query_ops_bg_abort, pi_query_ops_bg_basic_complete, pi_query_ops_bg_basic_error, pi_query_short_basic_timeout, pi_query_short_basic_complete, pi_query_short_basic_error, pi_query_udf_bg_abort, pi_query_udf_bg_complete, pi_query_udf_bg_error, si_query_aggr_abort, si_query_aggr_complete, si_query_aggr_error, si_query_long_basic_abort, si_query_long_basic_complete, si_query_long_basic_error, si_query_ops_bg_abort, si_query_ops_bg_basic_complete, si_query_ops_bg_basic_error, si_query_short_basic_timeout, si_query_short_basic_complete, si_query_short_basic_error, si_query_udf_bg_abort, si_query_udf_bg_complete, si_query_udf_bg_error

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {queries} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {queries} | Sum | Int | Cumulative | true | development |

#### Attributes

Expand All @@ -110,9 +110,9 @@ Number of scan operations performed on the namespace

Aggregate of Aerospike Metrics scan_aggr_abort, scan_aggr_complete, scan_aggr_error, scan_basic_abort, scan_basic_complete, scan_basic_error, scan_ops_bg_abort, scan_ops_bg_complete, scan_ops_bg_error, scan_udf_bg_abort, scan_udf_bg_complete, scan_udf_bg_error

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {scans} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {scans} | Sum | Int | Cumulative | true | development |

#### Attributes

Expand All @@ -127,9 +127,9 @@ Number of transactions performed on the namespace

Aggregate of Aerospike Metrics client_delete_error, client_delete_filtered_out, client_delete_not_found, client_delete_success, client_delete_timeout, client_read_error, client_read_filtered_out, client_read_not_found, client_read_success, client_read_timeout, client_udf_error, client_udf_filtered_out, client_udf_not_found, client_udf_success, client_udf_timeout, client_write_error, client_write_filtered_out, client_write_not_found, client_write_success, client_write_timeout

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {transactions} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {transactions} | Sum | Int | Cumulative | true | development |

#### Attributes

Expand All @@ -144,9 +144,9 @@ Number of connections opened and closed to the node

Aggregate of Aerospike Metrics client_connections_closed, client_connections_opened, fabric_connections_closed, fabric_connections_opened, heartbeat_connections_closed, heartbeat_connections_opened

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {connections} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {connections} | Sum | Int | Cumulative | true | development |

#### Attributes

Expand All @@ -161,9 +161,9 @@ Current number of open connections to the node

Aggregate of Aerospike Metrics client_connections, fabric_connections, heartbeat_connections

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {connections} | Sum | Int | Cumulative | false |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {connections} | Sum | Int | Cumulative | false | development |

#### Attributes

Expand All @@ -177,19 +177,19 @@ Percentage of the node's memory which is still free

Aerospike Metric system_free_mem_pct

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Int |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| % | Gauge | Int | development |

### aerospike.node.query.tracked

Number of queries tracked by the system.

Number of queries which ran more than query untracked_time (default 1 sec), Aerospike metric query_tracked

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {queries} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {queries} | Sum | Int | Cumulative | true | development |

## Resource Attributes

Expand Down
28 changes: 28 additions & 0 deletions receiver/aerospikereceiver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ metrics:
aerospike.node.memory.free:
enabled: true
description: Percentage of the node's memory which is still free
stability:
level: development
extended_documentation: Aerospike Metric system_free_mem_pct
unit: '%'
gauge:
Expand All @@ -129,6 +131,8 @@ metrics:
aerospike.node.connection.count:
enabled: true
description: Number of connections opened and closed to the node
stability:
level: development
extended_documentation: Aggregate of Aerospike Metrics client_connections_closed, client_connections_opened, fabric_connections_closed, fabric_connections_opened, heartbeat_connections_closed, heartbeat_connections_opened
unit: '{connections}'
attributes: [connection_type, connection_op]
Expand All @@ -140,6 +144,8 @@ metrics:
aerospike.node.connection.open:
enabled: true
description: Current number of open connections to the node
stability:
level: development
extended_documentation: Aggregate of Aerospike Metrics client_connections, fabric_connections, heartbeat_connections
unit: '{connections}'
attributes: [connection_type]
Expand All @@ -151,6 +157,8 @@ metrics:
aerospike.node.query.tracked:
enabled: true
description: Number of queries tracked by the system.
stability:
level: development
extended_documentation: Number of queries which ran more than query untracked_time (default 1 sec), Aerospike metric query_tracked
unit: '{queries}'
sum:
Expand All @@ -161,6 +169,8 @@ metrics:
aerospike.namespace.memory.usage:
enabled: true
description: Memory currently used by each component of the namespace
stability:
level: development
extended_documentation: Aggregate of Aerospike Metrics memory_used_data_bytes, memory_used_index_bytes, memory_used_set_index_bytes, memory_used_sindex_bytes
unit: By
attributes: [namespace_component]
Expand All @@ -172,6 +182,8 @@ metrics:
aerospike.namespace.memory.free:
enabled: true
description: Percentage of the namespace's memory which is still free
stability:
level: development
extended_documentation: Aerospike metric memory_free_pct
unit: '%'
gauge:
Expand All @@ -180,13 +192,17 @@ metrics:
aerospike.namespace.disk.available:
enabled: true
description: Minimum percentage of contiguous disk space free to the namespace across all devices
stability:
level: development
unit: '%'
gauge:
value_type: int
input_type: string
aerospike.namespace.scan.count:
enabled: true
description: Number of scan operations performed on the namespace
stability:
level: development
unit: '{scans}'
extended_documentation: Aggregate of Aerospike Metrics scan_aggr_abort, scan_aggr_complete, scan_aggr_error, scan_basic_abort, scan_basic_complete, scan_basic_error, scan_ops_bg_abort, scan_ops_bg_complete, scan_ops_bg_error, scan_udf_bg_abort, scan_udf_bg_complete, scan_udf_bg_error
attributes: [scan_type, scan_result]
Expand All @@ -198,6 +214,8 @@ metrics:
aerospike.namespace.query.count:
enabled: true
description: Number of query operations performed on the namespace
stability:
level: development
unit: '{queries}'
extended_documentation: Aggregate of Aerospike Metrics query_aggr_abort, query_aggr_complete, query_aggr_error, query_basic_abort, query_basic_complete, query_basic_error, query_ops_bg_abort, query_ops_bg_complete, query_ops_bg_error, query_udf_bg_abort, query_udf_bg_complete, query_udf_bg_error, pi_query_aggr_abort, pi_query_aggr_complete, pi_query_aggr_error, pi_query_long_basic_abort, pi_query_long_basic_complete, pi_query_long_basic_error, pi_query_ops_bg_abort, pi_query_ops_bg_basic_complete, pi_query_ops_bg_basic_error, pi_query_short_basic_timeout, pi_query_short_basic_complete, pi_query_short_basic_error, pi_query_udf_bg_abort, pi_query_udf_bg_complete, pi_query_udf_bg_error, si_query_aggr_abort, si_query_aggr_complete, si_query_aggr_error, si_query_long_basic_abort, si_query_long_basic_complete, si_query_long_basic_error, si_query_ops_bg_abort, si_query_ops_bg_basic_complete, si_query_ops_bg_basic_error, si_query_short_basic_timeout, si_query_short_basic_complete, si_query_short_basic_error, si_query_udf_bg_abort, si_query_udf_bg_complete, si_query_udf_bg_error
attributes: [query_type, index_type, query_result]
Expand All @@ -209,6 +227,8 @@ metrics:
aerospike.namespace.geojson.region_query_cells:
enabled: true
description: Number of cell coverings for query region queried
stability:
level: development
unit: '{cells}'
extended_documentation: Number of cell coverings for query region queried. Aerospike metric geo_region_query_cells.
sum:
Expand All @@ -219,6 +239,8 @@ metrics:
aerospike.namespace.geojson.region_query_false_positive:
enabled: true
description: Number of points outside the region.
stability:
level: development
unit: '{points}'
extended_documentation: Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_region_query_falsepos.
sum:
Expand All @@ -229,6 +251,8 @@ metrics:
aerospike.namespace.geojson.region_query_points:
enabled: true
description: Number of points within the region.
stability:
level: development
unit: '{points}'
extended_documentation: Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_region_query_points.
sum:
Expand All @@ -239,6 +263,8 @@ metrics:
aerospike.namespace.geojson.region_query_requests:
enabled: true
description: Number of geojson queries on the system since the uptime of the node.
stability:
level: development
unit: '{queries}'
extended_documentation: Number of geojson queries on the system since the uptime of the node. Aerospike metric geo_region_query_reqs.
sum:
Expand All @@ -249,6 +275,8 @@ metrics:
aerospike.namespace.transaction.count:
enabled: true
description: Number of transactions performed on the namespace
stability:
level: development
unit: '{transactions}'
extended_documentation: Aggregate of Aerospike Metrics client_delete_error, client_delete_filtered_out, client_delete_not_found, client_delete_success, client_delete_timeout, client_read_error, client_read_filtered_out, client_read_not_found, client_read_success, client_read_timeout, client_udf_error, client_udf_filtered_out, client_udf_not_found, client_udf_success, client_udf_timeout, client_write_error, client_write_filtered_out, client_write_not_found, client_write_success, client_write_timeout
attributes: [transaction_type, transaction_result]
Expand Down
Loading