Add documentation

Author: amanteaux

plume-web-jersey-monitoring/README.md

@@ -65,6 +65,8 @@ to provide some basic functionality for monitoring your application's metrics (C
 Exposed API :
 - `registerMetric`: Register metrics to monitor
 - `registerJvmMetrics`: Register the basic JVM metrics to monitor
+- `registerGrizzlyMetrics`: Register metrics for Grizzly HTTP threads pool, see [Jersey module](../plume-web-jersey) for usage documentation on `GrizzlyThreadPoolProbe` 
+- `registerHikariMetrics`: Register metrics for HikariCP SQL connections pool
 - `build`: create a metrics provider that provides the status of the metrics that are monitored.
 
 
@@ -87,7 +89,13 @@ public class MonitoringWs {
     private final BasicAuthenticator<String> basicAuthenticator;
 
     @Inject
-    public MonitoringWs(ApplicationInfoProvider applicationInfoProvider, TransactionManager transactionManager) {
+    public MonitoringWs(
+        ApplicationInfoProvider applicationInfoProvider,
+        TransactionManager transactionManager,
+        GrizzlyThreadPoolProbe grizzlyThreadPoolProbe,
+        HikariDataSource hikariDataSource,
+        InternalApiAuthenticator apiAuthenticator
+    ) {
         this.applicationInfo = applicationInfoProvider.get();
         // Registering health checks
         this.healthStatusProvider = new HealthCheckBuilder()
@@ -97,14 +105,12 @@ public class MonitoringWs {
         // Registering metrics to monitor
         this.metricsStatusProvider = new MetricsCheckBuilder()
             .registerJvmMetrics()
+            .registerGrizzlyMetrics(grizzlyThreadPoolProbe)
+            .registerHikariMetrics(hikariDataSource)
             .build();
 
         // Require authentication to access monitoring endpoints
-        this.basicAuthenticator = BasicAuthenticator.fromSingleCredentials(
-            "plume",
-            "rocks",
-            "Plume showcase"
-        );
+        this.basicAuthenticator = apiAuthenticator.get();
     }
 
     @GET

plume-web-jersey/README.md

@@ -213,7 +213,7 @@ One sample valid request: `curl -H 'Authorization: Bearer my-bearer-token' 'http
 
 ### Resource authorization based on annotation
 This feature is provided `AuthorizationSecurityFeature` and works with any authentication system.
-For example using bearer auth:
+For example, using bearer auth:
 - In the `JerseyConfigProvider` file, declare the feature with the annotation used for resource identification: `config.register(new BearerAuthenticator("my-bearer-token").toAuthorizationFeature(BearerRestricted.class));`
 - In the `JerseyConfigProvider` file, register if needed the annotation used in the `RequireExplicitAccessControlFeature`: `config.register(RequireExplicitAccessControlFeature.accessControlAnnotations(PublicApi.class, BearerRestricted.class));`
 - Use the annotation in a resource definition:
@@ -237,3 +237,14 @@ public class ExampleWs {
 
 ### Permissions based authorization
 TODO to details
+
+Grizzly HTTP Thread pool monitoring
+-----------------------------------
+Grizzly worker threads pool can be monitored using `GrizzlyThreadPoolProbe`.
+
+Usage:
+1. Declare an instance of `GrizzlyThreadPoolProbe`
+2. Use this instance in Grizzly configuration: `httpServer.getServerConfiguration().getMonitoringConfig().getThreadPoolConfig().addProbes(grizzlyThreadPoolProbe)`
+3. Access metrics in the `GrizzlyThreadPoolProbe` instance, e.g. `grizzlyThreadPoolProbe.getPoolUsageSize()`
+
+This can be used in the `MonitoringWs` class defined in the [Jersey monitoring module](../plume-web-jersey-monitoring)

plume-web-jersey/src/main/java/com/coreoz/plume/jersey/grizzly/GrizzlyThreadPoolProbe.java

@@ -8,6 +8,13 @@
 import jakarta.inject.Singleton;
 import java.util.concurrent.atomic.AtomicInteger;
 
+/**
+ * A Grizzly thread pool probe to monitor Grizzly thread pool.<br>
+ * <br>
+ * Usage:<br>
+ * - Usage with Grizzly: <code>httpServer.getServerConfiguration().getMonitoringConfig().getThreadPoolConfig().addProbes(grizzlyThreadPoolProbe);</code><br>
+ * - Metrics can be fetched using: {@link #getPoolUsageSize()} and {@link #getPoolMaxSize()} and {@link #getPoolCurrentSize()} and {@link #getTasksWaitingSize()}
+ */
 @Singleton
 public class GrizzlyThreadPoolProbe implements ThreadPoolProbe {
     private static final Logger logger = LoggerFactory.getLogger(GrizzlyThreadPoolProbe.class);
@@ -20,18 +27,30 @@ public class GrizzlyThreadPoolProbe implements ThreadPoolProbe {
 
     /* Stats accessors */
 
+    /**
+     * The maximum number of worker threads in the HTTP threads pool
+     */
     public int getPoolMaxSize() {
         return poolMaxSize;
     }
 
+    /**
+     * The current number of worker threads in the HTTP threads pool
+     */
     public int getPoolCurrentSize() {
         return poolCurrentSize;
     }
 
+    /**
+     * The number of worker threads currently in use
+     */
     public int getPoolUsageSize() {
         return poolUsageSize.get();
     }
 
+    /**
+     * The number of tasks that are waiting because all the worker threads are in use
+     */
     public int getTasksWaitingSize() {
         return tasksWaitingSize.get();
     }