SpringBoot与Loki的那些事

因为网上好多都没有通过Loki的API自己实现对日志监控系统，所以我就下定决心自己出一版关于loki与springboot的博文供大家参考，这个可以说是比较实用，很适合中小型企业。因此我酝酿了挺久了，对于loki的研究也比较久，希望各位读者能有新的收获。

简介

Loki是Grafana Labs团队的开源项目，可以组成一个功能齐全的日志堆栈。Loki是一个水平可扩展，高可用性，多租户的日志聚合系统。它的设计非常经济高效且易于操作，因为它不会为日志内容编制索引，而是为每个日志流编制一组标签。Loki是用来存储日志和处理查询，需要通过promtail来收集日志，也可是通过后端的logback等日志框架来收集日志，通过grafana提供的loki可视化查看日志，当然了loki也提供了API，可以根据自己的需求来自己实现可视化界面，能够减少三方插件的使用。

安装

上一篇文章已经介绍了如何安装以及使用Grafana+loki+promtail进行搭建日志系统，blog.csdn.net/qq_43843951…可以看看这篇文章。接下来笔者要介绍的是通过Loki的API编写自己可视化界面，并且通过logback来实现收集日志。 大致的结构如图

简单介绍一下，主要就是通过springboot后端的logback日志框架来收集日志，在推送到loki中存储，loki执行对日志的查询，通过API根据标签等信息去查询日志并且在自定义的前端界面中展示。

整体思路

其实宏观来看，要达成这个需求说起来是十分简单的，只需配置logback配置，在通过MDC写入、收集日志，这里可以好多的写法，可以是通过反射写入日志，也可以是在需要打印的地方写入日志，并且是将日志区分为不同的标签。在前端就可以根据所定义的标签来查看相应的日志。前端获取日志信息逻辑也很简单，就只是通过Loki提供的API获取每行的日志。接下来我就一一详细的介绍SpringBoot与Loki的那些事。 可以查看此图便于理解：

Loki实战开发

接下来就详细讲解笔者在实战开发中是如何编写的，本次介绍只是对编写的代码进行详讲，对于代码可能不会全部粘贴，不然冗余起来效果不好，各位读者可以各自发挥，更加完善。其实整个业务也不难，基本都是loki自身提供的API，读者可以通过Loki官方网站grafana.com/docs/loki/l… 去进一步对Loki的API进行查阅，后面笔者可能也会出一篇来专门对Loki的API以及配置进行介绍。好了，废话不多说，马上进入正题。

springboot中的配置

首先需要配置向Loki推送日志，也就是需要通过Loki的API：POST /loki/api/v1/push ，可以直接将地址通过appender写死在logback日志框架中，但是在项目开发中，要考虑到环境的不同，应该是能够根据需要来修改loki服务器的地址，因此将loki的服务器地址配置在application-dev.yml中。

loki:
  url: http://localhost:3100/loki/api/v1

配置logback日志框架

先获取yml配置的地址，通过appender添加到日志框架中，当然，配置客户端也不一定是LogBack框架，还有Log4j2框架也是能够使用的，具体配置可以看官网github.com/loki4j/loki… 和 github.com/tkowalcz/tj… ，本章只对loki进行讲解，对于日志框架，后期也会一一列出，各位读者有什么不了解的，可以先到网上查阅资料。因为笔者不是部署多台Loki服务器，不同的系统采用system这个标签来进行区分。

<springProperty scope="context" name="lokiUrl" source="loki.url"/>
<property name="LOKI_URL" value="${lokiUrl}"/>

<!--添加loki-->
<appender name="lokiAppender" class="com.github.loki4j.logback.Loki4jAppender">
    <batchTimeoutMs>1000</batchTimeoutMs>
    <http class="com.github.loki4j.logback.ApacheHttpSender">
        <url>${LOKI_URL}/push</url>
    </http>
    <format>
        <label>
            <pattern>system=${SYSTEM_NAME},level=%level,logType=%X{log_file_type:-logType}</pattern>
        </label>
        <message>
            <pattern>${log.pattern}</pattern>
        </message>
        <sortByTime>true</sortByTime>
    </format>
</appender>

注解与切面写入日志

自定义注解，并且设置日志标签值。

/**
 * @author: lyd
 * @description: 自定义日志注解,用作LOKI日志分类
 * @Date: 2022/10/10
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD})
@Documented
public @interface LokiLog {
    LokiLogType type() default LokiLogType.DEFAULT;
}

通过枚举的方式来定义日志类型的标签值

/**
 * @author: lyd
 * @description: 枚举便签值 - 类型自己定义
 * @Date: 2022/10/11
 */
public enum LokiLogType {
    DEFAULT("默认"),
    A("A"),
    B("B"),
    C("C");

    private String desc;

    LokiLogType(String desc) {
     this.desc=desc;
    }

    public String getDesc() {
        return desc;
    }

}

编写切面，写入日志（详情可以参照这篇文章
cloud.tencent.com/developer/a…），内部通过MDC.put("log_file_type", logType.getDesc());(MDC ( Mapped Diagnostic Contexts )，它是一个线程安全的存放诊断日志的容器。可以参照：www.jianshu.com/p/1dea7479e…)可以理解为log_file_type是标签名，logType.getDesc()是标签值。

/**
 * @author: lyd
 * @description: 自定义日志切面:https://cloud.tencent.com/developer/article/1655923
 * @Date: 2022/10/10
 */
@Aspect
@Slf4j
@Component
public class LokiLogAspect {
    /**
     * 切到所有OperatorLog注解修饰的方法
     */