Added spring-boot client

[tokuhirom]

I want to use spring-boot's metrics/health checking feature as a prometheus exporter.

ref.

• Create Exporter for Spring Boot Metrics prometheus#1190
• https://github.com/jimmidyson/spring-boot-prometheus

[brian-brazil]

I'm not too familiar with Spring, however this appears to be a mix of a wrapper, bridge, collector and exporter. Each of those should probably be separate.

[tokuhirom]

Okay, I'll split into modules.

[tokuhirom]

I split the module into following modules.

[tokuhirom]

I removed some over eringeering modules.
I want to add metrics_reader and metrics_writer.

[brian-brazil]

Why do you need this?

[tokuhirom]

Oops. Old implementation required this. But it was removed.

[tokuhirom]

I rewrote all of the code. Could you re-review this?

[brian-brazil]

You should put this in literally. Some build tools have problems with variables.

[tokuhirom]

Inlined a variable.

[brian-brazil]

That looks generally good, just some nits left.

[brian-brazil]

That's looking good.

Could you add a docstring demonstrating how to use it, and squash your commits?

[tokuhirom]

Thanks. I added docstring. And squashed commits.

[brian-brazil]

Thanks!

[haocheng]

Hi @tokuhirom ,

Would you please provide an example about how to use SpringBootMetricsCollector?
Is adding a @configuration class like the code below enough?

@Configuration
public class MetricsConfiguration {

    @Bean
    public SpringBootMetricsCollector springBootMetricsCollector(Collection<PublicMetrics> publicMetrics) {
      SpringBootMetricsCollector springBootMetricsCollector = new SpringBootMetricsCollector(publicMetrics);
      springBootMetricsCollector.register();
      return springBootMetricsCollector;
    }

}

Thank you!

[tokuhirom]

@ haocheng
Yes. it looks good.

Here is a complete example:

package com.example;

import io.prometheus.client.CollectorRegistry;
import io.prometheus.client.exporter.MetricsServlet;
import io.prometheus.client.hotspot.DefaultExports;
import io.prometheus.client.spring.boot.SpringBootMetricWriter;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.embedded.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class SpringBootPrometheusSampleApplication {

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

    @Bean
    public ServletRegistrationBean servletRegistrationBean() {
        DefaultExports.initialize();
        return new ServletRegistrationBean(new MetricsServlet(), "/prometheus");
    }

    @Bean
    public SpringBootMetricWriter springBootMetricWriter() {
        return new SpringBootMetricWriter(CollectorRegistry.defaultRegistry);
    }
}

[haocheng]

Hi @tokuhirom ,

Thank you for the great work! It works like a charm ;)

BTW, I cannot find SpringBootMetricWriter, but using SpringBootMetricsCollector instead works fine.

import io.prometheus.client.exporter.MetricsServlet;
import io.prometheus.client.hotspot.DefaultExports;
import io.prometheus.client.spring.boot.SpringBootMetricsCollector;
import java.util.Collection;
import org.springframework.boot.actuate.endpoint.PublicMetrics;
import org.springframework.boot.context.embedded.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MetricsConfiguration {

  @Bean
  public ServletRegistrationBean servletRegistrationBean() {
    DefaultExports.initialize();
    return new ServletRegistrationBean(new MetricsServlet(), "/prometheus");
  }

  @Bean
  public SpringBootMetricsCollector springBootMetricsCollector(Collection<PublicMetrics> publicMetrics) {
    SpringBootMetricsCollector springBootMetricsCollector = new SpringBootMetricsCollector(
        publicMetrics);
    springBootMetricsCollector.register();
    return springBootMetricsCollector;
  }

}

[robachmann]

@haocheng, where do you get the Collection<PublicMetrics> from? I'm getting a Could not autowire. No beans of 'PublicMetrics' or 'Collection<PublicMetrics>' types found error using your example with Spring Boot 1.4.1.
Thanks!

[haocheng]

@240ch um... I am still using Spring boot 1.3.3. Do you have spring-boot-actuator in your dependency lib? It seems that PublicMetrics is included in that library.

[johnmgibbons]

Is there a guide for how to use this? Trying to use spring boot's metrics as an exporter for prometheus.

Thanks!

[hakamairi]

@johnmgibbons try @haocheng 's code above and be sure to add following dependencies:

    compile "org.springframework.boot:spring-boot-starter-actuator"
    compile "io.prometheus:simpleclient:0.0.19"
    compile "io.prometheus:simpleclient_common:0.0.19"
    compile "io.prometheus:simpleclient_hotspot:0.0.19"
    compile "io.prometheus:simpleclient_servlet:0.0.19"
    compile "io.prometheus:simpleclient_spring_boot:0.0.19"

[hakamairi]

Hi @tokuhirom ,
I've tried your solution with Spring Boot 1.4.2 and Spring Cloud 1.1.6. When I have @EnabledDiscoveryClient on my main class and possibly "org.springframework.cloud:spring-cloud-starter-eureka" dependency I get in my /prometheus repeated lines like:

HELP counter_servo_eurekaclient_transport_request

Which makes Prometheus unhappy:

text format parsing error in line 88: second HELP line for metric name "counter_servo_eurekaclient_transport_request"

Is this my misconfiguration, or is this a bug?

EDIT:
I've done some debugging

this.publicMetrics = {LinkedHashMap$LinkedValues@7351} size = 4
0 = {MetricReaderPublicMetrics@7356}
metricReader = {ServoMetricReader@7360}
monitorRegistry = {DefaultMonitorRegistry@7361}
registry = {BasicMonitorRegistry@7363}
monitors = {Collections$SynchronizedSet@7364} size = 119
publicMetrics.txt

There you can see that for requests they actually use the same name but different id and/or status.
This gets lost in translation, and results in duplicated counter/gauges for prometheus
prometheus.txt

I think just changing the logic in SpringBootMetricsCollector to generate a name of the Metric to account for that should be enough. Shall I open a bug report?

EDIT:
I've tried to fix that myself, found that org.springframework.boot.actuate.metrics.Metric is actually pretty simple with no Ids or Statuses.
The metric to blame comes from com.netflix.servo.monitor package. I've ended up filtering those out. Not nice, but at least some workaround is possible.

[JasonBeiJing]

hey, you just need add @EnableSpringBootMetricsCollector, DONE.
if u check the source code, u will find that EnableSpringBootMetricsCollector imports the configuration: PrometheusMetricsConfiguration which defines the actual implementation.