Files
scylladb/api/api-doc/commitlog.json
Amnon Heiman ece77c9722 Adding Timers to column_family and commitlog and compaction, and
compression

Timers support expect the API to return histogram. This adds the swagger
definition for the following timer in column_family:
get_coordinator_read_latency
get_coordinator_scan_latency
get_waiting_on_free_memtable_space

The following estimated histogram were added to column_family:
get_read_latency_estimated_recent_histogram
get_read_latency_estimated_histogram
get_range_latency_estimated_recent_histogram
get_range_latency_estimated_histogram
get_write_latency_recent_histogram
get_write_latency_estimated_recent_histogram
get_cas_prepare_estimated_recent_histogram
get_cas_prepare_estimated_histogram
get_cas_propose_estimated_recent_histogram
get_cas_propose_estimated_histogram
get_cas_commit_estimated_recent_histogram
get_cas_commit_estimated_histogram

And the following timers in commitlog:
get_waiting_on_segment_allocation
get_waiting_on_commit

To column family API the following API were added:
set_compaction_strategy_class
get_compaction_strategy_class
set_compression_parameters
set_crc_check_chance
get_sstable_count_per_level

Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>

API: Completing the column_family Swagger definition

This adds the missing definition in the column_family to make it
compatible to ColumnFamilyStoreMbean

Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>
2015-09-12 08:33:26 +03:00

150 lines
3.8 KiB
JSON

{
"apiVersion":"0.0.1",
"swaggerVersion":"1.2",
"basePath":"{{Protocol}}://{{Host}}",
"resourcePath":"/commitlog",
"produces":[
"application/json"
],
"apis":[
{
"path":"/commitlog/recover/{path}",
"operations":[
{
"method":"POST",
"summary":"Recover a single file",
"type":"void",
"nickname":"commitlog_recover",
"produces":[
"application/json"
],
"parameters":[
{
"name":"path",
"description":"Full path of file or directory",
"required":true,
"allowMultiple":true,
"type":"string",
"paramType":"path"
}
]
}
]
},
{
"path":"/commitlog/segments/active",
"operations":[
{
"method":"GET",
"summary":"file names (not full paths) of active commit log segments (segments containing unflushed data)",
"type":"array",
"items":{
"type":"string"
},
"nickname":"get_active_segment_names",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/commitlog/segments/archiving",
"operations":[
{
"method":"GET",
"summary":"Returns files which are pending for archival attempt. Does NOT include failed archive attempts",
"type":"array",
"items":{
"type":"string"
},
"nickname":"get_archiving_segment_names",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path": "/commitlog/metrics/completed_tasks",
"operations": [
{
"method": "GET",
"summary": "Get completed tasks",
"type": "long",
"nickname": "get_completed_tasks",
"produces": [
"application/json"
],
"parameters": []
}
]
},
{
"path": "/commitlog/metrics/pending_tasks",
"operations": [
{
"method": "GET",
"summary": "Get pending tasks",
"type": "long",
"nickname": "get_pending_tasks",
"produces": [
"application/json"
],
"parameters": []
}
]
},
{
"path": "/commitlog/metrics/total_commit_log_size",
"operations": [
{
"method": "GET",
"summary": "Get total commit log size",
"type": "long",
"nickname": "get_total_commit_log_size",
"produces": [
"application/json"
],
"parameters": []
}
]
},
{
"path": "/commit_log/metrics/waiting_on_segment_allocation",
"operations": [
{
"method": "GET",
"summary": "Get waiting on segment allocation",
"$ref": "#/utils/histogram",
"nickname": "get_waiting_on_segment_allocation",
"produces": [
"application/json"
],
"parameters": []
}
]
},
{
"path": "/commit_log/metrics/waiting_on_commit",
"operations": [
{
"method": "GET",
"summary": "Get waiting on commit",
"$ref": "#/utils/histogram",
"nickname": "get_waiting_on_commit",
"produces": [
"application/json"
],
"parameters": []
}
]
}
]
}