AOP with Spring und dem X-Ray SDK for Java

In diesem Thema wird beschrieben, wie Sie das X-Ray SDK und das Spring Framework verwenden, um Ihre Anwendung zu instrumentieren, ohne ihre Kernlogik zu ändern. Das bedeutet, dass es jetzt eine nichtinvasive Möglichkeit gibt, Ihre Anwendungen, die remote ausgeführt werden, zu instrumentierenAWS.

So aktivieren Sie AOP in Spring

1. Konfigurieren von Spring

2. Fügen Sie Ihrer Anwendung einen Tracing-Filter hinzu

3. Kommentieren Ihres Codes oder implementieren einer Schnittstelle

4. Aktivieren von X-Ray in Ihrer Anwendung

Konfigurieren von Spring

Sie können Maven oder Gradle verwenden, um Spring zu konfigurieren, um AOP für die Instrumentierung Ihrer Anwendung verwenden zu können.

Wenn Sie Ihre Anwendung mit Maven erstellen, fügen Sie die folgende Abhängigkeit in Ihrer pom.xml-Datei hinzu.

<dependency> 
     <groupId>com.amazonaws</groupId> 
     <artifactId>aws-xray-recorder-sdk-spring</artifactId> 
     <version>2.11.0</version> 
</dependency>

Für Gradle fügen Sie die folgende Abhängigkeit in Ihre build.gradle-Datei ein.

compile 'com.amazonaws:aws-xray-recorder-sdk-spring:2.11.0'

Spring Boot konfigurieren

Wenn Sie Spring Boot verwenden, fügen Sie zusätzlich zu der im vorherigen Abschnitt beschriebenen Spring-Abhängigkeit die folgende Abhängigkeit hinzu, falls sie sich nicht bereits in Ihrem Klassenpfad befindet.

Maven:

<dependency> 
     <groupId>org.springframework.boot</groupId> 
     <artifactId>spring-boot-starter-aop</artifactId> 
     <version>2.5.2</version> 
</dependency>

Wiege:

compile 'org.springframework.boot:spring-boot-starter-aop:2.5.2'

Hinzufügen eines Tracing-Filters zu Ihrer Anwendung

FügeFilter deinerWebConfig Klasse ein hinzu. Übermitteln Sie den Segmentnamen als Zeichenfolge an den AWSXRayServletFilter-Konstruktor. Weitere Informationen zu Ablaufverfolgungsfiltern und Instrumentieren eingehender Anfragen finden Sie unterAblaufverfolgung eingehender Anfragen mit dem X-Ray-SDK SDK for Java.

Beispiel src/main/java/myapp/WebConfig .java-Frühling

package myapp;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Bean;
import javax.servlet.Filter;
import com.amazonaws.xray.javax.servlet.AWSXRayServletFilter;

@Configuration
public class WebConfig {

  @Bean
  public Filter TracingFilter() {
    return new AWSXRayServletFilter("Scorekeep");
  }
}

Jakarta-Unterstützung

Spring 6 verwendet Jakarta anstelle von Javax für seine Enterprise Edition. Um diesen neuen Namespace zu unterstützen, hat X-Ray einen parallel Satz von Klassen erstellt, die in ihrem eigenen Jakarta-Namespace leben.

Für die Filterklassen ersetzen Siejavax durchjakarta. Fügen Sie bei der Konfiguration einer Segmentbenennungsstrategiejakarta vor der Benennungsstrategie den Klassennamen hinzu, wie im folgenden Beispiel:

package myapp;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Bean;
import jakarta.servlet.Filter;
import com.amazonaws.xray.jakarta.servlet.AWSXRayServletFilter;
import com.amazonaws.xray.strategy.jakarta.SegmentNamingStrategy;

@Configuration
public class WebConfig {
    @Bean
    public Filter TracingFilter() {
        return new AWSXRayServletFilter(SegmentNamingStrategy.dynamic("Scorekeep"));
    }
}

Kommentieren Ihres Codes oder Implementieren einer Schnittstelle

Ihre Klassen müssen entweder mit der@XRayEnabled Anmerkung annotiert sein oder dieXRayTraced Schnittstelle implementieren. Damit wird das AOP-System angewiesen, die Funktionen der betroffenen Klasse für die X-Ray-Instrumentierung zu kapseln.

X-Ray in Ihrer Anwendung aktivieren

Um X-Ray Tracing in Ihrer Anwendung zu aktivieren, muss Ihr Code die abstrakte Klasse erweitern,BaseAbstractXRayInterceptor indem er die folgenden Methoden überschreibt.

• generateMetadata— Diese Funktion ermöglicht die Anpassung der Metadaten, die an den Trace der aktuellen Funktion angehängt sind. Standardmäßig wird der Klassenname der ausgeführten Funktion in den Metadaten aufgezeichnet. Sie können weitere Daten hinzufügen, wenn Sie zusätzliche Informationen benötigen.

• xrayEnabledClasses— Diese Funktion ist leer und sollte es auch bleiben. Sie dient als Host für ein Pointcut, das den Interceptor anweist, welche Methoden gekapselt werden sollen. Definieren Sie das Pointcut, indem Sie angeben, welche der Klassen mit @XRayEnabled kommentiert sind, um ein Tracing durchzuführen. Die folgende pointcut-Anweisung weist den Interceptor an, alle Controller-Beans einzukapseln, die mit dem Kommentar @XRayEnabled gekennzeichnet sind.

  @Pointcut(“@within(com.amazonaws.xray.spring.aop.XRayEnabled) && bean(*Controller)”)

Wenn Ihr Projekt Spring Data JPA verwendet, sollten Sie erwägen, vonAbstractXRayInterceptor statt von zu erweiternBaseAbstractXRayInterceptor.

Beispiel

Der folgende Code erweitert die abstrakte KlasseBaseAbstractXRayInterceptor.

@Aspect
@Component
public class XRayInspector extends BaseAbstractXRayInterceptor {    
    @Override    
    protected Map<String, Map<String, Object>> generateMetadata(ProceedingJoinPoint proceedingJoinPoint, Subsegment subsegment) throws Exception {      
        return super.generateMetadata(proceedingJoinPoint, subsegment);    
    }    
  
  @Override    
  @Pointcut("@within(com.amazonaws.xray.spring.aop.XRayEnabled) && bean(*Controller)")    
  public void xrayEnabledClasses() {}
  
}

Der folgenden Code ist eine Klasse, die von X-Ray instrumentiert wird.

@Service
@XRayEnabled
public class MyServiceImpl implements MyService {    
    private final MyEntityRepository myEntityRepository;    
    
    @Autowired    
    public MyServiceImpl(MyEntityRepository myEntityRepository) {        
        this.myEntityRepository = myEntityRepository;    
    }    
    
    @Transactional(readOnly = true)    
    public List<MyEntity> getMyEntities(){        
        try(Stream<MyEntity> entityStream = this.myEntityRepository.streamAll()){            
            return entityStream.sorted().collect(Collectors.toList());        
        }    
    }
}

Wenn Sie Ihre Anwendung ordnungsgemäß konfiguriert haben, sollten Sie den vollständigen Aufruf-Stack der Anwendung sehen, vom Controller bis zu den Service-Aufrufe, wie im folgenden Screenshot der Konsole gezeigt.