Files
scylladb/api/api-doc/column_family.json
Amnon Heiman 600c4020a7 Adding the column family metrics API definition
This adds the metrics definition in the column family API, the API is
based on the ColumnFamilyMetrics mbean.

The following operation where added:
get_memtable_columns_count
get_all_memtable_columns_count
get_memtable_on_heap_size
get_all_memtable_on_heap_size
get_memtable_off_heap_size
get_all_memtable_off_heap_size
get_memtable_live_data_size
get_all_memtable_live_data_size
get_all_memtables_on_heap_size
get_all_all_memtables_on_heap_size
get_all_memtables_off_heap_size
get_all_all_memtables_off_heap_size
get_all_memtables_live_data_size
get_all_all_memtables_live_data_size
get_memtable_switch_count
get_all_memtable_switch_count
get_estimated_row_size_histogram
get_estimated_column_count_histogram
get_compression_ratio
get_all_compression_ratio
get_read_latency
get_all_read_latency
get_range_latency
get_all_range_latency
get_write_latency
get_all_write_latency
get_pending_flushes
get_all_pending_flushes
get_pending_compactions
get_all_pending_compactions
get_live_ss_table_count
get_all_live_ss_table_count
get_live_disk_space_used
get_all_live_disk_space_used
get_total_disk_space_used
get_all_total_disk_space_used
get_min_row_size
get_all_min_row_size
get_max_row_size
get_all_max_row_size
get_mean_row_size
get_all_mean_row_size
get_bloom_filter_false_positives
get_all_bloom_filter_false_positives
get_recent_bloom_filter_false_positives
get_all_recent_bloom_filter_false_positives
get_bloom_filter_false_ratio
get_all_bloom_filter_false_ratio
get_recent_bloom_filter_false_ratio
get_all_recent_bloom_filter_false_ratio
get_bloom_filter_disk_space_used
get_all_bloom_filter_disk_space_used
get_bloom_filter_off_heap_memory_used
get_all_bloom_filter_off_heap_memory_used
get_index_summary_off_heap_memory_used
get_all_index_summary_off_heap_memory_used
get_compression_metadata_off_heap_memory_used
get_all_compression_metadata_off_heap_memory_used
get_speculative_retries
get_all_speculative_retries
get_key_cache_hit_rate
get_true_snapshots_size
get_all_true_snapshots_size
get_row_cache_hit_out_of_range
get_all_row_cache_hit_out_of_range
get_row_cache_hit
get_all_row_cache_hit
get_row_cache_miss
get_all_row_cache_miss
get_cas_prepare
get_cas_propose
get_cas_commit
get_sstables_per_read_histogram
get_tombstone_scanned_histogram
get_live_scanned_histogram
get_col_update_time_delta_histogram

Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>
2015-06-30 15:46:14 +03:00

2094 lines
64 KiB
JSON

{
"apiVersion":"0.0.1",
"swaggerVersion":"1.2",
"basePath":"{{Protocol}}://{{Host}}",
"resourcePath":"/column_family",
"produces":[
"application/json"
],
"apis":[
{
"path":"/column_family/",
"operations":[
{
"method":"GET",
"summary":"Get a list of all column family info",
"type":"array",
"items":{
"type":"column_family_info"
},
"nickname":"get_column_family",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/name",
"operations":[
{
"method":"GET",
"summary":"Get a list of all column family names",
"type":"array",
"items":{
"type":"string"
},
"nickname":"get_column_family_name",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/name/keyspace",
"operations":[
{
"method":"GET",
"summary":"Get a list of the key space names",
"type":"array",
"items":{
"type":"string"
},
"nickname":"get_column_family_name_keyspace",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/major_compaction/{name}",
"operations":[
{
"method":"POST",
"summary":"Force a major compaction of this column family",
"type":"string",
"nickname":"force_major_compaction",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/minimum_compaction/{name}",
"operations":[
{
"method":"POST",
"summary":"Sets the minimum number of sstables in queue before compaction kicks off",
"type":"string",
"nickname":"set_minimum_compaction_threshold",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
},
{
"name":"value",
"description":"The minimum number of sstables in queue before compaction kicks off",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
}
]
},
{
"method":"GET",
"summary":"get the minimum number of sstables in queue before compaction kicks off",
"type":"string",
"nickname":"get_minimum_compaction_threshold",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/maximum_compaction/{name}",
"operations":[
{
"method":"POST",
"summary":"Sets the maximum number of sstables in queue before compaction kicks off",
"type":"string",
"nickname":"set_maximum_compaction_threshold",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
},
{
"name":"value",
"description":"The maximum number of sstables in queue before compaction kicks off",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
}
]
},
{
"method":"GET",
"summary":"get the maximum number of sstables in queue before compaction kicks off",
"type":"string",
"nickname":"get_maximum_compaction_threshold",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/compaction/{name}",
"operations":[
{
"method":"POST",
"summary":"Sets the minumum and maximum number of sstables in queue before compaction kicks off",
"type":"string",
"nickname":"set_compaction_threshold",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
},
{
"name":"maximum",
"description":"The maximum number of sstables in queue before compaction kicks off",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
},
{
"name":"minimum",
"description":"The minimum number of sstables in queue before compaction kicks off",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
}
]
}
]
},
{
"path":"/column_family/compression_parameters/{name}",
"operations":[
{
"method":"GET",
"summary":"get the compression parameters",
"type":"array",
"items":{
"type":"mapper"
},
"nickname":"get_compression_parameters",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/autocompaction/{name}",
"operations":[
{
"method":"GET",
"summary":"check if the auto compaction disabled",
"type":"boolean",
"nickname":"is_auto_compaction_disabled",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/estimate_keys/{name}",
"operations":[
{
"method":"GET",
"summary":"Get the estimate keys",
"type":"long",
"nickname":"estimate_keys",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/built_indexes/{name}",
"operations":[
{
"method":"GET",
"summary":"Returns a list of the names of the built column indexes for current store",
"type":"array",
"items":{
"type":"string"
},
"nickname":"get_built_indexes",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/sstables/by_key/{key}",
"operations":[
{
"method":"GET",
"summary":"Returns a list of filenames that contain the given key on this node",
"type":"array",
"items":{
"type":"string"
},
"nickname":"get_sstables_for_key",
"produces":[
"application/json"
],
"parameters":[
{
"name":"key",
"description":"The key",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/load/sstable/",
"operations":[
{
"method":"POST",
"summary":"Scan through Keyspace/ColumnFamily's data directory determine which SSTables should be loaded and load them",
"type":"string",
"nickname":"load_new_sstables",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/sstables/unleveled/{name}",
"operations":[
{
"method":"GET",
"summary":"the number of SSTables in L0. Always return 0 if Leveled compaction is not enabled.",
"type":"array",
"items":{
"type":"string"
},
"nickname":"get_unleveled_sstables",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/sstables/per_level/{name}",
"operations":[
{
"method":"GET",
"summary":"sstable count for each level. empty unless leveled compaction is used",
"type":"array",
"items":{
"type":"string"
},
"nickname":"get_sstable_count_per_level",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/tombstones/droppable_ratio/{name}",
"operations":[
{
"method":"GET",
"summary":"Get the ratio of droppable tombstones to real columns (and non-droppable tombstones)",
"type":"double",
"nickname":"get_droppable_tombstone_ratio",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/sstables/snapshots_size/{name}",
"operations":[
{
"method":"GET",
"summary":"the size of SSTables in 'snapshots' subdirectory which aren't live anymore",
"type":"double",
"nickname":"true_snapshots_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/memtable_columns_count/{name}",
"operations":[
{
"method":"GET",
"summary":"get memtable columns count",
"type":"long",
"nickname":"get_memtable_columns_count",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/memtable_columns_count/",
"operations":[
{
"method":"GET",
"summary":"get all memtable columns count",
"type":"long",
"nickname":"get_all_memtable_columns_count",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/memtable_on_heap_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get memtable on heap size",
"type":"long",
"nickname":"get_memtable_on_heap_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/memtable_on_heap_size",
"operations":[
{
"method":"GET",
"summary":"Get all memtable on heap size",
"type":"long",
"nickname":"get_all_memtable_on_heap_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/memtable_off_heap_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get memtable off heap size",
"type":"long",
"nickname":"get_memtable_off_heap_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/memtable_off_heap_size",
"operations":[
{
"method":"GET",
"summary":"Get all memtable off heap size",
"type":"long",
"nickname":"get_all_memtable_off_heap_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/memtable_live_data_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get memtable live data size",
"type":"long",
"nickname":"get_memtable_live_data_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/memtable_live_data_size",
"operations":[
{
"method":"GET",
"summary":"Get all memtable live data size",
"type":"long",
"nickname":"get_all_memtable_live_data_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/all_memtables_on_heap_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get all memtables on heap size",
"type":"long",
"nickname":"get_all_memtables_on_heap_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/all_memtables_on_heap_size",
"operations":[
{
"method":"GET",
"summary":"Get all all memtables on heap size",
"type":"long",
"nickname":"get_all_all_memtables_on_heap_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/all_memtables_off_heap_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get all memtables off heap size",
"type":"long",
"nickname":"get_all_memtables_off_heap_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/all_memtables_off_heap_size",
"operations":[
{
"method":"GET",
"summary":"Get all all memtables off heap size",
"type":"long",
"nickname":"get_all_all_memtables_off_heap_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/all_memtables_live_data_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get all memtables live data size",
"type":"long",
"nickname":"get_all_memtables_live_data_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/all_memtables_live_data_size",
"operations":[
{
"method":"GET",
"summary":"Get all all memtables live data size",
"type":"long",
"nickname":"get_all_all_memtables_live_data_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/memtable_switch_count/{name}",
"operations":[
{
"method":"GET",
"summary":"Get memtable switch count",
"type":"int",
"nickname":"get_memtable_switch_count",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/memtable_switch_count",
"operations":[
{
"method":"GET",
"summary":"Get all memtable switch count",
"type":"int",
"nickname":"get_all_memtable_switch_count",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/estimated_row_size_histogram/{name}",
"operations":[
{
"method":"GET",
"summary":"Get estimated row size histogram",
"type":"array",
"items":{
"type":"long"
},
"nickname":"get_estimated_row_size_histogram",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/estimated_column_count_histogram/{name}",
"operations":[
{
"method":"GET",
"summary":"Get estimated column count histogram",
"type":"array",
"items":{
"type":"long"
},
"nickname":"get_estimated_column_count_histogram",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/compression_ratio/{name}",
"operations":[
{
"method":"GET",
"summary":"Get compression ratio",
"type":"double",
"nickname":"get_compression_ratio",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/compression_ratio",
"operations":[
{
"method":"GET",
"summary":"Get all compression ratio",
"type":"double",
"nickname":"get_all_compression_ratio",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/read_latency/{name}",
"operations":[
{
"method":"GET",
"summary":"Get read latency",
"type":"int",
"nickname":"get_read_latency",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/read_latency",
"operations":[
{
"method":"GET",
"summary":"Get all read latency",
"type":"int",
"nickname":"get_all_read_latency",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/range_latency/{name}",
"operations":[
{
"method":"GET",
"summary":"Get range latency",
"type":"int",
"nickname":"get_range_latency",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/range_latency",
"operations":[
{
"method":"GET",
"summary":"Get all range latency",
"type":"int",
"nickname":"get_all_range_latency",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/write_latency/{name}",
"operations":[
{
"method":"GET",
"summary":"Get write latency",
"type":"int",
"nickname":"get_write_latency",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/write_latency",
"operations":[
{
"method":"GET",
"summary":"Get all write latency",
"type":"int",
"nickname":"get_all_write_latency",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/pending_flushes/{name}",
"operations":[
{
"method":"GET",
"summary":"Get pending flushes",
"type":"int",
"nickname":"get_pending_flushes",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/pending_flushes",
"operations":[
{
"method":"GET",
"summary":"Get all pending flushes",
"type":"int",
"nickname":"get_all_pending_flushes",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/pending_compactions/{name}",
"operations":[
{
"method":"GET",
"summary":"Get pending compactions",
"type":"int",
"nickname":"get_pending_compactions",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/pending_compactions",
"operations":[
{
"method":"GET",
"summary":"Get all pending compactions",
"type":"int",
"nickname":"get_all_pending_compactions",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/live_ss_table_count/{name}",
"operations":[
{
"method":"GET",
"summary":"Get live ss table count",
"type":"int",
"nickname":"get_live_ss_table_count",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/live_ss_table_count",
"operations":[
{
"method":"GET",
"summary":"Get all live ss table count",
"type":"int",
"nickname":"get_all_live_ss_table_count",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/live_disk_space_used/{name}",
"operations":[
{
"method":"GET",
"summary":"Get live disk space used",
"type":"int",
"nickname":"get_live_disk_space_used",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/live_disk_space_used",
"operations":[
{
"method":"GET",
"summary":"Get all live disk space used",
"type":"int",
"nickname":"get_all_live_disk_space_used",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/total_disk_space_used/{name}",
"operations":[
{
"method":"GET",
"summary":"Get total disk space used",
"type":"int",
"nickname":"get_total_disk_space_used",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/total_disk_space_used",
"operations":[
{
"method":"GET",
"summary":"Get all total disk space used",
"type":"int",
"nickname":"get_all_total_disk_space_used",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/min_row_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get min row size",
"type":"long",
"nickname":"get_min_row_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/min_row_size",
"operations":[
{
"method":"GET",
"summary":"Get all min row size",
"type":"long",
"nickname":"get_all_min_row_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/max_row_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get max row size",
"type":"long",
"nickname":"get_max_row_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/max_row_size",
"operations":[
{
"method":"GET",
"summary":"Get all max row size",
"type":"long",
"nickname":"get_all_max_row_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/mean_row_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get mean row size",
"type":"long",
"nickname":"get_mean_row_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/mean_row_size",
"operations":[
{
"method":"GET",
"summary":"Get all mean row size",
"type":"long",
"nickname":"get_all_mean_row_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/bloom_filter_false_positives/{name}",
"operations":[
{
"method":"GET",
"summary":"Get bloom filter false positives",
"type":"long",
"nickname":"get_bloom_filter_false_positives",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/bloom_filter_false_positives",
"operations":[
{
"method":"GET",
"summary":"Get all bloom filter false positives",
"type":"long",
"nickname":"get_all_bloom_filter_false_positives",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/recent_bloom_filter_false_positives/{name}",
"operations":[
{
"method":"GET",
"summary":"Get recent bloom filter false positives",
"type":"long",
"nickname":"get_recent_bloom_filter_false_positives",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/recent_bloom_filter_false_positives",
"operations":[
{
"method":"GET",
"summary":"Get all recent bloom filter false positives",
"type":"long",
"nickname":"get_all_recent_bloom_filter_false_positives",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/bloom_filter_false_ratio/{name}",
"operations":[
{
"method":"GET",
"summary":"Get bloom filter false ratio",
"type":"double",
"nickname":"get_bloom_filter_false_ratio",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/bloom_filter_false_ratio",
"operations":[
{
"method":"GET",
"summary":"Get all bloom filter false ratio",
"type":"double",
"nickname":"get_all_bloom_filter_false_ratio",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/recent_bloom_filter_false_ratio/{name}",
"operations":[
{
"method":"GET",
"summary":"Get recent bloom filter false ratio",
"type":"double",
"nickname":"get_recent_bloom_filter_false_ratio",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/recent_bloom_filter_false_ratio",
"operations":[
{
"method":"GET",
"summary":"Get all recent bloom filter false ratio",
"type":"double",
"nickname":"get_all_recent_bloom_filter_false_ratio",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/bloom_filter_disk_space_used/{name}",
"operations":[
{
"method":"GET",
"summary":"Get bloom filter disk space used",
"type":"long",
"nickname":"get_bloom_filter_disk_space_used",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/bloom_filter_disk_space_used",
"operations":[
{
"method":"GET",
"summary":"Get all bloom filter disk space used",
"type":"long",
"nickname":"get_all_bloom_filter_disk_space_used",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/bloom_filter_off_heap_memory_used/{name}",
"operations":[
{
"method":"GET",
"summary":"Get bloom filter off heap memory used",
"type":"long",
"nickname":"get_bloom_filter_off_heap_memory_used",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/bloom_filter_off_heap_memory_used",
"operations":[
{
"method":"GET",
"summary":"Get all bloom filter off heap memory used",
"type":"long",
"nickname":"get_all_bloom_filter_off_heap_memory_used",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/index_summary_off_heap_memory_used/{name}",
"operations":[
{
"method":"GET",
"summary":"Get index summary off heap memory used",
"type":"long",
"nickname":"get_index_summary_off_heap_memory_used",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/index_summary_off_heap_memory_used",
"operations":[
{
"method":"GET",
"summary":"Get all index summary off heap memory used",
"type":"long",
"nickname":"get_all_index_summary_off_heap_memory_used",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/compression_metadata_off_heap_memory_used/{name}",
"operations":[
{
"method":"GET",
"summary":"Get compression metadata off heap memory used",
"type":"long",
"nickname":"get_compression_metadata_off_heap_memory_used",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/compression_metadata_off_heap_memory_used",
"operations":[
{
"method":"GET",
"summary":"Get all compression metadata off heap memory used",
"type":"long",
"nickname":"get_all_compression_metadata_off_heap_memory_used",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/speculative_retries/{name}",
"operations":[
{
"method":"GET",
"summary":"Get speculative retries",
"type":"int",
"nickname":"get_speculative_retries",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/speculative_retries",
"operations":[
{
"method":"GET",
"summary":"Get all speculative retries",
"type":"int",
"nickname":"get_all_speculative_retries",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/key_cache_hit_rate/{name}",
"operations":[
{
"method":"GET",
"summary":"Get key cache hit rate",
"type":"double",
"nickname":"get_key_cache_hit_rate",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/true_snapshots_size/{name}",
"operations":[
{
"method":"GET",
"summary":"Get true snapshots size",
"type":"long",
"nickname":"get_true_snapshots_size",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/true_snapshots_size",
"operations":[
{
"method":"GET",
"summary":"Get all true snapshots size",
"type":"long",
"nickname":"get_all_true_snapshots_size",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/row_cache_hit_out_of_range/{name}",
"operations":[
{
"method":"GET",
"summary":"Get row cache hit out of range",
"type":"int",
"nickname":"get_row_cache_hit_out_of_range",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/row_cache_hit_out_of_range",
"operations":[
{
"method":"GET",
"summary":"Get all row cache hit out of range",
"type":"int",
"nickname":"get_all_row_cache_hit_out_of_range",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/row_cache_hit/{name}",
"operations":[
{
"method":"GET",
"summary":"Get row cache hit",
"type":"int",
"nickname":"get_row_cache_hit",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/row_cache_hit",
"operations":[
{
"method":"GET",
"summary":"Get all row cache hit",
"type":"int",
"nickname":"get_all_row_cache_hit",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/row_cache_miss/{name}",
"operations":[
{
"method":"GET",
"summary":"Get row cache miss",
"type":"int",
"nickname":"get_row_cache_miss",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/row_cache_miss",
"operations":[
{
"method":"GET",
"summary":"Get all row cache miss",
"type":"int",
"nickname":"get_all_row_cache_miss",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/column_family/metrics/cas_prepare/{name}",
"operations":[
{
"method":"GET",
"summary":"Get cas prepare",
"type":"int",
"nickname":"get_cas_prepare",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/cas_propose/{name}",
"operations":[
{
"method":"GET",
"summary":"Get cas propose",
"type":"int",
"nickname":"get_cas_propose",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/cas_commit/{name}",
"operations":[
{
"method":"GET",
"summary":"Get cas commit",
"type":"int",
"nickname":"get_cas_commit",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/sstables_per_read_histogram/{name}",
"operations":[
{
"method":"GET",
"summary":"Get sstables per read histogram",
"type":"array",
"items":{
"type":"double"
},
"nickname":"get_sstables_per_read_histogram",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/tombstone_scanned_histogram/{name}",
"operations":[
{
"method":"GET",
"summary":"Get tombstone scanned histogram",
"type":"array",
"items":{
"type":"double"
},
"nickname":"get_tombstone_scanned_histogram",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/live_scanned_histogram/{name}",
"operations":[
{
"method":"GET",
"summary":"Get live scanned histogram",
"type":"array",
"items":{
"type":"double"
},
"nickname":"get_live_scanned_histogram",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/column_family/metrics/col_update_time_delta_histogram/{name}",
"operations":[
{
"method":"GET",
"summary":"Get col update time delta histogram",
"type":"array",
"items":{
"type":"double"
},
"nickname":"get_col_update_time_delta_histogram",
"produces":[
"application/json"
],
"parameters":[
{
"name":"name",
"description":"The column family name in keysspace:name format",
"required":true,
"allowMultiple":false,
"type":"string",
"paramType":"path"
}
]
}
]
}
],
"models":{
"mapper":{
"id":"mapper",
"description":"A key value mapping",
"properties":{
"key":{
"type":"string",
"description":"The key"
},
"value":{
"type":"string",
"description":"The value"
}
}
},
"column_family_info":{
"id":"column_family_info",
"description":"Information about column family",
"properties":{
"ks":{
"type":"string",
"description":"The Keyspace"
},
"cf":{
"type":"string",
"description":"The column family"
},
"type":{
"type":"string",
"description":"The column family type"
}
}
}
}
}