Spring Boot Actuator 1.x

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

management.port=8081 
management.address=127.0.0.1

Podstawowe endpointy

• health
  
  Informuje nas (za pomocą statusu) o tym, czy nasza aplikacja w ogóle żyje. Podawany zakres informacji jest różny w zależności od tego czy jesteśmy uwierzytelnieni, czy nie:
  
• info
  
  Wyświetla informacje o aplikacji. Taka informacja musi być jednak przygotowana przez nas. Jeśli nie ustawimy dodatkowych własności w pliku application.properties, na przykład:

  info.app.name=StartAPPa 
  info.app.description=Aplikacja firmy JavAPPa
  info.app.version=1.0.0
  

  wówczas zobaczymy jedynie pustą stronę:
  
• metrics
  
  Wyświetla całkiem pokaźny zbiór informacji o stanie zasobów, na przykład:

  "mem": 617698,
  "mem.free": 210901,
  "processors": 4,
  "instance.uptime": 20614,
  "uptime": 31396,
  
  ...
  
  "threads": 24,
  "classes": 10247,
  "classes.loaded": 10247,
  
  ...
  
  "httpsessions.active": 0,
  "datasource.primary.active": 0,
  "datasource.primary.usage": 0
  

  Dosyć istotnym wskaźnikiem może się okazać na przykład liczba pracujących wątków.
• trace
  
  Wyświetla informacje na temat ostatniego ruchu w naszej aplikacji:

  {
      "timestamp": 1554833146830,
      "info": {
          "method": "GET",
          "path": "/kurs-spring/spring-aop-aspectj",
          "headers": {
          "request": ... 
  
          ...
  
      response": {
          ...
          
          "Content-Type": "text/html;charset=UTF-8",
          "Content-Language": "en-US",
          "Transfer-Encoding": "chunked",
          "Date": "Tue, 09 Apr 2019 18:05:46 GMT",
          "status": "200"
          
       ...
  }
  
  
  

  Możemy podejrzeć w ten sposób żądania i odpowiedzi. Dostaniemy dzięki temu wiele cennych informacji, na przykład jaka przyszła odpowiedź na wywołanie konkretnego żądania. Pozwala to na szybką zdalną diagnozę ewentualnego problemu, o którym się dowiedzieliśmy.
• env
  
  Wyświetla całą masę informacji o środowisku, w którym jest uruchomiona aplikacja, jak również konfigurację samej aplikacji:

  
  "profiles": [
      "user"
  ],
  
  ...
  
  applicationConfig: [classpath:/application.properties]": {
      "endpoints.sensitive": "true",
      "spring.http.multipart.max-file-size": "3MB",
      "logging.level.org.hibernate.type": "TRACE",
      "management.port": "8081 ",
      
      ...
      
  }
  

  Widzimy na przykład z jakimi profilami nasza aplikacja została uruchomiona, albo też jakie ustawienia posiada załadowany plik properties.
• beans
  
  Wyświetla informacje o beanach jakie działają w aplikacji. Możemy nawet zobaczyć jaki jest scope danego beana:

  "beans": [
  {
      "bean": "application",
      "scope": "singleton",
      "type": ...,
      "resource": ...,
      "dependencies": [
          ...
      ]
  }
  

Własny endpoint

@Component
public class SourceFileCheckerEndpoint implements Endpoint<List<String>> {
     
    @Override
    public String getId() {
        return "sourcefilechecker";
    }
 
    @Override
    public boolean isEnabled() {
        return true;
    }
 
    @Override
    public boolean isSensitive() {
        return true;
    }
 
    @Override
    public List<String> invoke() {
        
        // Tutaj wywołamy logikę
        
        List<String> messages = new ArrayList<>();
        messages.add("Informacje do wyświetlenia, na przykład wielkość pliku");
        
        return messages;
    }
}   

Dodatkowa konfiguracja Actuatora

• endpoints.sensitive=true lub false
  
  Ustawia wszystkie endpointy jako wrażliwe (wymagające uwierzytelnienia) lub nie (na odwrót). Nazwę użytkownika oraz hasło możemy też ustawić z poziomu pliku application.properties:

  security.user.name=mojuser
  security.user.password=mojehaslo   
  
• endpoints.<nazwa endpointa>.sensitive=true lub false
  
  Ustawia wybrany endpoint jako wrażliwy lub nie. Możemy na przykład najpierw ustawić wszystkie endpointy jako wrażliwe endpoints.sensitive=true, a następnie wyłączyć z tego endpoint, np. info za pomocą: endpoints.info.sensitive=false.
• endpoints.enabled=true lub false
  
  Włącza lub wyłącza wszystkie endpointy.
• endpoints.<nazwa endpointa>.enabled=true lub false
  
  Podobna zależność jak w przypadku wrażliwości.