diff options
Diffstat (limited to 'glances/outputs/glances_stdout_apidoc.py')
| -rw-r--r-- | glances/outputs/glances_stdout_apidoc.py | 45 |
1 files changed, 10 insertions, 35 deletions
diff --git a/glances/outputs/glances_stdout_apidoc.py b/glances/outputs/glances_stdout_apidoc.py index 300519d7..d871c6e0 100644 --- a/glances/outputs/glances_stdout_apidoc.py +++ b/glances/outputs/glances_stdout_apidoc.py @@ -73,7 +73,7 @@ def print_plugin_export(plugin, stat_export): print('-' * len(sub_title)) print('') - print('.. code-block:: json') + print('Get the plugins list::') print('') print(' # curl {}/{}'.format(API_URL, plugin)) print(indent_stat(stat_export)) @@ -111,18 +111,12 @@ 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('') - print('.. code-block:: json') - print('') + print('Get a specific field::') print(' # curl {}/{}/{}'.format(API_URL, plugin, item)) print(indent_stat(stat_item)) print('') if item and value and stat.get_stats_value(item, value): - print('Get a specific item when field matchs the given value:') - print('') - print('.. code-block:: json') - print('') + print('Get a specific item when field matchs the given value::') print(' # curl {}/{}/{}/{}'.format(API_URL, plugin, item, value)) print(indent_stat(json.loads(stat.get_stats_value(item, value)))) print('') @@ -133,8 +127,7 @@ def print_all(): print(sub_title) print('-' * len(sub_title)) print('') - print('.. code-block:: json') - print('') + print('Get all Glances stats::') print(' # curl {}/all'.format(API_URL)) print(' Return a very big dictionnary (avoid using this request, performances will be poor)...') print('') @@ -149,31 +142,19 @@ def print_history(stats): print(sub_title) print('-' * len(sub_title)) print('') - print('History of a plugin:') - print('') - print('.. code-block:: json') - print('') + print('History of a plugin::') 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('') - print('.. code-block:: json') - print('') + print('Limit history to last 2 values::') 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('') - print('.. code-block:: json') - print('') + print('History for a specific field::') print(' # curl {}/cpu/system/history'.format(API_URL)) print(indent_stat(json.loads(stats.get_plugin('cpu').get_stats_history('system')))) print('') - print('Limit history for a specific field to last 2 values:') - print('') - print('.. code-block:: json') - print('') + print('Limit history for a specific field to last 2 values::') print(' # curl {}/cpu/system/history'.format(API_URL)) print(indent_stat(json.loads(stats.get_plugin('cpu').get_stats_history('system', nb=2)))) print('') @@ -184,17 +165,11 @@ def print_limits(stats): print(sub_title) print('-' * len(sub_title)) print('') - print('All limits/thresholds:') - print('') - print('.. code-block:: json') - print('') + print('All limits/thresholds::') print(' # curl {}/all/limits'.format(API_URL)) print(indent_stat(stats.getAllLimitsAsDict())) print('') - print('Limits/thresholds for the cpu plugin:') - print('') - print('.. code-block:: json') - print('') + print('Limits/thresholds for the cpu plugin::') print(' # curl {}/cpu/limits'.format(API_URL)) print(indent_stat(stats.get_plugin('cpu').limits)) print('') |