GSIP 175
Proposal to promote the community status-monitoring
module to an extension:
Nuno Oliveira
This proposal is for GeoServer 2.16-RC
- Setup
- Under Discussion
- In Progress
- Completed
- Rejected
- Deferred
The status-monitoring
community module provides a straightforward access to the server \ VM resources status where GeoServer is running. This is very useful for small or medium installations, which are quite common, that don't have a full featured monitoring system configured. This module also removes the need of having SSH (or other) access to the server \ VM to check the most common resources status (RAM, disk, CPU, etc ...).
This module has been around for a fair amount of time (contributed September 2017), and has been successfully running in several production environments. Library OSHI is used to retrieving system-level information without depending on native libraries or DLLs, relying solely on Apache JNA. Major operating systems (Linux, Windows and MacOX) are supported out of the box. If a specific sensor is no available it will be ignored and listed has NOT AVAILABLE
.
To move the community status-monitoring
module to extension status. The status-monitoring
module has been a community module for a long time (contributed September 2017), and has been successfully running in several production environments since then.
No other community module or extension offers similar fucntionality.
At this point, the module already satisfy many of the requirements for promotion:
- The module have at least a "handful" of users: it is installed and running in several production environments, although I cannot produce an evidence of that, apart from the fact that we are investing in promoting it to an official extension and step forward has its maintainer.
- The module have a designated and active maintainer: Nuno Oliveira will be the official maintainer.
- The module is considered "stable" by the majority of the PSC.
- The module maintains 40% test coverage: The package scores a 96% line coverage with Jacoco.
- The module has no IP violations.
- The module has a page in the user manual, Status Monitoring
- The maintainer (Nuno Oliveira) has signed the GeoServer Contributor Agreement.
Feedback has focused on renaming to "system" (as monitoring already in use) and adding this to "core" rather than as extension (given its maturity and usefulness):
- System status to gs-main package org.geoserger.systemstatus
- Web classes to gs-web-core package org.geoserver.web.systemstatus
- Rest classes to gs-restconfig package org.geoserver.rest.systemstatus
- Move documentation to configuration/status.rst
Project Steering Committee:
- Alessio Fabiani: +1
- Andrea Aime: +1
- Brad Hards: +0
- Ian Turton: +1
- Jody Garnett: +1
- Jukka Rahkonen: +1
- Kevin Smith: +1
- Simone Giannecchini: +1
©2022 Open Source Geospatial Foundation