Java ASM은 로그백 로그 수준 동적 전환 방법을 사용합니다.-java지도 시간-php.cn

Background

모든 것에는 원인과 결과가 있으며 모든 것은 이벤트 중심입니다. 이 솔루션의 로그 수준 전환은 다음 배경에서 생성됩니다.

단일 프로덕션 환경에는 수백, 수천 개의 마이크로서비스가 있습니다.
로그 수준 전환은 서비스를 다시 시작할 필요가 없으며 즉각적인 효과가 필요합니다
코드를 수정하거나 관련 종속성 구성 등을 추가하는 것은 비즈니스 개발자의 몫이며, 이는 광범위한 문제와 관련되어 진행 속도가 느립니다.
나중에 정크 로그의 동적 실시간 필터링으로 IO 및 디스크 공간 비용

로그백 소개

적에 맞서기 전쟁 전에 적의 상황을 먼저 이해해야만 모든 전투에서 승리할 수 있습니다. 로그백의 로그 수준을 동적으로 전환하려면 먼저 로그백에 대한 최소한의 사전 이해가 있어야 하며 이것이 기성 구현 솔루션을 제공하는지 확인해야 합니다. 다음은 본 요구사항과 관련된 Logback에 대한 간략한 소개입니다.

Logback은 log4j의 창시자가 작성한 Java용 오픈 소스 로그 구성 요소입니다. 현재 3개의 모듈로 나누어져 있습니다.

logback-core: 핵심 코드 모듈
logback-classic: log4j의 개선된 버전 , 동시에 slf4j 인터페이스
구현: 액세스 모듈은 서블릿 컨테이너와 통합되어 Http
ContextInitializer 클래스를 통해 로그에 액세스하는 기능을 제공합니다. ContextInitializer 클래스는 로그백 자동의 논리적 구현입니다. 구성 과정
로그 수준은 로거에서 관리하며 사용합니다. 멤버 변수 Level은 Logger에 의해 유지됩니다
Logger에는 서로 다른 매개 변수를 가진 세 가지 필터 로그 출력 방법이 있습니다: filterAndLog_0_Or3Plus, filterAndLog_1, filterAndLog_2
Logger의 setLevel은 로그 수준을 유지하는 것입니다

Java ASM은 로그백 로그 수준 동적 전환 방법을 사용합니다.

Solutions

열심히 일하기 전에 먼저 시장에 나와 있는 솔루션을 이해하세요. 이는 디자이너는 물론 제품 책임자까지 최적의 솔루션을 찾는 방식입니다.

옵션 1: Logback은 자동으로 검색하고 업데이트합니다.

이 솔루션은 Logback과 함께 제공되는 기성 구현입니다. 구성이 켜져 있는 한 소위 로그 수준의 동적 전환이 가능합니다. 구성 방법: 로그백 구성 파일에 다음과 같은 예약된 스캐너를 추가하기만 하면 됩니다.

<configuration scan="true" scanPeriod="30 seconds" debug="false">

로그인 후 복사

이 솔루션은 R&D 비용이 필요하지 않으며 운영 및 유지 관리 담당자가 직접 구성하고 사용할 수 있습니다.

단점은 다음과 같습니다.

스캔 간격을 조정할 때마다 서비스를 다시 시작해야 합니다.
프로덕션의 로그 수준은 종종 전환이 필요하지 않으며, 그렇지도 않기 때문에 스캔의 90% 이상이 쓸모가 없습니다. 허용됩니다. 이렇게 하면
실시간으로 적용되지 않습니다. 1분 또는 몇 분에 한 번씩 검사를 설정하면 로그 수준 조정이 즉시 적용되지 않지만 무시해도 됩니다.
이 솔루션은 특정 키워드를 기반으로 로그 출력을 삭제하는 등의 가비지 로그 삭제 요구 사항을 충족할 수 없습니다. 이러한 역사적인 이유로 정크 로그가 많이 인쇄되고 있으며, 시간 비용을 고려하면 이를 최적화하는 비즈니스 연구 및 개발이 불가능합니다.

옵션 2: ASM은 바이트코드를 동적으로 수정합니다

물론 자체 인터페이스 API를 정의하는 등의 다른 옵션도 있습니다. springboot 통합 레벨을 조정하기 위해 Logger에서 setLevel 메소드를 직접 호출합니다.

이러한 계획에는 비즈니스 개발 역할을 전문으로 하는 사람들의 참여를 피할 수 없습니다.

asm을 통해 명령을 동적으로 수정함으로써 이 솔루션은 로그 수준을 조정할 수 있을 뿐만 아니라 즉시 적용할 수 있습니다. 로그 필터링 요구도 충족할 수 있습니다

여기에서는 asm을 소개하지 않겠습니다. asm, java 에이전트 및 jvm의 지침을 먼저 숙지해야 합니다.

1. 아이디어로 Maven 프로젝트 만들기

Java ASM은 로그백 로그 수준 동적 전환 방법을 사용합니다.

2. Maven에 종속성 도입

<dependencies>
        <dependency>
            <groupId>org.ow2.asm</groupId>
            <artifactId>asm</artifactId>
            <version>7.1</version>
        </dependency>
        <dependency>
            <artifactId>asm-commons</artifactId>
            <groupId>org.ow2.asm</groupId>
            <version>7.1</version>
        </dependency>
        <dependency>
            <groupId>com.sun</groupId>
            <artifactId>tools</artifactId>
            <version>1.8</version>
            <scope>system</scope>
            <systemPath>/Library/Java/JavaVirtualMachines/jdk1.8.0_191.jdk/Contents/Home/lib/tools.jar</systemPath>
        </dependency>
    </dependencies>

<build>
  <plugins>
      <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-jar-plugin</artifactId>
          <version>3.2.0</version>
          <configuration>
              <archive>
                  <manifestEntries>
                      <!-- 主程序启动类 -->
                      <Agent-Class>
                          agent.LogbackAgentMain
                      </Agent-Class>
                      <!-- 允许重新定义类 -->
                      <Can-Redefine-Classes>true</Can-Redefine-Classes>
                      <!-- 允许转换并重新加载类 -->
                      <Can-Retransform-Classes>true</Can-Retransform-Classes>
                  </manifestEntries>
              </archive>
          </configuration>
      </plugin>
      <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <configuration>
              <source>1.8</source>
              <target>1.8</target>
              <encoding>UTF-8</encoding>
              <compilerArguments>
                  <verbose />
                  <!-- 将jdk的依赖jar打入项目中-->
                  <bootclasspath>${java.home}/lib/rt.jar</bootclasspath>
              </compilerArguments>
          </configuration>
      </plugin>
  </plugins>
</build>

로그인 후 복사

3. 첨부 시작 클래스 작성

package agent;
import java.lang.instrument.Instrumentation;
import java.lang.instrument.UnmodifiableClassException;
/**
 * @author dengbp
 * @ClassName LogbackAgentMain
 * @Description attach 启动器
 * @date 3/25/22 6:27 PM
 */
public class LogbackAgentMain {
    private static String FILTER_CLASS = "ch.qos.logback.classic.Logger";
    public static void agentmain(String agentArgs, Instrumentation inst) throws UnmodifiableClassException {
        System.out.println("agentArgs:" + agentArgs);
        inst.addTransformer(new LogBackFileTransformer(agentArgs), true);
        Class[] classes = inst.getAllLoadedClasses();
        for (int i = 0; i < classes.length; i++) {
            if (FILTER_CLASS.equals(classes[i].getName())) {
                System.out.println("----重新加载Logger开始----");
                inst.retransformClasses(classes[i]);
                System.out.println("----重新加载Logger完毕----");
                break;
            }
        }
    }
}

로그인 후 복사

4. 바이트코드 변환 프로세서 구현

package agent;
import jdk.internal.org.objectweb.asm.ClassReader;
import jdk.internal.org.objectweb.asm.ClassVisitor;
import jdk.internal.org.objectweb.asm.ClassWriter;
import java.lang.instrument.ClassFileTransformer;
import java.security.ProtectionDomain;
/**
 * @author dengbp
 * @ClassName LogBackFileTransformer
 * @Description 字节码文件转换器
 * @date 3/25/22 6:25 PM
 */
public class LogBackFileTransformer implements ClassFileTransformer {

    private final String level;
    private static String CLASS_NAME = "ch/qos/logback/classic/Logger";
    public LogBackFileTransformer(String level) {
        this.level = level;
    }
    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) {
        if (!CLASS_NAME.equals(className)) {
            return classfileBuffer;
        }
        ClassReader cr = new ClassReader(classfileBuffer);
        ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_FRAMES);
        ClassVisitor cv1 = new LogBackClassVisitor(cw, level);
        /*ClassVisitor cv2 = new LogBackClassVisitor(cv1);*/
        // asm框架使用到访问模式和责任链模式
        // ClassReader 只需要 accept 责任链中的头节点处的 ClassVisitor即可
        cr.accept(cv1, ClassReader.SKIP_FRAMES | ClassReader.SKIP_DEBUG);
        System.out.println("end...");
        return cw.toByteArray();
    }
}

로그인 후 복사

5. Logger 요소의 방문자 구현

package agent;
import jdk.internal.org.objectweb.asm.ClassVisitor;
import jdk.internal.org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
/**
 * @author dengbp
 * @ClassName LogBackClassVisitor
 * @Description Logger类元素访问者
 * @date 3/25/22 5:01 PM
 */
public class LogBackClassVisitor extends ClassVisitor {
    private final String level;
    /**
     * asm版本
     */
    private static final int ASM_VERSION = Opcodes.ASM4;

    public LogBackClassVisitor(ClassVisitor classVisitor, String level) {
        super(ASM_VERSION, classVisitor);
        this.level = level;
    }
    @Override
    public MethodVisitor visitMethod(int access, String name, String descriptor, String signature,
                                     String[] exceptions) {
        MethodVisitor mv = super.visitMethod(access, name, descriptor, signature, exceptions);
        return new LogFilterMethodVisitor(api, mv, access, name, descriptor, level);
    }
}

로그인 후 복사

6. 최종적으로 Logger의 핵심 메소드 구현 The Visitor

이 방문자(클래스)는 로그 레벨 전환을 구현하기 위해 Logger의 세 가지 로그 필터링 메소드에 대한 지침 수정이 필요합니다. 원칙은 명령줄에 입력된 로그 수준 매개 변수의 값을 멤버 변수 EffectiveLevelInt의 값으로 덮어쓰는 것입니다. 길이가 길기 때문에 코드의 핵심 부분만 게시됩니다.

package agent;
import jdk.internal.org.objectweb.asm.Label;
import jdk.internal.org.objectweb.asm.MethodVisitor;
import jdk.internal.org.objectweb.asm.commons.AdviceAdapter;
import org.objectweb.asm.Opcodes;
/**
 * @author dengbp
 * @ClassName LogFilterMethodVisitor
 * @Description Logger类日志过滤方法元素访问者
 * @date 3/25/22 5:01 PM
 */
public class LogFilterMethodVisitor extends AdviceAdapter {
    private String methodName;
    private final String level;
    private static final String filterAndLog_1 = "filterAndLog_1";
    private static final String filterAndLog_2 = "filterAndLog_2";
    private static final String filterAndLog_0_Or3Plus = "filterAndLog_0_Or3Plus";
    protected LogFilterMethodVisitor(int api, MethodVisitor methodVisitor, int access, String name, String descriptor, String level) {
        super(api, methodVisitor, access, name, descriptor);
        this.methodName = name;
        this.level = level;
    }
    /**
     * Description 在访问方法的头部时被访问
     * @param
     * @return void
     * @Author dengbp
     * @Date 3:36 PM 4/1/22
     **/
    @Override
    public void visitCode() {
        System.out.println("visitCode method");
        super.visitCode();
    }
    @Override
    protected void onMethodEnter() {
        System.out.println("开始重写日志级别为："+level);
        System.out.println("----准备修改方法----");
        if (filterAndLog_1.equals(methodName)) {
            modifyLogLevel_1();
        }
        if (filterAndLog_2.equals(methodName)) {
            modifyLogLevel_2();
        }
        if (filterAndLog_0_Or3Plus.equals(methodName)) {
            modifyLogLevel_3();
        }
        System.out.println("重写日志级别成功....");
    }

로그인 후 복사

중. 각각은 filterAndLog_1, filterAndLog_2, filterAndLog_0_Or3Plus 메소드 지침의 수정에 해당합니다. 아래에는 수정LogLevel_1의 구현만 게시되어 있습니다

/**
     * Description 修改目标方法：filterAndLog_1
     * @param
     * @return void
     * @Author dengbp
     * @Date 2:20 PM 3/31/22
     **/
    private void modifyLogLevel_1(){
        Label l0 = new Label();
        mv.visitLabel(l0);
        mv.visitLineNumber(390, l0);
        mv.visitVarInsn(Opcodes.ALOAD, 0);
        mv.visitLdcInsn(level);
        mv.visitMethodInsn(Opcodes.INVOKESTATIC, "ch/qos/logback/classic/Level", "toLevel", "(Ljava/lang/String;)Lch/qos/logback/classic/Level;", false);
        mv.visitFieldInsn(Opcodes.GETFIELD, "ch/qos/logback/classic/Level", "levelInt", "I");
        mv.visitFieldInsn(Opcodes.PUTFIELD, "ch/qos/logback/classic/Logger", "effectiveLevelInt", "I");
        Label l1 = new Label();
        mv.visitLabel(l1);
        mv.visitLineNumber(392, l1);
        mv.visitVarInsn(Opcodes.ALOAD, 0);
        mv.visitFieldInsn(Opcodes.GETFIELD, "ch/qos/logback/classic/Logger", "loggerContext", "Lch/qos/logback/classic/LoggerContext;");
        mv.visitVarInsn(Opcodes.ALOAD, 2);
        mv.visitVarInsn(Opcodes.ALOAD, 0);
        mv.visitVarInsn(Opcodes.ALOAD, 3);
        mv.visitVarInsn(Opcodes.ALOAD, 4);
        mv.visitVarInsn(Opcodes.ALOAD, 5);
        mv.visitVarInsn(Opcodes.ALOAD, 6);
        mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "ch/qos/logback/classic/LoggerContext", "getTurboFilterChainDecision_1", "(Lorg/slf4j/Marker;Lch/qos/logback/classic/Logger;Lch/qos/logback/classic/Level;Ljava/lang/String;Ljava/lang/Object;Ljava/lang/Throwable;)Lch/qos/logback/core/spi/FilterReply;", false);
        mv.visitVarInsn(Opcodes.ASTORE, 7);
        Label l2 = new Label();
        mv.visitLabel(l2);
        mv.visitLineNumber(394, l2);
        mv.visitVarInsn(Opcodes.ALOAD, 7);
        mv.visitFieldInsn(Opcodes.GETSTATIC, "ch/qos/logback/core/spi/FilterReply", "NEUTRAL", "Lch/qos/logback/core/spi/FilterReply;");
        Label l3 = new Label();
        mv.visitJumpInsn(Opcodes.IF_ACMPNE, l3);
        Label l4 = new Label();
        mv.visitLabel(l4);
        mv.visitLineNumber(395, l4);
        mv.visitVarInsn(Opcodes.ALOAD, 0);
        mv.visitFieldInsn(Opcodes.GETFIELD, "ch/qos/logback/classic/Logger", "effectiveLevelInt", "I");
        mv.visitVarInsn(Opcodes.ALOAD, 3);
        mv.visitFieldInsn(Opcodes.GETFIELD, "ch/qos/logback/classic/Level", "levelInt", "I");
        Label l5 = new Label();
        mv.visitJumpInsn(Opcodes.IF_ICMPLE, l5);
        Label l6 = new Label();
        mv.visitLabel(l6);
        mv.visitLineNumber(396, l6);
        mv.visitInsn(Opcodes.RETURN);
        mv.visitLabel(l3);
        mv.visitLineNumber(398, l3);
        mv.visitFrame(Opcodes.F_APPEND, 1, new Object[]{"ch/qos/logback/core/spi/FilterReply"}, 0, null);
        mv.visitVarInsn(Opcodes.ALOAD, 7);
        mv.visitFieldInsn(Opcodes.GETSTATIC, "ch/qos/logback/core/spi/FilterReply", "DENY", "Lch/qos/logback/core/spi/FilterReply;");
        mv.visitJumpInsn(Opcodes.IF_ACMPNE, l5);
        Label l7 = new Label();
        mv.visitLabel(l7);
        mv.visitLineNumber(399, l7);
        mv.visitInsn(Opcodes.RETURN);
        mv.visitLabel(l5);
        mv.visitLineNumber(402, l5);
        mv.visitFrame(Opcodes.F_SAME, 0, null, 0, null);
        mv.visitVarInsn(Opcodes.ALOAD, 0);
        mv.visitVarInsn(Opcodes.ALOAD, 1);
        mv.visitVarInsn(Opcodes.ALOAD, 2);
        mv.visitVarInsn(Opcodes.ALOAD, 3);
        mv.visitVarInsn(Opcodes.ALOAD, 4);
        mv.visitInsn(Opcodes.ICONST_1);
        mv.visitTypeInsn(Opcodes.ANEWARRAY, "java/lang/Object");
        mv.visitInsn(Opcodes.DUP);
        mv.visitInsn(Opcodes.ICONST_0);
        mv.visitVarInsn(Opcodes.ALOAD, 5);
        mv.visitInsn(Opcodes.AASTORE);
        mv.visitVarInsn(Opcodes.ALOAD, 6);
        mv.visitMethodInsn(Opcodes.INVOKESPECIAL, "ch/qos/logback/classic/Logger", "buildLoggingEventAndAppend", "(Ljava/lang/String;Lorg/slf4j/Marker;Lch/qos/logback/classic/Level;Ljava/lang/String;[Ljava/lang/Object;Ljava/lang/Throwable;)V", false);
        Label l8 = new Label();
        mv.visitLabel(l8);
        mv.visitLineNumber(403, l8);
        mv.visitInsn(Opcodes.RETURN);
        Label l9 = new Label();
        mv.visitLabel(l9);
        mv.visitLocalVariable("this", "Lch/qos/logback/classic/Logger;", null, l0, l9, 0);
        mv.visitLocalVariable("localFQCN", "Ljava/lang/String;", null, l0, l9, 1);
        mv.visitLocalVariable("marker", "Lorg/slf4j/Marker;", null, l0, l9, 2);
        mv.visitLocalVariable("level", "Lch/qos/logback/classic/Level;", null, l0, l9, 3);
        mv.visitLocalVariable("msg", "Ljava/lang/String;", null, l0, l9, 4);
        mv.visitLocalVariable("param", "Ljava/lang/Object;", null, l0, l9, 5);
        mv.visitLocalVariable("t", "Ljava/lang/Throwable;", null, l0, l9, 6);
        mv.visitLocalVariable("decision", "Lch/qos/logback/core/spi/FilterReply;", null, l2, l9, 7);
        mv.visitMaxs(9, 8);
        mv.visitEnd();
    }

로그인 후 복사

Seven. 마지막으로 첨부 Agent

import com.sun.tools.attach.VirtualMachine;
import java.io.IOException;
import java.io.UnsupportedEncodingException;

/**
 * @author dengbp
 * @ClassName MyAttachMain
 * @Description jar 执行命令：
 * @date 3/25/22 4:12 PM
 */
public class MyAttachMain {
    private static final int ARGS_SIZE = 2;

    public static void main(String[] args) {
        if (args == null || args.length != ARGS_SIZE) {
            System.out.println("请输入进程id和日志级别(ALL、TRACE、DEBUG、INFO、WARN、ERROR、OFF),如：31722 info");
            return;
        }
        VirtualMachine vm = null;
        try {
            System.out.println("修改的进程id:" + args[0]);
            vm = VirtualMachine.attach(args[0]);
            System.out.println("调整日志级别为：" + args[1]);
            vm.loadAgent(getJar(), args[1]);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (vm != null) {
                try {
                    vm.detach();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
    private static String getJar() throws UnsupportedEncodingException {
        String jarFilePath = MyAttachMain.class.getProtectionDomain().getCodeSource().getLocation().getFile();
        jarFilePath = java.net.URLDecoder.decode(jarFilePath, "UTF-8");
        int beginIndex = 0;
        int endIndex = jarFilePath.length();
        if (jarFilePath.contains(".jar")) {
            endIndex = jarFilePath.indexOf(".jar") + 4;
        }
        if (jarFilePath.startsWith("file:")) {
            beginIndex = jarFilePath.indexOf("file:") + 5;
        }
        jarFilePath = jarFilePath.substring(beginIndex, endIndex);
        System.out.println("jar path:" + jarFilePath);
        return jarFilePath;
    }
}

로그인 후 복사

Eight를 로드하기 위한 로딩 클래스를 작성하고 패키지를 실행합니다

Java ASM은 로그백 로그 수준 동적 전환 방법을 사용합니다.

Execute jar

java  -Xbootclasspath/a:/Library/Java/JavaVirtualMachines/jdk1.8.0_191.jdk/Contents/Home/lib/tools.jar  -cp change-log-agent-1.0.1.jar MyAttachMain 52433  DEBUG

로그인 후 복사

rr reerrree