README_CN.md

victorialogs-tool

English | 简体中文

一个用于查询 victoria-logs 的工具(你会爱上它)

基于toml配置文件查询，将查询结果集输出至终端

特性

• 简单易用的命令行界面
• 多种组合查询方式
• 支持大范围的时间查询(几天内的日志数据也可手到擒来，甚至更多)
• 基于toml配置文件, 可多个配置文件切换查询，类似于session存储
• 结果集输出至终端，可发挥你的想象力，配合grep、awk、>等工具使用
• 支持tail查询，实时查看日志 (vtool query -t)

安装

确保你的电脑已经安装了Go环境

选项一:

go install github.com/VictoriaMetrics-Community/victorialogs-tool@latest && mv $GOPATH/bin/victorialogs-tool $GOPATH/bin/vtool

选项二:

git clone [email protected]:VictoriaMetrics-Community/victorialogs-tool.git
make build

用法

$ ./vtool --help
A wonderful query tool for Victorialogs

Usage:
  vtool [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  currcfg     Get the absolute path of the current configuration file.
  help        Help about any command
  query       query logs from victoriametrics
  setcfg      Set up the configuration file for query logs

Flags:
  -h, --help     help for vtool
  -t, --toggle   Help message for toggle

Use "vtool [command] --help" for more information about a command.

1. 首先使用vtool setcfg命令设置配置文件

vtool setcfg xxx/i-love-coding.toml

该命令会在家目录下生成一个vtool.json的文件, 用于存储配置文件的路径

配置文件参考: https://github.com/VictoriaMetrics-Community/victorialogs-tool/blob/master/cfgs/example.toml

2. 运行vtool query即可

tips: 你可以使用vtool currcfg命令查看当前配置文件的绝对路径

贡献

欢迎提交PR