aerospike_schema.yaml

# ------------------------------------------------------------------------------
# Copyright 2012-2016 Aerospike, Inc.
#
# Portions may be licensed to Aerospike, Inc. under one or more contributor
# license agreements.
#
# Licensed under the Apache License, Version 2.0 (the "License") you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
# ------------------------------------------------------------------------------

# ==============================================================================
# Schema for Aerospike Plugin for collectd
# ------------------------------------------------------------------------------
# This document specifies the metrics that will be sent to collectd. The 
# document is formatted using YAML, so you can use YAML commenting to disable
# a metric.
#
# Structure:
#     [context]:
#       [type]:
#         - metrics
#         - ...
#
# The [context] is either:
#     - meta
#     - cluster
#     - latency
#     - service
#     - namespace 
#     - datacenter
#
# The [type] is a type defined in either types.db or aerospike_types.db. A 
# metric may be associated with multiple types. So, if you find that you need
# to collect both a derivative and gauge, then you can easily do so.
#
# Comment [type] are:
#     - counter
#     - gauge
#     - percent
#     - bytes
#
# ------------------------------------------------------------------------------

# ==============================================================================
# Meta metrics used to provide information about plugin itself
# ------------------------------------------------------------------------------
meta:

  gauge:
    - alive
    - timeouts
    - emits
    - writes
    - failures

# ==============================================================================
# Cluster metrics used to provide information about the cluster itself.
# ------------------------------------------------------------------------------
cluster:
  
  gauge:
    - services
    - services-alumni

# ==============================================================================
# Latency metrics used to measure transaction throughput and latency.
# ------------------------------------------------------------------------------
latency:
  
  gauge:
    - reads_tps
    - writes_master_tps
    - proxy_tps
    - udf_tps
    - query_tps

  percent:
    - reads_pct_gt_1ms
    - reads_pct_gt_8ms
    - reads_pct_gt_64ms
    - writes_master_pct_gt_1ms
    - writes_master_pct_gt_8ms
    - writes_master_pct_gt_64ms
    - proxy_pct_gt_1ms
    - proxy_pct_gt_8ms
    - proxy_pct_gt_64ms
    - udf_pct_gt_1ms
    - udf_pct_gt_8ms
    - udf_pct_gt_64ms
    - query_pct_gt_1ms
    - query_pct_gt_8ms
    - query_pct_gt_64ms

# ==============================================================================
# Service metrics provide details about the state of the service
# ------------------------------------------------------------------------------
service:

  gauge:
    - cluster_size
    - uptime
    - batch_queue
    - batch_tree_count
    - client_connections
    - cluster_size
    - delete_queue
    - info_queue
    - migrate_progress_recv
    - migrate_progress_send
    - migrate_rx_objs
    - migrate_tx_objs
    - objects
    - ongoing_write_reqs
    - partition_absent
    - partition_actual
    - partition_desync
    - partition_object_count
    - partition_ref_count
    - partition_replica
    - proxy_in_progress
    - queue
    - record_locks
    - record_refs
    - stat_evicted_objects_time
    - sub-records
    - tree_count
    - waiting_transactions
    - query_long_queue_size
    - query_short_queue_size

  boolean:
    - cluster_integrity
    - system_swapping

  percent:
    - free-pct-disk
    - free-pct-memory
    - system_free_mem_pct

  bytes:
    - data-used-bytes-memory
    - index-used-bytes-memory
    - sindex-used-bytes-memory
    - total-bytes-disk
    - total-bytes-memory
    - used-bytes-disk
    - used-bytes-memory

  operations:
    - aggr_scans_succeeded
    - aggr_scans_failed
    - basic_scans_failed
    - basic_scans_succeeded
    - batch_errors
    - batch_index_initiate
    - batch_index_complete
    - batch_index_timeout
    - batch_index_errors
    - batch_index_unused_buffers
    - batch_index_huge_buffers
    - batch_index_created_buffers
    - batch_index_destroyed_buffers
    - batch_initiate
    - batch_timeout
    - err_duplicate_proxy_request
    - err_out_of_space
    - err_replica_non_null_node
    - err_replica_null_node
    - err_rw_cant_put_unique
    - err_rw_pending_limit
    - err_rw_request_not_found
    - err_storage_queue_full
    - err_sync_copy_null_master
    - err_sync_copy_null_node
    - err_tsvc_requests
    - err_tsvc_requests_timeout
    - err_write_fail_bin_exists
    - err_write_fail_bin_name
    - err_write_fail_bin_not_found
    - err_write_fail_forbidden
    - err_write_fail_generation
    - err_write_fail_generation_xdr
    - err_write_fail_incompatible_type
    - err_write_fail_key_exists
    - err_write_fail_key_mismatch
    - err_write_fail_not_found
    - err_write_fail_noxdr
    - err_write_fail_parameter
    - err_write_fail_prole_delete
    - err_write_fail_prole_generation
    - err_write_fail_prole_unknown
    - err_write_fail_record_too_big
    - err_write_fail_unknown
    - fabric_msgs_rcvd
    - fabric_msgs_sent
    - heartbeat_received_foreign
    - heartbeat_received_self
    - migrate_msgs_recv
    - migrate_msgs_sent
    - migrate_num_incoming_accepted
    - migrate_num_incoming_refused
    - proxy_action
    - proxy_initiate
    - proxy_retry
    - proxy_retry_new_dest
    - proxy_retry_q_full
    - proxy_retry_same_dest
    - proxy_unproxy
    - query_abort
    - query_agg
    - query_agg_abort
    - query_agg_avg_rec_count
    - query_agg_err
    - query_agg_success
    - query_avg_rec_count
    - query_fail
    - query_long_queue_full
    - query_long_reqs
    - query_long_running
    - query_lookup_abort
    - query_lookup_avg_rec_count
    - query_lookup_err
    - query_lookups
    - query_lookup_success
    - query_reqs
    - query_short_queue_full
    - query_short_reqs
    - query_short_running
    - query_success
    - query_tracked
    - read_dup_prole
    - reaped_fds
    - rw_err_ack_badnode
    - rw_err_ack_internal
    - rw_err_ack_nomatch
    - rw_err_dup_cluster_key
    - rw_err_dup_internal
    - rw_err_dup_send
    - rw_err_write_cluster_key
    - rw_err_write_internal
    - rw_err_write_send
    - scans_active
    - sindex_gc_activity_dur
    - sindex_gc_garbage_cleaned
    - sindex_gc_garbage_found
    - sindex_gc_inactivity_dur
    - sindex_gc_list_creation_time
    - sindex_gc_list_deletion_time
    - sindex_gc_locktimedout
    - sindex_gc_objects_validated
    - sindex_ucgarbage_found
    - stat_cluster_key_err_ack_dup_trans_reenqueue
    - stat_cluster_key_err_ack_rw_trans_reenqueue
    - stat_cluster_key_partition_transaction_queue_count
    - stat_cluster_key_prole_retry
    - stat_cluster_key_regular_processed
    - stat_cluster_key_transaction_reenqueue
    - stat_cluster_key_trans_to_proxy_retry
    - stat_deleted_set_objects
    - stat_delete_success
    - stat_duplicate_operation
    - stat_evicted_objects
    - stat_expired_objects
    - stat_ldt_proxy
    - stat_nsup_deletes_not_shipped
    - stat_evicted_set_objects
    - stat_proxy_errs
    - stat_proxy_reqs
    - stat_proxy_reqs_xdr
    - stat_proxy_success
    - stat_read_errs_notfound
    - stat_read_errs_other
    - stat_read_reqs
    - stat_read_reqs_xdr
    - stat_read_success
    - stat_rw_timeout
    - stat_slow_trans_queue_batch_pop
    - stat_slow_trans_queue_pop
    - stat_slow_trans_queue_push
    - stat_write_errs
    - stat_write_errs_notfound
    - stat_write_errs_other
    - stat_write_reqs
    - stat_write_reqs_xdr
    - stat_write_success
    - stat_xdr_pipe_miss
    - stat_xdr_pipe_writes
    - stat_zero_bin_records
    - storage_defrag_corrupt_record
    - transactions
    - tscan_aborted
    - tscan_initiate
    - tscan_pending
    - tscan_succeeded
    - udf_bg_scans_succeeded
    - udf_bg_scans_failed
    - udf_delete_err_others
    - udf_delete_reqs
    - udf_delete_success
    - udf_lua_errs
    - udf_query_rec_reqs
    - udf_read_errs_other
    - udf_read_reqs
    - udf_read_success
    - udf_replica_writes
    - udf_scan_rec_reqs
    - udf_write_err_others
    - udf_write_reqs
    - udf_write_success
    - write_master
    - write_prole

# ==============================================================================
# Namespace specific metrics recorded per namespace
# ------------------------------------------------------------------------------
namespace:
  
  gauge:
    - available-bin-names
    - current-time
    - master-objects
    - master-sub-objects
    - max-evicted-ttl
    - max-void-time
    - migrate-rx-partitions-initial
    - migrate-rx-partitions-remaining
    - migrate-tx-partitions-initial
    - migrate-tx-partitions-remaining
    - migrate-tx-partitions-imbalance
    - non-expirable-objects
    - nsup-cycle-duration
    - objects
    - obj-size-hist-max
    - prole-objects
    - prole-sub-objects
    - repl-factor
    - sub-objects

  bytes:
    - data-used-bytes-memory
    - index-used-bytes-memory
    - sindex-used-bytes-memory
    - total-bytes-disk
    - total-bytes-memory
    - used-bytes-disk
    - used-bytes-memory

  boolean:
    - hwm-breached
    - stop-writes

  percent:
    - available_pct
    - cache-read-pct
    - free-pct-disk
    - free-pct-memory
    - nsup-cycle-sleep-pct

  operations:
    - evicted-objects
    - expired-objects
    - ldt_deletes
    - ldt_delete_success
    - ldt_errors
    - ldt_reads
    - ldt_read_success
    - ldt_updates
    - ldt_writes
    - ldt_write_success
    - set-deleted-objects
    - set-evicted-objects

  # config:
  #   - max-write-cache
  #   - defrag-startup-minimum
  #   - ldt-page-size
  #   - high-water-memory-pct
  #   - memory-size
  #   - max-ttl
  #   - filesize
  #   - min-avail-pct
  #   - fsync-max-sec
  #   - default-ttl
  #   - cold-start-evict-ttl
  #   - defrag-sleep
  #   - write-smoothing-period
  #   - stop-writes-pct
  #   - defrag-queue-min
  #   - post-write-queue
  #   - high-water-disk-pct
  #   - writethreads
  #   - writecache
  #   - evict-tenths-pct
  #   - defrag-lwm-pct
  #   - flush-max-ms

# ==============================================================================
# Datacenter (XDR) specific metrics recorded per datacenter
# ------------------------------------------------------------------------------
datacenter:
  
  gauge:
    - dc_timelag
    - dc_err_ship_client
    - dc_err_ship_server
    - dc_latency_avg_ship
    - dc_remote_ship_avg_sleep
    - dc_open_conn
    - dc_recs_inflight
    - dc_size
    - dc_state
  
  bytes:
    - dc_esmt_bytes_shipped
  
  operations:
    - dc_remote_ship_ok
    - dc_rec_ship_attempts
    - dc_delete_ship_attempts
  
  percent:
    - est_ship_compression_pct
    - dc_esmt_ship_avg_comp_pct