1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<!--
title: "Java Spring Boot 2 application monitoring with Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/springboot/README.md
sidebar_label: "Java Spring Boot 2 applications"
-->
# Java Spring Boot 2 application monitoring with Netdata
Monitors one or more Java Spring-boot applications depending on configuration.
Netdata can be used to monitor running Java [Spring Boot](https://spring.io/) applications that expose their metrics with the use of the **Spring Boot Actuator** included in Spring Boot library.
## Configuration
The Spring Boot Actuator exposes these metrics over HTTP and is very easy to use:
- add `org.springframework.boot:spring-boot-starter-actuator` to your application dependencies
- set `endpoints.metrics.sensitive=false` in your `application.properties`
You can create custom Metrics by add and inject a PublicMetrics in your application.
This is a example to add custom metrics:
```java
package com.example;
import org.springframework.boot.actuate.endpoint.PublicMetrics;
import org.springframework.boot.actuate.metrics.Metric;
import org.springframework.stereotype.Service;
import java.lang.management.ManagementFactory;
import java.lang.management.MemoryPoolMXBean;
import java.util.ArrayList;
import java.util.Collection;
@Service
public class HeapPoolMetrics implements PublicMetrics {
private static final String PREFIX = "mempool.";
private static final String KEY_EDEN = PREFIX + "eden";
private static final String KEY_SURVIVOR = PREFIX + "survivor";
private static final String KEY_TENURED = PREFIX + "tenured";
@Override
public Collection<Metric<?>> metrics() {
Collection<Metric<?>> result = new ArrayList<>(4);
for (MemoryPoolMXBean mem : ManagementFactory.getMemoryPoolMXBeans()) {
String poolName = mem.getName();
String name = null;
if (poolName.indexOf("Eden Space") != -1) {
name = KEY_EDEN;
} else if (poolName.indexOf("Survivor Space") != -1) {
name = KEY_SURVIVOR;
} else if (poolName.indexOf("Tenured Gen") != -1 || poolName.indexOf("Old Gen") != -1) {
name = KEY_TENURED;
}
if (name != null) {
result.add(newMemoryMetric(name, mem.getUsage().getMax()));
result.add(newMemoryMetric(name + ".init", mem.getUsage().getInit()));
result.add(newMemoryMetric(name + ".committed", mem.getUsage().getCommitted()));
result.add(newMemoryMetric(name + ".used", mem.getUsage().getUsed()));
}
}
return result;
}
private Metric<Long> newMemoryMetric(String name, long bytes) {
return new Metric<>(name, bytes / 1024);
}
}
```
Please refer [Spring Boot Actuator: Production-ready Features](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready) and [81. Actuator - Part IX. ‘How-to’ guides](https://docs.spring.io/spring-boot/docs/current/reference/html/howto.html#howto-actuator) for more information.
## Charts
1. **Response Codes** in requests/s
- 1xx
- 2xx
- 3xx
- 4xx
- 5xx
- others
2. **Threads**
- daemon
- total
3. **GC Time** in milliseconds and **GC Operations** in operations/s
- Copy
- MarkSweep
- ...
4. **Heap Memory Usage** in KB
- used
- committed
## Usage
Edit the `python.d/springboot.conf` configuration file using `edit-config` from the Netdata [config
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/springboot.conf
```
This module defines some common charts, and you can add custom charts by change the configurations.
The configuration format is like:
```yaml
<id>:
name: '<name>'
url: '<metrics endpoint>' # ex. http://localhost:8080/metrics
user: '<username>' # optional
pass: '<password>' # optional
defaults:
[<chart-id>]: true|false
extras:
- id: '<chart-id>'
options:
title: '***'
units: '***'
family: '***'
context: 'springboot.***'
charttype: 'stacked' | 'area' | 'line'
lines:
- { dimension: 'myapp_ok', name: 'ok', algorithm: 'absolute', multiplier: 1, divisor: 1} # it shows "myapp.ok" metrics
- { dimension: 'myapp_ng', name: 'ng', algorithm: 'absolute', multiplier: 1, divisor: 1} # it shows "myapp.ng" metrics
```
By default, it creates `response_code`, `threads`, `gc_time`, `gc_ope` abd `heap` charts.
You can disable the default charts by set `defaults.<chart-id>: false`.
The dimension name of extras charts should replace `.` to `_`.
Please check
[springboot.conf](https://raw.githubusercontent.com/netdata/netdata/master/collectors/python.d.plugin/springboot/springboot.conf)
for more examples.
|
