Skip to content

Commit

Permalink
[receiver/aerospikereceiver] Add query metrics (#13295)
Browse files Browse the repository at this point in the history
Add query_count and query_json metrics. Useful for tracking query transactions.
  • Loading branch information
dwelch-spike committed Aug 17, 2022
1 parent f8f3237 commit 5fbe993
Show file tree
Hide file tree
Showing 6 changed files with 2,051 additions and 945 deletions.
9 changes: 9 additions & 0 deletions receiver/aerospikereceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,19 @@ These are the metrics available for this scraper.
| Name | Description | Unit | Type | Attributes |
| ---- | ----------- | ---- | ---- | ---------- |
| **aerospike.namespace.disk.available** | Minimum percentage of contiguous disk space free to the namespace across all devices | % | Gauge(Int) | <ul> </ul> |
| **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. | {cells} | Sum(Int) | <ul> </ul> |
| **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_regio_query_falspos. | {points} | Sum(Int) | <ul> </ul> |
| **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. | {points} | Sum(Int) | <ul> </ul> |
| **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. | {queries} | Sum(Int) | <ul> </ul> |
| **aerospike.namespace.memory.free** | Percentage of the namespace's memory which is still free Aerospike metric memory_free_pct | % | Gauge(Int) | <ul> </ul> |
| **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 | By | Sum(Int) | <ul> <li>namespace_component</li> </ul> |
| **aerospike.namespace.query.count** | 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 | {queries} | Sum(Int) | <ul> <li>query_type</li> <li>index_type</li> <li>query_result</li> </ul> |
| **aerospike.namespace.scan.count** | 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 | {scans} | Sum(Int) | <ul> <li>scan_type</li> <li>scan_result</li> </ul> |
| **aerospike.namespace.transaction.count** | 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 | {transactions} | Sum(Int) | <ul> <li>transaction_type</li> <li>transaction_result</li> </ul> |
| **aerospike.node.connection.count** | 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 | {connections} | Sum(Int) | <ul> <li>connection_type</li> <li>connection_op</li> </ul> |
| **aerospike.node.connection.open** | Current number of open connections to the node Aggregate of Aerospike Metrics client_connections, fabric_connections, heartbeat_connections | {connections} | Sum(Int) | <ul> <li>connection_type</li> </ul> |
| **aerospike.node.memory.free** | Percentage of the node's memory which is still free Aerospike Metric system_free_mem_pct | % | Gauge(Int) | <ul> </ul> |
| **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 | | Sum(Int) | <ul> </ul> |

**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default.
Any metric can be enabled or disabled with the following scraper configuration:
Expand All @@ -39,7 +45,10 @@ metrics:
| ---- | ----------- | ------ |
| connection_op (operation) | Operation performed with a connection (open or close) | close, open |
| connection_type (type) | Type of connection to an Aerospike node | client, fabric, heartbeat |
| index_type (index) | Type of index the operation was performed on | primary, secondary |
| namespace_component (component) | Individual component of a namespace | data, index, set_index, secondary_index |
| query_result (result) | Result of a query operation performed on a namespace | abort, complete, error, timeout |
| query_type (type) | Type of query operation performed on a namespace | aggregation, basic, short, long_basic, short_basic, ops_background, udf_background |
| scan_result (result) | Result of a scan operation performed on a namespace | abort, complete, error |
| scan_type (type) | Type of scan operation performed on a namespace | aggregation, basic, ops_background, udf_background |
| transaction_result (result) | Result of a transaction performed on a namespace | error, filtered_out, not_found, success, timeout |
Expand Down
Loading

0 comments on commit 5fbe993

Please sign in to comment.