github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs/VictoriaLogs/querying/vlogscli.md: replace vlogsql with vlogscli everywhere in the docs

Browse source 
`vlogsql` was the initial name of the command-line utility for interactive querying of logs.
Later it was renamed to `vlogscli`.

Thanks to @grinapo for the bugreport at https://github.com/VictoriaMetrics/VictoriaMetrics/issues/7512
This commit is contained in:
Aliaksandr Valialkin 2024-11-12 18:20:58 +01:00
parent 33a4f275b1
commit 4837dc6e09
No known key found for this signature in database
GPG key ID: 52C003EE2BCDB9EB
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/VictoriaLogs/querying/vlogscli.md
View file

@ -38,18 +38,18 @@ docker run --rm -it docker.io/victoriametrics/vlogscli:v0.42.0-victorialogs
By default `vlogscli` sends queries to [`http://localhost:8429/select/logsql/query`](https://docs.victoriametrics.com/victorialogs/querying/#querying-logs). By default `vlogscli` sends queries to [`http://localhost:8429/select/logsql/query`](https://docs.victoriametrics.com/victorialogs/querying/#querying-logs).
The url to query can be changed via `-datasource.url` command-line flag. For example, the following command instructs The url to query can be changed via `-datasource.url` command-line flag. For example, the following command instructs
`vlogsql` sending queries to `https://victoria-logs.some-domain.com/select/logsql/query`: `vlogscli` sending queries to `https://victoria-logs.some-domain.com/select/logsql/query`:
```sh ```sh
./vlogsql -datasource.url='https://victoria-logs.some-domain.com/select/logsql/query' ./vlogscli -datasource.url='https://victoria-logs.some-domain.com/select/logsql/query'
``` ```
If some HTTP request headers must be passed to the querying API, then set `-header` command-line flag. If some HTTP request headers must be passed to the querying API, then set `-header` command-line flag.
For example, the following command starts `vlogsql`, For example, the following command starts `vlogscli`,
which queries `(AccountID=123, ProjectID=456)` [tenant](https://docs.victoriametrics.com/victorialogs/#multitenancy): which queries `(AccountID=123, ProjectID=456)` [tenant](https://docs.victoriametrics.com/victorialogs/#multitenancy):
```sh ```sh
./vlogsql -header='AccountID: 123' -header='ProjectID: 456' ./vlogscli -header='AccountID: 123' -header='ProjectID: 456'
``` ```
@ -59,13 +59,13 @@ which queries `(AccountID=123, ProjectID=456)` [tenant](https://docs.victoriamet
can be set via `-accountID` and `-projectID` command-line flags: can be set via `-accountID` and `-projectID` command-line flags:
```sh ```sh
./vlogsql -accountID=123 -projectID=456 ./vlogscli -accountID=123 -projectID=456
``` ```
## Querying ## Querying
After the start `vlogsql` provides a prompt for writing [LogsQL](https://docs.victoriametrics.com/victorialogs/logsql/) queries. After the start `vlogscli` provides a prompt for writing [LogsQL](https://docs.victoriametrics.com/victorialogs/logsql/) queries.
The query can be multi-line. It is sent to VictoriaLogs as soon as it contains `;` at the end or if a blank line follows the query. The query can be multi-line. It is sent to VictoriaLogs as soon as it contains `;` at the end or if a blank line follows the query.
For example: For example:
@ -85,7 +85,7 @@ and optimizing slow queries.
Query execution can be interrupted at any time by pressing `Ctrl+C`. Query execution can be interrupted at any time by pressing `Ctrl+C`.
Type `q` and then press `Enter` for exit from `vlogsql` (if you want to search for `q` [word](https://docs.victoriametrics.com/victorialogs/logsql/#word), Type `q` and then press `Enter` for exit from `vlogscli` (if you want to search for `q` [word](https://docs.victoriametrics.com/victorialogs/logsql/#word),
then just wrap it into quotes: `"q"` or `'q'`). then just wrap it into quotes: `"q"` or `'q'`).
See also: See also:
@ -98,9 +98,9 @@ See also:
## Scrolling query results ## Scrolling query results
If the query response exceeds vertical screen space, `vlogsql` pipes query response to `less` utility, If the query response exceeds vertical screen space, `vlogscli` pipes query response to `less` utility,
so you can scroll the response as needed. This allows executing queries, which potentially so you can scroll the response as needed. This allows executing queries, which potentially
may return billions of rows, without any problems at both VictoriaLogs and `vlogsql` sides, may return billions of rows, without any problems at both VictoriaLogs and `vlogscli` sides,
thanks to the way how `less` interacts with [`/select/logsql/query`](https://docs.victoriametrics.com/victorialogs/querying/#querying-logs): thanks to the way how `less` interacts with [`/select/logsql/query`](https://docs.victoriametrics.com/victorialogs/querying/#querying-logs):
- `less` reads the response when needed, e.g. when you scroll it down. - `less` reads the response when needed, e.g. when you scroll it down.
@ -117,7 +117,7 @@ See also [`less` docs](https://man7.org/linux/man-pages/man1/less.1.html) and
## Live tailing ## Live tailing
`vlogsql` enters live tailing mode when the query is prepended with `\tail ` command. For example, `vlogscli` enters live tailing mode when the query is prepended with `\tail ` command. For example,
the following query shows all the newly ingested logs with `error` [word](https://docs.victoriametrics.com/victorialogs/logsql/#word) the following query shows all the newly ingested logs with `error` [word](https://docs.victoriametrics.com/victorialogs/logsql/#word)
in real time: in real time:
@ -133,9 +133,9 @@ Live tailing can show query results in different formats - see [these docs](#out
## Query history ## Query history
`vlogsql` supports query history - press `up` and `down` keys for navigating the history. `vlogscli` supports query history - press `up` and `down` keys for navigating the history.
By default the history is stored in the `vlogsql-history` file at the directory where `vlogsql` runs, By default the history is stored in the `vlogscli-history` file at the directory where `vlogscli` runs,
so the history is available between `vlogsql` runs. so the history is available between `vlogscli` runs.
The path to the file can be changed via `-historyFile` command-line flag. The path to the file can be changed via `-historyFile` command-line flag.
Quick tip: type some text and then press `Ctrl+R` for searching queries with the given text in the history. Quick tip: type some text and then press `Ctrl+R` for searching queries with the given text in the history.