Skip to content
Spring Boot Starter for enabling a Prometheus actuator endpoint
Java
Branch: master
Clone or download
Latest commit a5a9de2 Aug 2, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper
src formatted code according to Google's Java Style Guide Jul 17, 2017
.gitignore
.travis.yml updated file to verify that source code is formatted according to Goo… Jul 17, 2017
README.md
build.gradle updated sonatype setup to reflect appropriate github username Aug 2, 2017
gradlew initial commit Feb 6, 2017
gradlew.bat

README.md

A Spring Boot Starter for Prometheus

This is Spring Boot Starter module for activating a Prometheus endpoint in Spring Boot applications.

Build Status Maven Central

What you get

A new Spring Boot Actuator endpoint - designed for Prometheus:

http://localhost:8080/prometheus

If you curl that you will get something like:

# HELP heap_used heap_used
# TYPE heap_used gauge

Exactly how Prometheus likes it.

How you get it

It's as easy as any other Spring Boot Starter ;). Find your recipe below...

Gradle:

compile "com.moelholm:prometheus-spring-boot-starter:1.0.1"

Maven:

<dependency>
  <groupId>com.moelholm</groupId>
  <artifactId>prometheus-spring-boot-starter</artifactId>
  <version>1.0.1</version>
</dependency>

Configuration

You can configure 2 x properties - here shown with their default values:

endpoints.prometheus.path      = /prometheus

endpoints.prometheus.sensitive = false

Same configuration as you will find with the standard Spring Boot Actuator endpoints.

Alternatives

There are other starters as well:

Both actually existed at the time I started development of this starter. The first one is simple but lacks two things: being in the Maven Central and using Spring Boot Actuator endpoints. The second one is very much like this starter - but additionally comes with health indicator information as well. Personally I found the implementation a bit complex - contrary to Thomas' implementation. Hence this starter: a kind of mashup ;)

You can’t perform that action at this time.