summaryrefslogtreecommitdiff
path: root/interface-definitions/service_monitoring_telegraf.xml.in
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2023-10-08 10:27:27 +0200
committerChristian Breunig <christian@breunig.cc>2023-10-08 10:27:27 +0200
commitb6917f386e5f6af570973d42e63baeb4a98d6261 (patch)
tree6910c10e7a48fb97625edee2e8fa04940d56b28b /interface-definitions/service_monitoring_telegraf.xml.in
parentda4006c2a784ff06cf3af3aad6adee7fef8a5330 (diff)
downloadvyos-1x-b6917f386e5f6af570973d42e63baeb4a98d6261.tar.gz
vyos-1x-b6917f386e5f6af570973d42e63baeb4a98d6261.zip
scripts: T4269: node.def generator should automatically add default values
Since introducing the XML <defaultValue> node it was common, but redundant, practice to also add a help string indicating which value would be used as default if the node is unset. This makes no sense b/c it's duplicated code/value/characters and prone to error. The node.def scripts should be extended to automatically render the appropriate default value into the CLI help string. For e.g. SSH the current PoC renders: $ cat templates-cfg/service/ssh/port/node.def multi: type: txt help: Port for SSH service (default: 22) val_help: u32:1-65535; Numeric IP port ... Not all subsystems are already migrated to get_config_dict() and make use of the defaults() call - those subsystems need to be migrated, first before the new default is added to the CLI help. (cherry picked from commit a68c9238111c6caee78bb28f8054b8f0cfa0e374)
Diffstat (limited to 'interface-definitions/service_monitoring_telegraf.xml.in')
-rw-r--r--interface-definitions/service_monitoring_telegraf.xml.in6
1 files changed, 3 insertions, 3 deletions
diff --git a/interface-definitions/service_monitoring_telegraf.xml.in b/interface-definitions/service_monitoring_telegraf.xml.in
index 8a6b31d8c..df8663a45 100644
--- a/interface-definitions/service_monitoring_telegraf.xml.in
+++ b/interface-definitions/service_monitoring_telegraf.xml.in
@@ -50,13 +50,13 @@
</leafNode>
<leafNode name="source">
<properties>
- <help>Source parameters for monitoring (default: all)</help>
+ <help>Source parameters for monitoring</help>
<completionHelp>
<list>all hardware-utilization logs network system telegraf</list>
</completionHelp>
<valueHelp>
<format>all</format>
- <description>All parameters (default)</description>
+ <description>All parameters</description>
</valueHelp>
<valueHelp>
<format>hardware-utilization</format>
@@ -150,7 +150,7 @@
<help>Metric version control mapping from Telegraf to Prometheus format</help>
<valueHelp>
<format>u32:1-2</format>
- <description>Metric version (default: 2)</description>
+ <description>Metric version</description>
</valueHelp>
<constraint>
<validator name="numeric" argument="--range 1-2"/>