summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/springboot/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/springboot/README.md')
-rw-r--r--collectors/python.d.plugin/springboot/README.md47
1 files changed, 27 insertions, 20 deletions
diff --git a/collectors/python.d.plugin/springboot/README.md b/collectors/python.d.plugin/springboot/README.md
index b5b776dd0..75cfa22ee 100644
--- a/collectors/python.d.plugin/springboot/README.md
+++ b/collectors/python.d.plugin/springboot/README.md
@@ -6,11 +6,13 @@ Netdata can be used to monitor running Java [Spring Boot](https://spring.io/) ap
## 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`
+
+- 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;
@@ -65,26 +67,30 @@ Please refer [Spring Boot Actuator: Production-ready features](https://docs.spri
## Charts
-1. **Response Codes** in requests/s
- * 1xx
- * 2xx
- * 3xx
- * 4xx
- * 5xx
- * others
+1. **Response Codes** in requests/s
+
+ - 1xx
+ - 2xx
+ - 3xx
+ - 4xx
+ - 5xx
+ - others
+
+2. **Threads**
-2. **Threads**
- * daemon
- * total
+ - daemon
+ - total
-3. **GC Time** in milliseconds and **GC Operations** in operations/s
- * Copy
- * MarkSweep
- * ...
+3. **GC Time** in milliseconds and **GC Operations** in operations/s
-4. **Heap Mmeory Usage** in KB
- * used
- * committed
+ - Copy
+ - MarkSweep
+ - ...
+
+4. **Heap Mmeory Usage** in KB
+
+ - used
+ - committed
## Usage
@@ -93,6 +99,7 @@ The springboot module is enabled by default. It looks up `http://localhost:8080/
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>'
@@ -121,4 +128,4 @@ The dimension name of extras charts should replace `.` to `_`.
Please check [springboot.conf](springboot.conf) for more examples.
-[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fspringboot%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fspringboot%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)