diff options
Diffstat (limited to 'collectors/python.d.plugin/springboot')
| -rw-r--r-- | collectors/python.d.plugin/springboot/README.md | 24 | ||||
| -rw-r--r-- | collectors/python.d.plugin/springboot/springboot.chart.py | 6 | ||||
| -rw-r--r-- | collectors/python.d.plugin/springboot/springboot.conf | 8 |
3 files changed, 26 insertions, 12 deletions
diff --git a/collectors/python.d.plugin/springboot/README.md b/collectors/python.d.plugin/springboot/README.md index 37b4dd7cb..f38e8bf05 100644 --- a/collectors/python.d.plugin/springboot/README.md +++ b/collectors/python.d.plugin/springboot/README.md @@ -1,6 +1,12 @@ -# springboot +<!-- +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" +--> -This module will monitor one or more Java Spring-boot applications depending on configuration. +# 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 @@ -87,14 +93,20 @@ Please refer [Spring Boot Actuator: Production-ready Features](https://docs.spri - MarkSweep - ... -4. **Heap Mmeory Usage** in KB +4. **Heap Memory Usage** in KB - used - committed ## Usage -The springboot module is enabled by default. It looks up `http://localhost:8080/metrics` and `http://127.0.0.1:8080/metrics` to detect Spring Boot application by default. You can change it by editing `/etc/netdata/python.d/springboot.conf` (to edit it on your system run `/etc/netdata/edit-config python.d/springboot.conf`). +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. @@ -126,6 +138,8 @@ 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](springboot.conf) for more examples. +Please check +[springboot.conf](https://raw.githubusercontent.com/netdata/netdata/master/collectors/python.d.plugin/springboot/springboot.conf) +for more examples. [](<>) diff --git a/collectors/python.d.plugin/springboot/springboot.chart.py b/collectors/python.d.plugin/springboot/springboot.chart.py index eec870ebf..dbe11d6b8 100644 --- a/collectors/python.d.plugin/springboot/springboot.chart.py +++ b/collectors/python.d.plugin/springboot/springboot.chart.py @@ -4,8 +4,8 @@ # SPDX-License-Identifier: GPL-3.0-or-later import json -from bases.FrameworkServices.UrlService import UrlService +from bases.FrameworkServices.UrlService import UrlService DEFAULT_ORDER = [ 'response_code', @@ -92,7 +92,7 @@ class Service(UrlService): try: data = json.loads(raw_data) except ValueError: - self.debug('%s is not a vaild JSON page' % self.url) + self.debug('%s is not a valid JSON page' % self.url) return None result = { @@ -146,7 +146,7 @@ class Service(UrlService): } for line in lines: - dimension = line.get('dimension', None) or self.die('dimension is missing: %s' % chart_id) + dimension = line.get('dimension', None) or self.die('dimension is missing: %s' % chart_id) name = line.get('name', dimension) algorithm = line.get('algorithm', 'absolute') multiplier = line.get('multiplier', 1) diff --git a/collectors/python.d.plugin/springboot/springboot.conf b/collectors/python.d.plugin/springboot/springboot.conf index 13a398955..0cb369cd8 100644 --- a/collectors/python.d.plugin/springboot/springboot.conf +++ b/collectors/python.d.plugin/springboot/springboot.conf @@ -75,7 +75,7 @@ # # Configuration example # --------------------- -# expample: +# example: # name: 'example' # url: 'http://localhost:8080/metrics' # defaults: @@ -96,17 +96,17 @@ # options: { title: 'Eden Memory Usage', units: 'KB', family: 'heap memory', context: 'springboot.heap_eden', charttype: 'area' } # lines: # - { dimension: 'mempool_eden_used', name: 'used'} -# - { dimension: 'mempool_eden_committed', name: 'commited'} +# - { dimension: 'mempool_eden_committed', name: 'committed'} # - id: 'heap_survivor' # options: { title: 'Survivor Memory Usage', units: 'KB', family: 'heap memory', context: 'springboot.heap_survivor', charttype: 'area' } # lines: # - { dimension: 'mempool_survivor_used', name: 'used'} -# - { dimension: 'mempool_survivor_committed', name: 'commited'} +# - { dimension: 'mempool_survivor_committed', name: 'committed'} # - id: 'heap_tenured' # options: { title: 'Tenured Memory Usage', units: 'KB', family: 'heap memory', context: 'springboot.heap_tenured', charttype: 'area' } # lines: # - { dimension: 'mempool_tenured_used', name: 'used'} -# - { dimension: 'mempool_tenured_committed', name: 'commited'} +# - { dimension: 'mempool_tenured_committed', name: 'committed'} local: |