type: aerospike

status:
  class: receiver
  stability:
    alpha: [metrics]
  distributions: [contrib, observiq, sumo]
  codeowners:
    active: [djaglowski, antonblock]

resource_attributes:
  aerospike.node.name:
    description: Name of the Aerospike node collected from
    enabled: true
    type: string
  aerospike.namespace:
    description: Name of the Aerospike namespace
    enabled: true
    type: string

attributes:
  namespace_component:
    name_override: component
    description: Individual component of a namespace
    type: string
    enum:
      - data
      - index
      - set_index
      - secondary_index
  scan_type:
    name_override: type
    description: Type of scan operation performed on a namespace
    type: string
    enum:
      - aggregation
      - basic
      - ops_background
      - udf_background
  scan_result:
    name_override: result
    description: Result of a scan operation performed on a namespace
    type: string
    enum:
      - abort
      - complete
      - error
  index_type:
    name_override: index
    description: Type of index the operation was performed on
    type: string
    enum:
      - primary
      - secondary
  query_type:
    name_override: type
    description: Type of query operation performed on a namespace
    type: string
    enum:
      - aggregation
      - basic
      - short
      - long_basic
      - short_basic
      - ops_background
      - udf_background
  query_result:
    name_override: result
    description: Result of a query operation performed on a namespace
    type: string
    enum:
      - abort
      - complete
      - error
      - timeout # short_basic queries only
  transaction_type:
    name_override: type
    description: Type of transaction performed on a namespace
    type: string
    enum:
      - delete
      - read
      - udf
      - write
  transaction_result:
    name_override: result
    description: Result of a transaction performed on a namespace
    type: string
    enum:
      - error
      - filtered_out
      - not_found
      - success
      - timeout
  connection_type:
    name_override: type
    description: Type of connection to an Aerospike node
    type: string
    enum:
      - client
      - fabric
      - heartbeat
  connection_op:
    name_override: operation
    description: Operation performed with a connection (open or close)
    type: string
    enum:
      - close
      - open

metrics:
  aerospike.node.memory.free:
    enabled: true
    description: Percentage of the node's memory which is still free
    extended_documentation: Aerospike Metric system_free_mem_pct
    unit: '%'
    gauge:
      value_type: int
      input_type: string
  aerospike.node.connection.count:
    enabled: true
    description: Number of connections opened and closed to the node
    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]
    sum:
      value_type: int
      input_type: string
      monotonic: true
      aggregation_temporality: cumulative
  aerospike.node.connection.open:
    enabled: true
    description: Current number of open connections to the node
    extended_documentation: Aggregate of Aerospike Metrics client_connections, fabric_connections, heartbeat_connections
    unit: '{connections}'
    attributes: [connection_type]
    sum:
      value_type: int
      input_type: string
      monotonic: false
      aggregation_temporality: cumulative
  aerospike.node.query.tracked:
    enabled: true
    description: Number of queries tracked by the system.
    extended_documentation: Number of queries which ran more than query untracked_time (default 1 sec), Aerospike metric query_tracked
    unit: '{queries}'
    sum:
      value_type: int
      input_type: string
      monotonic: true
      aggregation_temporality: cumulative
  aerospike.namespace.memory.usage:
    enabled: true
    description: Memory currently used by each component of the namespace
    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]
    sum:
      value_type: int
      input_type: string
      monotonic: false
      aggregation_temporality: cumulative
  aerospike.namespace.memory.free:
    enabled: true
    description: Percentage of the namespace's memory which is still free
    extended_documentation: Aerospike metric memory_free_pct
    unit: '%'
    gauge:
      value_type: int
      input_type: string
  aerospike.namespace.disk.available:
    enabled: true
    description: Minimum percentage of contiguous disk space free to the namespace across all devices
    unit: '%'
    gauge:
      value_type: int
      input_type: string
  aerospike.namespace.scan.count:
    enabled: true
    description: Number of scan operations performed on the namespace
    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]
    sum:
      value_type: int
      input_type: string
      monotonic: true
      aggregation_temporality: cumulative
  aerospike.namespace.query.count:
    enabled: true
    description: Number of query operations performed on the namespace
    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]
    sum:
      value_type: int
      input_type: string
      monotonic: true
      aggregation_temporality: cumulative
  aerospike.namespace.geojson.region_query_cells:
    enabled: true
    description: Number of cell coverings for query region queried
    unit: '{cells}'
    extended_documentation: Number of cell coverings for query region queried. Aerospike metric geo_region_query_cells.
    sum:
      value_type: int
      input_type: string
      monotonic: true
      aggregation_temporality: cumulative
  aerospike.namespace.geojson.region_query_false_positive:
    enabled: true
    description: Number of points outside the region.
    unit: '{points}'
    extended_documentation: Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_regio_query_falspos.
    sum:
      value_type: int
      input_type: string
      monotonic: true
      aggregation_temporality: cumulative
  aerospike.namespace.geojson.region_query_points:
    enabled: true
    description: Number of points within the region.
    unit: '{points}'
    extended_documentation: Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_region_query_points.
    sum:
      value_type: int
      input_type: string
      monotonic: true
      aggregation_temporality: cumulative
  aerospike.namespace.geojson.region_query_requests:
    enabled: true
    description: Number of geojson queries on the system since the uptime of the node.
    unit: '{queries}'
    extended_documentation: Number of geojson queries on the system since the uptime of the node. Aerospike metric geo_region_query_reqs.
    sum:
      value_type: int
      input_type: string
      monotonic: true
      aggregation_temporality: cumulative
  aerospike.namespace.transaction.count:
    enabled: true
    description: Number of transactions performed on the namespace
    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]
    sum:
      value_type: int
      input_type: string
      monotonic: true
      aggregation_temporality: cumulative