mirror
/
glances
mirror of https://github.com/nicolargo/glances.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs (again) for API. Related to issue #1988

This commit is contained in:
nicolargo 2022-01-15 11:38:21 +01:00
parent 2729bd767f
commit 00c65933ae
2 changed files with 304 additions and 281 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

565
docs/api.rst
View File

File diff suppressed because it is too large Load Diff

20
glances/outputs/glances_stdout_apidoc.py
View File

@ -61,7 +61,7 @@ def print_api_status():
print('This entry point should be used to check the API status.')
print('It will return nothing but a 200 return code if everythin is OK.')
print('')
print('Get the Rest API status:')
print('Get the Rest API status::')
print('')
print(' # curl -I {}/status'.format(API_URL))
print(indent_stat('HTTP/1.0 200 OK'))
@ -74,7 +74,7 @@ def print_plugins_list(stat):
print(sub_title)
print('-' * len(sub_title))
print('')
print('Get the plugins list:')
print('Get the plugins list::')
print('')
print(' # curl {}/pluginslist'.format(API_URL))
print(indent_stat(stat))
@ -87,7 +87,7 @@ def print_plugin_export(plugin, stat_export):
print('-' * len(sub_title))
print('')
print('Get plugin stats:')
print('Get plugin stats::')
print('')
print(' # curl {}/{}'.format(API_URL, plugin))
print(indent_stat(stat_export))
@ -131,7 +131,7 @@ def print_plugin_item_value(plugin, stat, stat_export):
value = stat_item[item][0]
else:
value = stat_item[item]
print('Get a specific field:')
print('Get a specific field::')
print('')
print(' # curl {}/{}/{}'.format(API_URL, plugin, item))
print(indent_stat(stat_item))
@ -149,7 +149,7 @@ def print_all():
print(sub_title)
print('-' * len(sub_title))
print('')
print('Get all Glances stats:')
print('Get all Glances stats::')
print('')
print(' # curl {}/all'.format(API_URL))
print(' Return a very big dictionnary (avoid using this request, performances will be poor)...')
@ -165,17 +165,17 @@ def print_history(stats):
print(sub_title)
print('-' * len(sub_title))
print('')
print('History of a plugin:')
print('History of a plugin::')
print('')
print(' # curl {}/cpu/history'.format(API_URL))
print(indent_stat(json.loads(stats.get_plugin('cpu').get_stats_history(nb=3))))
print('')
print('Limit history to last 2 values:')
print('Limit history to last 2 values::')
print('')
print(' # curl {}/cpu/history/2'.format(API_URL))
print(indent_stat(json.loads(stats.get_plugin('cpu').get_stats_history(nb=2))))
print('')
print('History for a specific field:')
print('History for a specific field::')
print('')
print(' # curl {}/cpu/system/history'.format(API_URL))
print(indent_stat(json.loads(stats.get_plugin('cpu').get_stats_history('system'))))
@ -192,12 +192,12 @@ def print_limits(stats):
print(sub_title)
print('-' * len(sub_title))
print('')
print('All limits/thresholds:')
print('All limits/thresholds::')
print('')
print(' # curl {}/all/limits'.format(API_URL))
print(indent_stat(stats.getAllLimitsAsDict()))
print('')
print('Limits/thresholds for the cpu plugin:')
print('Limits/thresholds for the cpu plugin::')
print('')
print(' # curl {}/cpu/limits'.format(API_URL))
print(indent_stat(stats.get_plugin('cpu').limits))