Wie exportieren Sie Metriken aus einer Spring Boot-Anwendung in Prometheus?

Question

Ich habe eine einfache Maven Spring-Boot-Anwendung (Java) und verwende Prometheus, um daraus metrische Informationen zu sammeln. Ich habe alle notwendigen Prometheus-Abhängigkeiten in meiner Pom-Datei und habe die @EnablePrometheusEndpoint-Annotation in meine @SpringBootApplication-Klasse eingefügt, aber wenn ich meine Anwendung starte und versuche, auf die Metriken von localhost: 8080/prometheus zuzugreifen (was ich denke der Standard-Endpunkt, wo Prometheus Instrumentierung Metriken sendet?), bekomme ich einen 401 Fehler. Habe ich meine Anwendung korrekt instrumentiert, sodass Metriken mithilfe der @EnablePrometheusEndpoint-Annotation von Prometheus gesammelt werden können? Wo zeigt Prometheus meine instrumentierten Metriken (ist es in localhost: 8080/prometheus)? Ich habe auch versucht, diese Metriken in localhost: 8080/metrics zu suchen, aber kein Glück. Jede Hilfe wird sehr geschätzt.

@SpringBootApplication 
@RestController 
@EnablePrometheusEndpoint 
public class Example { 

    //Just a logger that keeps track of relevant information: 
    private static final Logger LOGGER = Logger.getLogger(Example.class.getName()); 

    //counter for counting how many times an endpoint has been hit 
    static final Counter myCounter = Counter.build()  
               .name("CounterName") //note: by convention, counters should have "_total" suffix 
               .help("Total requests recorded by a specific endpoint") 
               .labelNames("status") 
               .register(); 
    @RequestMapping("/hello") 
    String hello() { 

     myCounter.labels("customLabel1").inc(); //increment the number of requests by one 
     LOGGER.log(Level.INFO, "Number of times /hello has been hit: " + myCounter.labels("customLabel1").get()); 

     return "Hello world! This is an example response!"; 
    } 

    @RequestMapping("/homepage") 
    String homePage() { 

     myCounter.labels("customLabel2").inc(); //increment the number of requests by one 
     LOGGER.log(Level.INFO, "Number of times /homepage has been hit: " + myCounter.labels("customLabel2").get()); 

     return "this is the home page!!"; 
    } 


    public static void main(String[] args) throws Exception { 
     SpringApplication.run(Example.class, args); 
    } 

} 

Unten ist meine pom.xml-Datei:

<?xml version="1.0" encoding="UTF-8"?> 
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 
    <modelVersion>4.0.0</modelVersion> 

    <groupId>com.example</groupId> 
    <artifactId>springboot</artifactId> 
    <version>0.0.1-SNAPSHOT</version> 

    <parent> 
     <groupId>org.springframework.boot</groupId> 
     <artifactId>spring-boot-starter-parent</artifactId> 
     <version>1.5.8.RELEASE</version> 
    </parent> 
    <dependencies> 
     <dependency> 
      <groupId>org.springframework.boot</groupId> 
      <artifactId>spring-boot-starter-web</artifactId> 
     </dependency> 


     <!-- Prometheus dependencies --> 
     <!-- The client --> 
     <dependency> 
      <groupId>io.prometheus</groupId> 
      <artifactId>simpleclient</artifactId> 
      <version>0.1.0</version> 
     </dependency> 

     <dependency> 
      <groupId>io.prometheus</groupId> 
      <artifactId>simpleclient_spring_boot</artifactId> 
      <version>0.1.0</version> 
     </dependency> 

     <dependency> 
      <groupId>io.prometheus</groupId> 
      <artifactId>simpleclient_servlet</artifactId> 
      <version>0.1.0</version> 
     </dependency> 
     <!-- Hotspot JVM metrics --> 
     <dependency> 
      <groupId>io.prometheus</groupId> 
      <artifactId>simpleclient_hotspot</artifactId> 
      <version>0.1.0</version> 
     </dependency> 
     <!-- Exposition HTTPServer --> 
     <dependency> 
      <groupId>io.prometheus</groupId> 
      <artifactId>simpleclient_httpserver</artifactId> 
      <version>0.1.0</version> 
     </dependency> 
     <!-- Pushgateway exposition --> 
     <dependency> 
      <groupId>io.prometheus</groupId> 
      <artifactId>simpleclient_pushgateway</artifactId> 
      <version>0.1.0</version> 
     </dependency> 

     <!-- Spring Boot Actuator for exposing metrics --> 
     <dependency> 
      <groupId>org.springframework.boot</groupId> 
      <artifactId>spring-boot-starter-actuator</artifactId> 
      <version>1.5.8.RELEASE</version> 
     </dependency> 


    </dependencies> 


</project> 

Und unten ist meine prometheus.yml Datei gesetzt (glaube ich) meine Feder-Boot-App auf localhost zu kratzen: 8080 in den letzten paar Zeilen:

# my global config 
global: 
    scrape_interval:  15s # Set the scrape interval to every 15 seconds. Default is every 1 minute. 
    evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute. 
    # scrape_timeout is set to the global default (10s). 

    # Attach these labels to any time series or alerts when communicating with 
    # external systems (federation, remote storage, Alertmanager). 
    external_labels: 
     monitor: 'codelab-monitor' 

# Load rules once and periodically evaluate them according to the global 'evaluation_interval'. 
rule_files: 
    # - "first.rules" 
    # - "second.rules" 

# A scrape configuration containing exactly one endpoint to scrape: 
# Here it's Prometheus itself. 
scrape_configs: 
    # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config. 
    - job_name: 'prometheus' 

    # metrics_path defaults to '/metrics' 
    # scheme defaults to 'http'. 
    scrape_interval: 5s 

    static_configs: 
     - targets: ['localhost:9090'] 

#The following lines are meant to monitor my spring boot app 
    - job_name: 'hello_world_spring_boot' 
    scrape_interval: 5s 

    static_configs: 
     - targets: ['localhost:8080'] 

Dies ist, was ich sehe, wenn ich an meinem prometheus Armaturenbrett schauen, läuft auf localhost: 9090

Prometheus dashboard status 401 message

Answer 1

Ihr Prometheus bei http://localhost:8080/metrics (Standard) für Metriken suchen konfiguriert während @EnablePrometheusEndpoint bei http://localhost:8080/prometheus die Metriken aussetzt.

Sie sollten also metrics_path auf prometheus in Ihrem prometheus.yml setzen.

Das 401 passiert, weil standardmäßig der Endpunkt des Spring Boot Actuators metrics geschützt ist.