Create health check for size of the log files #35

application-admintools-api/pom.xml

@@ -31,11 +31,20 @@
   <name>Admin Tools (Pro) - API</name>
   <description>Provides the Java APIs needed by the Admin tools Application.</description>
   <dependencies>
+    <dependency>
+      <groupId>javax.ws.rs</groupId>
+      <artifactId>jsr311-api</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.xwiki.commons</groupId>
       <artifactId>xwiki-commons-component-api</artifactId>
       <version>${commons.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.xwiki.platform</groupId>
+      <artifactId>xwiki-platform-job-api</artifactId>
+      <version>${platform.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.xwiki.platform</groupId>
       <artifactId>xwiki-platform-rest-server</artifactId>

application-admintools-api/src/main/java/com/xwiki/admintools/health/HealthCheck.java

@@ -0,0 +1,42 @@
+/*
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package com.xwiki.admintools.health;
+
+import org.xwiki.component.annotation.Role;
+import org.xwiki.stability.Unstable;
+
+/**
+ * Check for issues in the current wiki.
+ *
+ * @since 1.0
+ * @version $Id$
+ */
+@Role
+@Unstable
+public interface HealthCheck
+{
+    /**
+     * Execute the health check on the wiki instance.
+     *
+     * @return a {@link HealthCheckResult} with {@code null} values if no issue was found, or with initialized values
+     * otherwise.
+     */
+    HealthCheckResult check();
+}

application-admintools-api/src/main/java/com/xwiki/admintools/health/HealthCheckResult.java

@@ -0,0 +1,121 @@
+/*
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package com.xwiki.admintools.health;
+
+import org.xwiki.stability.Unstable;
+
+/**
+ * Result of a health check. May store the error message, severity level, recommendation and the current value of the
+ * checked resource. The severity level is used as "info", for informative result, "warn" for warnings and "error"
+ * for critical issues.
+ *
+ * @version $Id$
+ * @since 1.0
+ */
+@Unstable
+public class HealthCheckResult
+{
+    private String message;
+
+    private String recommendation;
+
+    private String level;
+
+    private String currentValue;
+
+    /**
+     * Used for registering a result.
+     *
+     * @param message error message representing the summary of the found issue.
+     * @param recommendation suggestion in context of the message.
+     * @param level severity level of a result.
+     * @param currentValue Current value of the checked resource.
+     */
+    public HealthCheckResult(String message, String recommendation, String level, String currentValue)
+    {
+        this.message = message;
+        this.recommendation = recommendation;
+        this.level = level;
+        this.currentValue = currentValue;
+    }
+
+    /**
+     * Partial result definition.
+     *
+     * @param message error message representing the summary of the found issue.
+     * @param recommendation suggestion in context of the message.
+     * @param level severity level of a result.
+     */
+    public HealthCheckResult(String message, String recommendation, String level)
+    {
+        this(message, recommendation, level, null);
+    }
+
+    /**
+     * Simple result definition.
+     *
+     * @param message error message representing the summary of the found issue.
+     * @param level severity level of a result.
+     */
+    public HealthCheckResult(String message, String level)
+    {
+        this(message, null, level);
+    }
+
+    /**
+     * Get the error body.
+     *
+     * @return a summary of the error.
+     */
+    public String getMessage()
+    {
+        return message;
+    }
+
+    /**
+     * Get the recommendation for the set error.
+     *
+     * @return a suggestion for fixing the error.
+     */
+    public String getRecommendation()
+    {
+        return recommendation;
+    }
+
+    /**
+     * Get the severity level a detected error.
+     *
+     * @return the severity level of an error.
+     */
+    public String getLevel()
+    {
+        return level;
+    }
+
+    /**
+     * Get the value of a checked resource.
+     *
+     * @return the value of a checked resource.
+     */
+    public String getCurrentValue()
+    {
+        return currentValue;
+    }
+}

application-admintools-api/src/main/java/com/xwiki/admintools/jobs/HealthCheckJobRequest.java

@@ -0,0 +1,59 @@
+/*
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package com.xwiki.admintools.jobs;
+
+import java.util.List;
+
+import org.xwiki.job.AbstractRequest;
+import org.xwiki.stability.Unstable;
+
+/**
+ * Represents a request to start a health check on current wiki.
+ *
+ * @version $Id$
+ * @since 1.0
+ */
+@Unstable
+public class HealthCheckJobRequest extends AbstractRequest
+{
+    /**
+     * Default constructor.
+     */
+    public HealthCheckJobRequest()
+    {
+        setDefaultId();
+    }
+
+    /**
+     * Creates a request specific to the wiki from which the call was made.
+     *
+     * @param requestId the ID for the request.
+     */
+    public HealthCheckJobRequest(List<String> requestId)
+    {
+        setId(requestId);
+    }
+
+    private void setDefaultId()
+    {
+        List<String> id = List.of("adminTools", "healthCheck");
+        setId(id);
+    }
+}

application-admintools-api/src/main/java/com/xwiki/admintools/jobs/HealthCheckJobStatus.java

@@ -0,0 +1,83 @@
+/*
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package com.xwiki.admintools.jobs;
+
+import java.util.LinkedList;
+import java.util.List;
+
+import org.xwiki.job.DefaultJobStatus;
+import org.xwiki.logging.LoggerManager;
+import org.xwiki.observation.ObservationManager;
+import org.xwiki.stability.Unstable;
+
+import com.xwiki.admintools.health.HealthCheckResult;
+
+/**
+ * The status of the health check job.
+ *
+ * @version $Id$
+ * @since 1.0
+ */
+@Unstable
+public class HealthCheckJobStatus extends DefaultJobStatus<HealthCheckJobRequest>
+{
+    private final List<HealthCheckResult> healthCheckResults = new LinkedList<>();
+
+    /**
+     * Create a new health check job status.
+     *
+     * @param jobType the job type
+     * @param request the request provided when the job was started
+     * @param observationManager the observation manager
+     * @param loggerManager the logger manager
+     */
+    public HealthCheckJobStatus(String jobType, HealthCheckJobRequest request, ObservationManager observationManager,
+        LoggerManager loggerManager)
+    {
+        super(jobType, request, null, observationManager, loggerManager);
+        setCancelable(true);
+    }
+
+    /**
+     * Get the list issues list from the job.
+     *
+     * @return list with {@link HealthCheckResult} containing errors.
+     */
+    public List<HealthCheckResult> getHealthCheckResults()
+    {
+        return healthCheckResults;
+    }
+
+    /**
+     * Get the list issues list from the job.
+     * @param level the logger manager
+     *
+     * @return boolean with {@link HealthCheckResult} containing errors.
+     */
+    public boolean hasErrorLevel(String level)
+    {
+        for (HealthCheckResult checkResult : healthCheckResults) {
+            if (checkResult.getLevel().equals(level)) {
+                return true;
+            }
+        }
+        return false;
+    }
+}

application-admintools-default/pom.xml

@@ -41,6 +41,12 @@
       <artifactId>xwiki-platform-oldcore</artifactId>
       <version>${platform.version}</version>
     </dependency>
+    <!-- Access CPU info to be used by the health check. -->
+    <dependency>
+      <groupId>com.github.oshi</groupId>
+      <artifactId>oshi-core</artifactId>
+      <version>5.8.0</version>
+    </dependency>
     <dependency>
       <groupId>javax.servlet</groupId>
       <artifactId>javax.servlet-api</artifactId>
@@ -66,8 +72,13 @@
       <version>${commons.version}</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.xwiki.commons</groupId>
+      <artifactId>xwiki-commons-cache-api</artifactId>
+      <version>${commons.version}</version>
+    </dependency>
   </dependencies>
   <properties>
-    <xwiki.jacoco.instructionRatio>0.79</xwiki.jacoco.instructionRatio>
+    <xwiki.jacoco.instructionRatio>0.76</xwiki.jacoco.instructionRatio>
   </properties>
 </project>