springboot2

README

Java Spring Boot 2 application monitoring with Netdata

This module monitors one or more Java Spring-boot 2 applications depending on configuration. Netdata can be used to monitor running Java Spring Boot 2 applications that expose their metrics with the use of the ** Spring Boot Actuator** included in Spring Boot library.

Springboot2 module looks up http://localhost:8080/actuator/prometheus and http://127.0.0.1:8080/actuator/prometheus to detect Spring Boot application by default.

Metrics

All metrics have "springboot2." prefix.

Metric	Scope	Dimensions	Units
response_codes	global	1xx, 2xx, 3xx, 4xx, 5xx	requests/s
thread	global	daemon, total	threads
heap	global	free, eden, survivor, old	B
heap_eden	global	used, commited	B
heap_survivor	global	used, commited	B
heap_old	global	used, commited	B
uptime	global	uptime	seconds

Configuration

Edit the go.d/springboot2.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/springboot2.conf

The Spring Boot Actuator exposes these metrics over HTTP and is very easy to use:

• add org.springframework.boot:spring-boot-starter-actuator and io.micrometer:micrometer-registry-prometheus to your application dependencies
• set management.endpoints.web.exposure.include=* in your application.properties

Please refer to the Spring Boot Actuator: Production-ready features and 81. Actuator - Part IX. ‘How-to’ guides for more information.

Here is an example for 2 servers:

jobs:
  - name: local
    url: http://localhost:8080/actuator/prometheus

  - name: remote
    url: http://203.0.113.10:8080/actuator/prometheus

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the springboot2 collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/
  

• Switch to the netdata user.

  sudo -u netdata -s
  

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m springboot2
  

Documentation

Index

• type Charts
• type Dims
• type SpringBoot2
  • func New() *SpringBoot2
  • func (SpringBoot2) Charts() *Charts
  • func (s *SpringBoot2) Check() bool
  • func (SpringBoot2) Cleanup()
  • func (s *SpringBoot2) Collect() map[string]int64
  • func (s *SpringBoot2) Init() bool

Types

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims

type SpringBoot2

type SpringBoot2 struct {
	module.Base

	web.HTTP  `yaml:",inline"`
	URIFilter matcher.SimpleExpr `yaml:"uri_filter"`
	// contains filtered or unexported fields
}

SpringBoot2 Spring boot 2 module

func New

func New() *SpringBoot2

New returns SpringBoot2 instance with default values

func (SpringBoot2) Charts

func (SpringBoot2) Charts() *Charts

Charts creates Charts

func (*SpringBoot2) Check

func (s *SpringBoot2) Check() bool

Check makes check

func (SpringBoot2) Cleanup

func (SpringBoot2) Cleanup()

Cleanup Cleanup

func (*SpringBoot2) Collect

func (s *SpringBoot2) Collect() map[string]int64

Collect collects metrics

func (*SpringBoot2) Init

func (s *SpringBoot2) Init() bool

Init makes initialization