Prometheus UI, Grafana settings for spring boot application - spring

I am using spring boot 2.0 and added the below dependencies in POM
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
</dependency>
My application.yml looks like this
management.endpoints.web.base-path = /manage
management.endpoints.web.exposure.include = "*"
endpoints.prometheus.enabled = true
when I access Prometheus at
localhost/manage/prometheus
I am able to see all the metrics.
Next, my target is to see the above metrics in Prometheus UI. For this, I added the below dependencies in my POM
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>simpleclient_spring_boot</artifactId>
<version>${prometheus.version}</version>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>simpleclient_hotspot</artifactId>
<version>${prometheus.version}</version>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>simpleclient_servlet</artifactId>
<version>${prometheus.version}</version>
</dependency>
What are the next steps for me to see metrics in Prometheus UI, final target is to integrate Prometheus to Grafana.
PS: I did a search on google and tried adding prometheus.yml and adding annotations like #EnablePrometheusEndpoint nothing worked as all the articles are old.
Edit : Also how to configure prometheus.yml ( metrics_path, targets)if the spring boot jar is hosted in different host (Azure/AWS) and prometheus server is in different host.

If you are using Spring Boot 2 and micrometer you don't need to add the extra dependencies, they are imported when you added micrometer-registry-prometheus. if you are able to see the metrics on localhost/manage/prometheus your configuration on the spring-boot side is fine. there is no need to configure anything more.
To see the metrics in Prometheus you need:
install Prometheus Server https://prometheus.io/docs/prometheus/latest/installation/
configure Prometheus to scrape (pull) the metrics from your server. for that you will need to modify the prometheus.yml file by adding a new job (don't forget to restart Prometheus after changing the yml file)
scrape_configs:
- job_name: 'mySpringBoot'
metrics_path: '/manage/prometheus'
static_configs:
- targets: ['springBootHost:springBootPort']
once this is configured, go to the Prometheus UI, check that the target is UP - http://localhost:9090/targets (assuming Prometheus runs on localhost)
if you don't see your target or you see it as DOWN there is a configuration or network problem.
the following steps are straight forward, with lot of documentation elsewhere:
next step is to install Grafana
now configure Prometheus as a data-source in Grafana
start plotting your metrics.

Spring boot api application configure with prometheus and grafana on windows.
Create spring boot application and add dependency in pom.xml -
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-core</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
</dependency>
if its running go to your browser and type ‘http://localhost:8080/actuator/prometheus’ and you will get all metrics.
Download and install Prometheus Server https://prometheus.io/download/
and extract the zip and run prometheus exe.
for that you will need to modify the prometheus.yml file by adding a new job (don't forget to restart Prometheus after changing the yml file)
Note : configure spring application with prometheus.
scrape_configs:
- job_name: 'SpringBootApplicationName
metrics_path: ‘actuator-prometheus'
static_configs:
- targets: [‘IPADDRESS:springBootApplicationPort]
once this is configured, go to the Prometheus UI, check that the target is UP - http://localhost:9090/targets (assuming Prometheus runs on localhost)
go to ‘http://localhost:8080/actuator/prometheus’ and select one metrics and paste in - http://localhost:9090/graph and click on execute. example you can select one CPU and HTTP metric like - ‘http_server_request_seconds_max’
the following steps are straight forward, with lot of documentation elsewhere:
next step is to install Grafana from - https://grafana.com/grafana/download?platform=windows
and extract the zip and run the grafana-server.exe and check on your browser ‘http://localhost:3000’
now login as a default username ‘’admin and password ‘admin’ and go to setting select the deshboard and create a datasource and select prometheus and type url of prometheus like - ‘’http://ipaddress:pord of prometheus.
and go to graph and click edit and select datasource and type your metric query like ‘http_server_request_seconds_max’
9.start plotting your metrics.

Related

How to externalize spring.cloud.vault.* properties to a spring cloud config server

I am using spring boot 2.7.8
I am following this https://docs.spring.io/spring-cloud-vault/docs/current/reference/html/#client-side-usage and https://docs.spring.io/spring-cloud-config/docs/current/reference/html/#_client_side_usage
I have a spring cloud config server too which hosts the externalized properties for my application. So my pom.xml has below
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-vault-config</artifactId>
</dependency>
I can point to the external spring cloud config server using the below in my properties file
spring.config.import=optional:configserver:http://myconfigserver.com
But as per https://docs.spring.io/spring-cloud-vault/docs/current/reference/html/#client-side-usage, I still have to define spring.cloud.vault.* in my application properties? How can I move spring.cloud.vault.* properties into my spring cloud config server so that all my properties are externalized. I want to avoid having some properties within the application and some externalized.
Please help to clarify if I am misunderstanding this

Azure AppConfiguration with Spring Boot 2.5.x

Question
How to integrate an Azure AppConfiguration with SpringBoot 2.5.x or higher?
Info
Im trying to use an Azure AppConfiguration resource with a Spring Boot 2.5.4 project. Unfortunately I cant get it to read a setting from the AppConfiguration or even connect to it as far as I can tell.
The project is newly created with the Spring Initializr where I only added
Spring Boot Starter Web
Spring Boot Starter Security
Spring Boot Starter WebSocket
Afterwards I tried following the Microsoft Quickstart documentation with no success. The documentation mentions that its using Spring 2.4.x so I assume some changes broke it.
I also tried to identify the issue by looking through some Azure Spring Boot Code Samples.
All the examples so far use the bootstrap.properties file which I learned during my search so far is deprecated. Moving the settings to the application.yml or enabling use-legacy-processing: true did not work either. Any ideas?
pom.xml
...
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.4</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
...
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>azure-spring-cloud-appconfiguration-config</artifactId>
<version>2.0.0</version>
</dependency>
...
application.yml
spring:
config:
use-legacy-processing: true
profiles:
active: "develop"
application:
name: "MySampleService"
cloud:
azure:
appconfiguration:
stores:
- connection-string: "SomeAzureAppConfigurationResourceConnectionString"
label: ${spring.profiles.active}
#mysampleservice:
# message: "this is a message from file"
AppConfiguration Resource
Im not entirely sure about the format for the setting name. I tried to build the format based on this documentation.
The configuration classes should be fine since commenting in the mysampleservice causes the value of message beeing used.
Any hints are appreciated!
Some more info to elaborate on the accepted answer
The documentation linked in the answer refers to two different packages. The one linked right at the start in the maven repository is spring-cloud-azure-appconfiguration-config while the one used further down is azure-spring-cloud-appconfiguration-config. The second one works with the bootstrap.properties file.
Working pom.xml and bootstrap.properties:
...
<dependencies>
<!-- Dependency to load configuration from azure app configuration resource. Note that additional settings are required in bootstrap.properties
Documentation of settings: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/appconfiguration/azure-spring-cloud-starter-appconfiguration-config
-->
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>azure-spring-cloud-appconfiguration-config-web</artifactId>
<version>2.1.0</version>
</dependency>
...
# Use this to enable or disable the cloud config, disabling it results in application.yaml beeing used.
spring.cloud.azure.appconfiguration.enabled=true
# Connection string to azure app configuration resource
spring.cloud.azure.appconfiguration.stores[0].connection-string= Endpoint=https://myofficeconfiguration.azconfig.io;Id=zUcT-l9-s0:PFYfW7WM0/Pz7WZOnH3v;Secret=JTB9myJqGekDAJ5m8Z1vjmkJZrPd88JbOEE3EqoqJYs=
# Configured filters for settings in the previous defined app configuration resource
spring.cloud.azure.appconfiguration.stores[0].selects[0].key-filter = /mysampleservice/
spring.cloud.azure.appconfiguration.stores[0].selects[0].label-filter = Sample
spring.cloud.azure.appconfiguration.stores[0].selects[1].key-filter = /notificationservice/
spring.cloud.azure.appconfiguration.stores[0].selects[1].label-filter = Sample2
bootstrap.yml/bootstrap.properties can still be used, they are no longer part of the base Spring packages.
Also, you want to use this doc for 2.0.0 and newer https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/appconfiguration/azure-spring-cloud-starter-appconfiguration-config.

Spring Cloud not picking up configured profile in cloud.aws.credentials.profile-name

I have a spring boot application where I've been using Spring Cloud AWS.
I'm trying to add a new profile to my ~/.aws/credentials file like so:
[local-dev]
aws_access_key_id=localkey
aws_secret_access_key=localkey
in my application.yml file I've specified which profile to use.
cloud:
aws:
credentials:
profile-name: local-dev
region:
static: us-east-1
whenever I start up my Application I get a error saying:
No AWS profile named 'default', com.amazonaws.auth.EC2ContainerCredentialsProviderWrapper#1b26fac2: Failed to connect to service endpoint:
When I set the profile name to "default" it does work though. It's like spring is ignoring the profile-name that I've given it in the configuration.
Currently I have set this version of spring cloud in my maven POM file.
<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-aws -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-aws</artifactId>
<version>2.2.1.RELEASE</version>
</dependency>
I faced the same issue when using the same Spring Cloud Libraries version - 2.2.1.RELEASE.
After updating the Spring Cloud libraries to 2.2.6.RELEASE everything works fine.

spring eureka - Error resolving template [eureka/status], template might not exist or might not be accessible

I am following this tutorial to implement a microservice architecture within my project.
First I added the following dependencies to my project:
</dependencies>
...
<dependency>
<!-- Spring Cloud starter -->
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter</artifactId>
</dependency>
<dependency>
<!-- Eureka service registration - CHANGED -->
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Finchley.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
After that I added a registrationServer class to the project (as described in the tutorial) and set up my config.
The config of my registration server remain very basic:
# Ignore JDBC Dependency
# This demo puts 3 applicatons in the same project so they all pick up the
# JDBC Depdendency, but this application doesn't need it.
spring.autoconfigure.exclude: org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
# Configure this Discovery Server
eureka:
instance:
hostname: localhost
client: # Not a client, don't register with yourself
registerWithEureka: false
fetchRegistry: false
server:
port: 8761 # HTTP (Tomcat) port
Now as I understood it, at this point I should be able to access http://localhost:8761 and see my setup as tracked by the registration server.
Instead I get a Whitelabel Error Page containing the following error message:
Error resolving template [eureka/status], template might not exist or might not be accessible by any of the configured Template Resolvers
Note: Before adding Eureka, my project consisted of a REST application which I want now to transform into a microservice. The REST service contained a frontend which is organized in the project directories like this:
src
- main
- resources
- templates
- index.html
- static
- built
- bundle.js
Note 2: Also I tried to disable the thymeleaf template which led to an 404 error when trying to access http://localhost:8761.
# Discovery Server Dashboard uses FreeMarker. Don't want Thymeleaf templates
spring:
thymeleaf:
enabled: false # Disable Thymeleaf
datasource:
type: org.springframework.jdbc.datasource.SimpleDriverDataSource
As stated in this github issue:
If your project already uses Thymeleaf as its template engine, the Freemarker templates of the Eureka server may not be loaded correctly. In this case it is necessary to configure the template loader manually:
application.yml
spring:
freemarker:
template-loader-path: classpath:/templates/
prefer-file-system-access: false

Cannot include Prometheus metrics in spring boot 2 (version 2.0.0.M7)

Cannot include Prometheus metrics in spring boot 2 (version 2.0.0.M7) project.
According micrometer docs added spring-boot-starter-actuator dependency and in application.yaml added management.endpoints.web.expose: prometheus but when calling /actuator/prometheus get
{
"timestamp": 1518159066052,
"path": "/actuator/prometheus",
"message": "Response status 404 with reason \"No matching handler\"",
"status": 404,
"error": "Not Found"
}
Tell me please why I wasn't getting prometheus metrics?
I had trouble initiating micrometer with Springboot 2. x.
These changes in my project helped me to expose the metrics atactuator/prometheus endpoint
These are the changes in my application.properties file
management.endpoints.web.exposure.include=*
management.endpoint.metrics.enabled=true
My build.gradle file included
compile('org.springframework.boot:spring-boot-starter-web')
compile('org.springframework.boot:spring-boot-starter-actuator')
compile('io.micrometer:micrometer-registry-prometheus')
Edit: Since I gave this answer a lot has changed. It was valid for 2.0.0.RC1. Please read the documentation https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-metrics.html
If above solution doesn't work for someone try this:
I had the same issue with Spring Boot 2.0.0.RC1, spring-boot-starter-web and of course spring-boot-starter-actuator.
My application.properties file read:
management.endpoints.web.expose=prometheus,metrics,info,health
In my pom file I had additionally:
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>simpleclient</artifactId>
<version>0.2.0</version>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
<version>0.12.0.RELEASE</version>
</dependency>
Prometheus metrics under /actuator/prometheus where only shown after I had switched to the newest version of micrometer-registry-prometheus:
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
<version>1.0.0-rc.9</version>
</dependency>
Did you add micrometer-registry-prometheus to your dependecies?
Micrometer has a pluggable architecture where you need to define (by plugging dependencies) what monitoring system you'd like to work with. (You can even add multiple, not just one.)
Btw, you should be switching to Spring Boot 2.0.0.RC1. That's the current one as of this writing.
Recap:
pom.xml
<parent>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.5</version>
</parent>
... ... ...
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
</dependency>
application.properties.yml (aka. application.yml)
management.endpoints.web.exposure.include=health,info,prometheus
management.endpoint.metrics.enabled=true
management.endpoint.prometheus.enabled=true
management.endpoint.health.show-details=always
management.endpoint.health.show-components=always
management.endpoint.health.probes.enabled=true
management.metrics.tags.application=TheApplicationName
After applying all the above, health & info endpoints were displayed in the http://localhost:8080/actuator -list, but not the prometheus endpoint.
Of course, rerun the Maven lifecycle - still failing prometheus to be displayed ...
Finally my issue disappeared after invalidate caches and restart of my IntelliJ IDE

Resources