Examples with Result org.apache.sling.hc.api.Result used on opensource projects

Example 1 with Result

use of org.apache.sling.hc.api.Result in project sling by apache.

the class JmxAttributeHealthCheck method execute.

@Override
public Result execute() {
    final FormattingResultLog resultLog = new FormattingResultLog();
    resultLog.debug("Checking {} / {} with constraint {}", mbeanName, attributeName, constraint);
    try {
        final MBeanServer jmxServer = ManagementFactory.getPlatformMBeanServer();
        final ObjectName objectName = new ObjectName(mbeanName);
        if (jmxServer.queryNames(objectName, null).size() == 0) {
            resultLog.warn("MBean not found: {}", objectName);
        } else {
            final Object value = jmxServer.getAttribute(objectName, attributeName);
            resultLog.debug("{} {} returns {}", mbeanName, attributeName, value);
            new SimpleConstraintChecker().check(value, constraint, resultLog);
        }
    } catch (final Exception e) {
        log.warn("JMX attribute {}/{} check failed: {}", new Object[] { mbeanName, attributeName, e });
        resultLog.healthCheckError("JMX attribute check failed: {}", e);
    }
    return new Result(resultLog);
}

Example 2 with Result

use of org.apache.sling.hc.api.Result in project sling by apache.

the class AsyncHealthCheckExecutor method collectAsyncResults.

void collectAsyncResults(List<HealthCheckMetadata> healthCheckDescriptors, Collection<HealthCheckExecutionResult> results) {
    Iterator<HealthCheckMetadata> checksIt = healthCheckDescriptors.iterator();
    Set<ExecutionResult> asyncResults = new TreeSet<ExecutionResult>();
    while (checksIt.hasNext()) {
        HealthCheckMetadata healthCheckMetadata = checksIt.next();
        if (isAsync(healthCheckMetadata)) {
            ExecutionResult result = asyncResultsByDescriptor.get(healthCheckMetadata);
            if (result == null) {
                result = new ExecutionResult(healthCheckMetadata, new Result(Result.Status.INFO, "Async Health Check with cron expression '" + healthCheckMetadata.getAsyncCronExpression() + "' has not yet been executed."), 0L);
                asyncResults.add(result);
            }
            asyncResults.add(result);
            // remove from HC collection to not execute the check in HealthCheckExecutorImpl
            checksIt.remove();
        }
    }
    LOG.debug("Adding {} results from async results", asyncResults.size());
    results.addAll(asyncResults);
}

Example 3 with Result

use of org.apache.sling.hc.api.Result in project sling by apache.

the class HealthCheckExecutorImpl method collectResultFromFuture.

/**
     * Collect the result from a single future
     * @param future The future
     * @return The execution result or a result for a reached timeout
     */
HealthCheckExecutionResult collectResultFromFuture(final HealthCheckFuture future) {
    HealthCheckExecutionResult result;
    HealthCheckMetadata hcMetadata = future.getHealthCheckMetadata();
    if (future.isDone()) {
        logger.debug("Health Check is done: {}", hcMetadata);
        try {
            result = future.get();
        } catch (final Exception e) {
            logger.warn("Unexpected Exception during future.get(): " + e, e);
            long futureElapsedTimeMs = new Date().getTime() - future.getCreatedTime().getTime();
            result = new ExecutionResult(hcMetadata, Result.Status.HEALTH_CHECK_ERROR, "Unexpected Exception during future.get(): " + e, futureElapsedTimeMs, false);
        }
    } else {
        logger.debug("Health Check timed out: {}", hcMetadata);
        // Futures must not be cancelled as interrupting a health check might leave the system in invalid state 
        // (worst case could be a corrupted repository index if using write operations)
        // normally we turn the check into WARN (normal timeout), but if the threshold time for CRITICAL is reached for a certain
        // future we turn the result CRITICAL
        long futureElapsedTimeMs = new Date().getTime() - future.getCreatedTime().getTime();
        FormattingResultLog resultLog = new FormattingResultLog();
        if (futureElapsedTimeMs < this.longRunningFutureThresholdForRedMs) {
            resultLog.warn("Timeout: Check still running after " + msHumanReadable(futureElapsedTimeMs));
        } else {
            resultLog.critical("Timeout: Check still running after " + msHumanReadable(futureElapsedTimeMs) + " (exceeding the configured threshold for CRITICAL: " + msHumanReadable(this.longRunningFutureThresholdForRedMs) + ")");
        }
        // add logs from previous, cached result if exists (using a 1 year TTL)
        HealthCheckExecutionResult lastCachedResult = healthCheckResultCache.getValidCacheResult(hcMetadata, 1000 * 60 * 60 * 24 * 365);
        if (lastCachedResult != null) {
            DateFormat df = new SimpleDateFormat("HH:mm:ss.SSS");
            resultLog.info("*** Result log of last execution finished at {} after {} ***", df.format(lastCachedResult.getFinishedAt()), FormattingResultLog.msHumanReadable(lastCachedResult.getElapsedTimeInMs()));
            for (ResultLog.Entry entry : lastCachedResult.getHealthCheckResult()) {
                resultLog.add(entry);
            }
        }
        result = new ExecutionResult(hcMetadata, new Result(resultLog), futureElapsedTimeMs, true);
    }
    return result;
}

Example 4 with Result

use of org.apache.sling.hc.api.Result in project sling by apache.

the class CompositeHealthCheck method execute.

@Override
public Result execute() {
    final ComponentContext localCtx = this.componentContext;
    final ServiceReference referenceToThis = localCtx == null ? null : localCtx.getServiceReference();
    Result result = referenceToThis == null ? null : checkForRecursion(referenceToThis, new HashSet<String>());
    if (result != null) {
        // return recursion error
        return result;
    }
    FormattingResultLog resultLog = new FormattingResultLog();
    List<HealthCheckExecutionResult> executionResults = healthCheckExecutor.execute(HealthCheckSelector.tags(filterTags));
    resultLog.debug("Executing {} HealthChecks selected by tags {}", executionResults.size(), Arrays.asList(filterTags));
    result = new CompositeResult(resultLog, executionResults);
    return result;
}

Example 5 with Result

use of org.apache.sling.hc.api.Result in project sling by apache.

the class CompositeHealthCheck method checkForRecursion.

Result checkForRecursion(ServiceReference hcReference, Set<String> alreadyBannedTags) {
    HealthCheckMetadata thisCheckMetadata = new HealthCheckMetadata(hcReference);
    Set<String> bannedTagsForThisCompositeCheck = new HashSet<String>();
    bannedTagsForThisCompositeCheck.addAll(alreadyBannedTags);
    bannedTagsForThisCompositeCheck.addAll(thisCheckMetadata.getTags());
    String[] tagsForIncludedChecksArr = PropertiesUtil.toStringArray(hcReference.getProperty(PROP_FILTER_TAGS), new String[0]);
    Set<String> tagsForIncludedChecks = new HashSet<String>(Arrays.asList(tagsForIncludedChecksArr));
    log.debug("HC {} has banned tags {}", thisCheckMetadata.getName(), bannedTagsForThisCompositeCheck);
    log.debug("tagsForIncludedChecks {}", tagsForIncludedChecks);
    // is this HC ok?
    Set<String> intersection = new HashSet<String>();
    intersection.addAll(bannedTagsForThisCompositeCheck);
    intersection.retainAll(tagsForIncludedChecks);
    if (!intersection.isEmpty()) {
        return new Result(Status.HEALTH_CHECK_ERROR, "INVALID CONFIGURATION: Cycle detected in composite health check hierarchy. Health check '" + thisCheckMetadata.getName() + "' (" + hcReference.getProperty(Constants.SERVICE_ID) + ") must not have tag(s) " + intersection + " as a composite check in the hierarchy is itself already tagged alike (tags assigned to composite checks: " + bannedTagsForThisCompositeCheck + ")");
    }
    // check each sub composite check
    ServiceReference[] hcRefsOfCompositeCheck = healthCheckFilter.getHealthCheckServiceReferences(HealthCheckSelector.tags(tagsForIncludedChecksArr));
    for (ServiceReference hcRefOfCompositeCheck : hcRefsOfCompositeCheck) {
        if (CompositeHealthCheck.class.getName().equals(hcRefOfCompositeCheck.getProperty(ComponentConstants.COMPONENT_NAME))) {
            log.debug("Checking sub composite HC {}, {}", hcRefOfCompositeCheck, hcRefOfCompositeCheck.getProperty(ComponentConstants.COMPONENT_NAME));
            Result result = checkForRecursion(hcRefOfCompositeCheck, bannedTagsForThisCompositeCheck);
            if (result != null) {
                // found recursion
                return result;
            }
        }
    }
    // no recursion detected
    return null;
}