日志易 SPL 高效进阶:语法编辑器的妙用

一、日志易 SPL 简介
SPL(Search Processing Language)是日志易自主研发的检索处理语言,其功能和用途都和大家熟知的 SQL 类似,是仪表盘展示、告警、报表等功能的必要前提。SPL 上手较为容易,如若想娴熟运用 SPL,则需要不断学习并练习。

二、SPL 设计理念和处理流程
通过拼装简单独立的命令去实现想要的功能,格式类似于 Linux 的管道命令: Query | SPL command1 | SPL command2|…
对于每个命令而言,都会有一个输入和输出, Query 的输出将会作为 SPL1 的输入, SPL1 的输出则会作为 SPL2 的输入,以此类推,得到最终结果。

三、工具篇
SPL 作为日志易的核心语法,日志易 SPL 指令及函数有 300+,需要配合针对 SPL 的语法编辑器使用。经专业服务部同事及众多客户反馈,大家在日常使用中会在 Notepad++、UE 和 Sublime 等文本编辑器对 SPL 进行编写和保存。经过调研,我们选择目前较为普遍的编辑器 VSCode 进行针对 SPL 的插件开发。
3.1 效果展示
SPL 命令补全
SPL 编辑器能够根据用户输入的内容,智能地提供相关的 SPL 命令和函数提示,帮助用户快速准确地完成语句编写,减少语法错误。


300+SPL 命令的高亮
编辑器对 SPL 语句中的关键词、函数、参数等进行高亮显示,使得语句结构更加清晰,便于用户阅读和理解。

300+SPL 命令的语法提示
SPL 编辑器集成了日志易的帮助文档,用户在编写过程中可以随时查阅相关的 SPL 指令和函数说明,快速掌握使用方法。


强大的格式化功能
从晦涩难懂的 SPL 语句变换成简单易懂的格式,提高 SPL 语句的可读性,增加 SPL 多层嵌套语句的逻辑关系展示。
Before:

After:

3.2 插件安装步骤
从官网下载安装包
https://code.visualstudio.com/
在插件中心搜索 Chinese ,选择第一个简体中文安装,并根据提示重启 VSCode 即可。

在插件中心搜索 rizhiyi ,安装即可。

离线安装方式
请在此处下载最新的包:https://github.com/rizhiyi/vscode-rizhiyi-spl-syntax/releases
按照下图方式操作即可。

3.3 如何启用插件功能
新建一个.spl 或者.txt 后缀的文件
不新建文件的情况下则选择定义的 SPL 语言即可
3.4 快捷键绑定
在 VSCode 中使用快捷键 Ctrl+Shift+P 键调出命令窗口,输入关键字格式化 SPL。

编辑点击齿轮图标,再点击 SPL 格式化左侧符号输入快捷键回车即可绑定。

四、总结
SPL 语法编辑器不仅提高了日志易用户的工作效率,还降低了 SPL 语句编写的难度,使得日志数据的分析和处理变得更加便捷和高效。
版权声明: 本文为 InfoQ 作者【日志易】的原创文章。
原文链接:【http://xie.infoq.cn/article/e57ef7bbb4e685259dfa803a8】。文章转载请联系作者。
评论