Updated help messages for ch-monitoring commands

src/chtools/monrun_checks/ch_geobase.py

@@ -10,7 +10,7 @@
 @click.command('geobase')
 def geobase_command():
     """
-    Check is ya.geobase present.
+    Check that embedded geobase is configured.
     """
     ch_client = ClickhouseClient()
 

src/chtools/monrun_checks/ch_keeper.py

@@ -33,7 +33,7 @@
 )
 def keeper_command(retries, timeout, no_verify_ssl_certs) -> Result:
     """
-    Checks ClickHouse Keeper is alive.
+    Check ClickHouse Keeper is alive.
     """
     keeper_port, use_ssl = ClickhouseKeeperConfig.load().port_pair
     if not keeper_port:

src/chtools/monrun_checks/ch_log_errors.py

@@ -26,6 +26,9 @@ def validate_exclude(ctx, param, value):
     '-f', '--logfile', 'logfile', default='/var/log/clickhouse-server/clickhouse-server.err.log', help='Log file path.'
 )
 def log_errors_command(crit, warn, watch_seconds, exclude, logfile):
+    """
+    Check errors in ClickHouse server logs.
+    """
     datetime_start = datetime.now() - datetime.timedelta(seconds=watch_seconds)
     errors = 0
 

src/chtools/monrun_checks/ch_replication_lag.py

@@ -32,7 +32,7 @@
 @click.option('-v', '--verbose', 'verbose', type=int, count=True, default=0, help='Show details about lag.')
 def replication_lag_command(xcrit, crit, warn, mwarn, mcrit, verbose):
     """
-    Check for replication lag between replicas.
+    Check for replication lag across replicas.
     Should be: lag >= lag_with_errors, lag >= max_execution
     """
     lag, lag_with_errors, max_execution, max_merges, chart = get_replication_lag()

src/chtools/monrun_checks/ch_ro_replica.py

@@ -7,7 +7,7 @@
 @click.command('ro-replica')
 def ro_replica_command():
     """
-    Check for readonly replic tables.
+    Check for readonly replicated tables.
     """
     ch_client = ClickhouseClient()
 

src/chtools/monrun_checks/ch_system_queues.py

@@ -12,7 +12,7 @@
 @click.option('-f', '--config_file', 'conf', help='Config file with theshholds per each table.')
 def system_queues_command(crit, warn, conf):
     """
-    Perform the check.
+    Check system queues.
     """
     config = {'triggers': {'default': {'crit': crit, 'warn': warn}}}
     if conf is not None:

src/chtools/monrun_checks/ch_tls.py

@@ -26,7 +26,7 @@
 )
 def tls_command(crit: int, warn: int, ports: Optional[str]) -> Result:
     """
-    Checks TLS certificate for expiration and that actual cert from fs used.
+    Check TLS certificate for expiration and that actual cert from fs used.
     """
     file_certificate, _ = read_cert_file()
 

src/chtools/monrun_checks/ext_ip_dns.py

@@ -35,7 +35,7 @@ def __init__(self, fqdn: str, private: bool, strict: bool):
 @click.option('--ipv6', 'ipv6', is_flag=True, help='Check AAAA DNS records')
 def ext_ip_dns_command(cluster: bool, private: bool, ipv6: bool) -> Result:
     """
-    Checks that all DNS records consistent in DC.
+    Check that all DNS records consistent.
     """
     err = []
     for record in _get_host_dns(cluster, private):

src/chtools/monrun_checks/status.py

@@ -15,7 +15,7 @@ def status_command(commands):
     @click.pass_context
     def status_impl(ctx):
         """
-        Prints status of all checks.
+        Perform all checks.
         """
         checks_status = []
         ctx.obj = {'status_mode': True}

src/chtools/monrun_checks_keeper/status.py

@@ -15,7 +15,7 @@ def status_command(commands):
     @click.pass_context
     def status_impl(ctx):
         """
-        Prints status of all checks.
+        Perform all checks.
         """
         checks_status = []
         ctx.obj.update({'status_mode': True})