Skip to content

Commit 4d5fb45

Browse files
committed
update resolve and ping commands docs description
1 parent e0c0ab3 commit 4d5fb45

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

docs/reference/cli_env.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,8 @@ It reads the configuration from the specified sources and metrics, then begins c
225225

226226
- `ping`
227227

228-
Ping the sources (databases, patroni clusters, poolers, etc.) to check if they are reachable.
228+
Try to connect to configured sources, report errors if any and then exit
229229

230230
- `resolve`
231231

232-
Resolve the monitored databases from sources (postgres clusters and patroni clusters) to check
233-
if they are reachable and if the configuration is correct. The output will be a list of the
234-
resolved databases with their connection strings.
232+
Resolve connection strings for configured sources, based on the given source names (or all sources by default).

internal/cmdopts/cmdsource.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
type SourceCommand struct {
1313
owner *Options
1414
Ping SourcePingCommand `command:"ping" description:"Try to connect to configured sources, report errors if any and then exit"`
15-
Resolve SourceResolveCommand `command:"resolve" description:"Resolve monitored connections for a given sources (all by default)"`
15+
Resolve SourceResolveCommand `command:"resolve" description:"Resolve connection strings for configured sources, based on the given source names (or all sources by default)."`
1616
// PrintSQL SourcePrintCommand `command:"print" description:"Get and print SQL for a given Source"`
1717
}
1818

0 commit comments

Comments
 (0)