forked from payara/Payara
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PAYARA-1913 MicroProfile Healthcheck (payara#2293)
Conflicts: appserver/pom.xml
- Loading branch information
1 parent
291d06d
commit 46a00cb
Showing
13 changed files
with
873 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
95 changes: 95 additions & 0 deletions
95
appserver/payara-appserver-modules/microprofile/healthcheck/pom.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | ||
| Copyright (c) 2017 Payara Foundation and/or its affiliates. All rights reserved. | ||
| The contents of this file are subject to the terms of either the GNU | ||
| General Public License Version 2 only ("GPL") or the Common Development | ||
| and Distribution License("CDDL") (collectively, the "License"). You | ||
| may not use this file except in compliance with the License. You can | ||
| obtain a copy of the License at | ||
| https://github.com/payara/Payara/blob/master/LICENSE.txt | ||
| See the License for the specific | ||
| language governing permissions and limitations under the License. | ||
| When distributing the software, include this License Header Notice in each | ||
| file and include the License file at glassfish/legal/LICENSE.txt. | ||
| GPL Classpath Exception: | ||
| The Payara Foundation designates this particular file as subject to the "Classpath" | ||
| exception as provided by the Payara Foundation in the GPL Version 2 section of the License | ||
| file that accompanied this code. | ||
| Modifications: | ||
| If applicable, add the following below the License Header, with the fields | ||
| enclosed by brackets [] replaced by your own identifying information: | ||
| "Portions Copyright [year] [name of copyright owner]" | ||
| Contributor(s): | ||
| If you wish your version of this file to be governed by only the CDDL or | ||
| only the GPL Version 2, indicate your decision by adding "[Contributor] | ||
| elects to include this software in this distribution under the [CDDL or GPL | ||
| Version 2] license." If you don't indicate a single choice of license, a | ||
| recipient has the option to distribute your version of this file under | ||
| either the CDDL, the GPL Version 2 or to extend the choice of license to | ||
| its licensees as provided above. However, if you add GPL Version 2 code | ||
| and therefore, elected the GPL Version 2 license, then the option applies | ||
| only if the new code is made subject to such option by the copyright | ||
| holder. | ||
| --> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <parent> | ||
| <groupId>fish.payara.microprofile</groupId> | ||
| <artifactId>microprofile</artifactId> | ||
| <version>4.1.2.181-SNAPSHOT</version> | ||
| </parent> | ||
| <groupId>fish.payara.microprofile.healthcheck</groupId> | ||
| <artifactId>microprofile-healthcheck</artifactId> | ||
| <name>Microprofile - Healthcheck</name> | ||
| <description>Implementation of MicroProfile Healthcheck API</description> | ||
| <packaging>glassfish-jar</packaging> | ||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-compiler-plugin</artifactId> | ||
| <version>2.3.2</version> | ||
| <configuration> | ||
| <source>1.8</source> | ||
| <target>1.8</target> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.eclipse.microprofile.health</groupId> | ||
| <artifactId>microprofile-health-api</artifactId> | ||
| <version>${microprofile-healthcheck.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.glassfish.main.common</groupId> | ||
| <artifactId>internal-api</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.glassfish.main.common</groupId> | ||
| <artifactId>container-common</artifactId> | ||
| <version>${project.version}</version> | ||
| <type>jar</type> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.glassfish.main.web</groupId> | ||
| <artifactId>weld-integration</artifactId> | ||
| <version>${project.version}</version> | ||
| <type>jar</type> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>javax</groupId> | ||
| <artifactId>javaee-api</artifactId> | ||
| <version>7.0</version> | ||
| </dependency> | ||
| </dependencies> | ||
| </project> |
233 changes: 233 additions & 0 deletions
233
...le/healthcheck/src/main/java/fish/payara/microprofile/healthcheck/HealthCheckService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,233 @@ | ||
| /* | ||
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | ||
| * | ||
| * Copyright (c) [2017] Payara Foundation and/or its affiliates. All rights reserved. | ||
| * | ||
| * The contents of this file are subject to the terms of either the GNU | ||
| * General Public License Version 2 only ("GPL") or the Common Development | ||
| * and Distribution License("CDDL") (collectively, the "License"). You | ||
| * may not use this file except in compliance with the License. You can | ||
| * obtain a copy of the License at | ||
| * https://github.com/payara/Payara/blob/master/LICENSE.txt | ||
| * See the License for the specific | ||
| * language governing permissions and limitations under the License. | ||
| * | ||
| * When distributing the software, include this License Header Notice in each | ||
| * file and include the License file at glassfish/legal/LICENSE.txt. | ||
| * | ||
| * GPL Classpath Exception: | ||
| * The Payara Foundation designates this particular file as subject to the "Classpath" | ||
| * exception as provided by the Payara Foundation in the GPL Version 2 section of the License | ||
| * file that accompanied this code. | ||
| * | ||
| * Modifications: | ||
| * If applicable, add the following below the License Header, with the fields | ||
| * enclosed by brackets [] replaced by your own identifying information: | ||
| * "Portions Copyright [year] [name of copyright owner]" | ||
| * | ||
| * Contributor(s): | ||
| * If you wish your version of this file to be governed by only the CDDL or | ||
| * only the GPL Version 2, indicate your decision by adding "[Contributor] | ||
| * elects to include this software in this distribution under the [CDDL or GPL | ||
| * Version 2] license." If you don't indicate a single choice of license, a | ||
| * recipient has the option to distribute your version of this file under | ||
| * either the CDDL, the GPL Version 2 or to extend the choice of license to | ||
| * its licensees as provided above. However, if you add GPL Version 2 code | ||
| * and therefore, elected the GPL Version 2 license, then the option applies | ||
| * only if the new code is made subject to such option by the copyright | ||
| * holder. | ||
| */ | ||
| package fish.payara.microprofile.healthcheck; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.HashSet; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import javax.annotation.PostConstruct; | ||
| import javax.inject.Inject; | ||
| import javax.json.Json; | ||
| import javax.json.JsonArrayBuilder; | ||
| import javax.json.JsonObjectBuilder; | ||
| import javax.servlet.http.HttpServletResponse; | ||
| import org.eclipse.microprofile.health.HealthCheck; | ||
| import org.eclipse.microprofile.health.HealthCheckResponse; | ||
| import org.glassfish.api.StartupRunLevel; | ||
| import org.glassfish.api.event.EventListener; | ||
| import org.glassfish.api.event.Events; | ||
| import org.glassfish.hk2.runlevel.RunLevel; | ||
| import org.glassfish.internal.api.Globals; | ||
| import org.glassfish.internal.data.ApplicationInfo; | ||
| import org.glassfish.internal.data.ApplicationRegistry; | ||
| import org.glassfish.internal.deployment.Deployment; | ||
| import org.jvnet.hk2.annotations.Service; | ||
|
|
||
| /** | ||
| * Service that handles the registration, execution, and response of MicroProfile HealthChecks. | ||
| * @author Andrew Pielage | ||
| */ | ||
| @Service(name = "healthcheck-service") | ||
| @RunLevel(StartupRunLevel.VAL) | ||
| public class HealthCheckService implements EventListener { | ||
|
|
||
| @Inject | ||
| Events events; | ||
|
|
||
| @Inject | ||
| ApplicationRegistry applicationRegistry; | ||
|
|
||
| private final Map<String, Set<HealthCheck>> healthChecks = new ConcurrentHashMap<>(); | ||
| private final Map<String, ClassLoader> applicationClassLoaders = new ConcurrentHashMap<>(); | ||
|
|
||
| @PostConstruct | ||
| public void postConstruct() { | ||
| if (events == null) { | ||
| events = Globals.getDefaultBaseServiceLocator().getService(Events.class); | ||
| } | ||
|
|
||
| events.register(this); | ||
| } | ||
|
|
||
| @Override | ||
| public void event(Event event) { | ||
| // Remove healthchecks when the app is undeployed. | ||
| if (event.is(Deployment.APPLICATION_UNLOADED)) { | ||
| ApplicationInfo appInfo = Deployment.APPLICATION_UNLOADED.getHook(event); | ||
| if (appInfo != null) { | ||
| healthChecks.remove(appInfo.getName()); | ||
| applicationClassLoaders.remove(appInfo.getName()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Register a HealthCheck to the Set of HealthChecks to execute when performHealthChecks is called. | ||
| * @param appName The name of the application being deployed | ||
| * @param healthCheck The HealthCheck to register | ||
| */ | ||
| public void registerHealthCheck(String appName, HealthCheck healthCheck) { | ||
| // If we don't already have the app registered, we need to create a new Set for it | ||
| if (!healthChecks.containsKey(appName)) { | ||
| // Sync so that we don't get clashes | ||
| synchronized(this) { | ||
| // Check again so that we don't overwrite | ||
| if (!healthChecks.containsKey(appName)) { | ||
| // Create a new Map entry and set for the Healthchecks. | ||
| healthChecks.put(appName, ConcurrentHashMap.newKeySet()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Add the healthcheck to the Set in the Map | ||
| healthChecks.get(appName).add(healthCheck); | ||
| } | ||
|
|
||
| /** | ||
| * Register a ClassLoader for an application. | ||
| * @param appName The name of the application being deployed | ||
| * @param classloader | ||
| */ | ||
| public void registerClassLoader(String appName, ClassLoader classloader) { | ||
| // If we don't already have the app registered, we need to create a new Set for it | ||
| if (!applicationClassLoaders.containsKey(appName)) { | ||
| // Sync so that we don't get clashes | ||
| synchronized(this) { | ||
| // Check again so that we don't overwrite | ||
| if (!applicationClassLoaders.containsKey(appName)) { | ||
| // Create a new Map entry and set for the Healthchecks. | ||
| applicationClassLoaders.put(appName, classloader); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Execute the call method of every registered HealthCheck and generate the response. | ||
| * @param response The response to return | ||
| * @throws IOException If there's an issue writing the response | ||
| */ | ||
| public void performHealthChecks(HttpServletResponse response) throws IOException { | ||
| Set<HealthCheckResponse> healthCheckResponses = new HashSet<>(); | ||
|
|
||
| // Iterate over every HealthCheck stored in the Map | ||
| for (Map.Entry<String, Set<HealthCheck>> healthChecksEntry : healthChecks.entrySet()) { | ||
| for (HealthCheck healthCheck : healthChecksEntry.getValue()) { | ||
| // Execute the call method of the HealthCheck and add its outcome to the set of responses | ||
| try { | ||
| healthCheckResponses.add(healthCheck.call()); | ||
| } catch (IllegalStateException ise) { | ||
| ClassLoader originalClassLoader = Thread.currentThread().getContextClassLoader(); | ||
| try { | ||
| Thread.currentThread().setContextClassLoader( | ||
| applicationRegistry.get(healthChecksEntry.getKey()).getAppClassLoader()); | ||
| healthCheckResponses.add(healthCheck.call()); | ||
| } finally { | ||
| Thread.currentThread().setContextClassLoader(originalClassLoader); | ||
| } | ||
| } catch (Exception ex) { | ||
| Logger.getLogger(HealthCheckService.class.getName()).log(Level.WARNING, | ||
| "Exception executing HealthCheck: " + healthCheck.getClass().getCanonicalName(), ex); | ||
| // If there's any issue, set the response to an error | ||
| response.setStatus(500); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // If we haven't encountered an exception, construct the JSON response | ||
| if (response.getStatus() != 500) { | ||
| constructResponse(response, healthCheckResponses); | ||
| } | ||
| } | ||
|
|
||
| private void constructResponse(HttpServletResponse httpResponse, | ||
| Set<HealthCheckResponse> healthCheckResponses) throws IOException { | ||
| httpResponse.setContentType("application/json"); | ||
|
|
||
| // For each HealthCheckResponse we got from executing the health checks... | ||
| JsonArrayBuilder checksArray = Json.createArrayBuilder(); | ||
| for (HealthCheckResponse healthCheckResponse : healthCheckResponses) { | ||
| JsonObjectBuilder healthCheckObject = Json.createObjectBuilder(); | ||
|
|
||
| // Add the name and state | ||
| healthCheckObject.add("name", healthCheckResponse.getName()); | ||
| healthCheckObject.add("state", healthCheckResponse.getState().toString()); | ||
|
|
||
| // Add data if present | ||
| JsonObjectBuilder healthCheckData = Json.createObjectBuilder(); | ||
| if (healthCheckResponse.getData().isPresent() && !healthCheckResponse.getData().get().isEmpty()) { | ||
| for (Map.Entry<String, Object> dataMapEntry : healthCheckResponse.getData().get().entrySet()) { | ||
| healthCheckData.add(dataMapEntry.getKey(), dataMapEntry.getValue().toString()); | ||
| } | ||
| } | ||
| healthCheckObject.add("data", healthCheckData); | ||
|
|
||
| // Add finished Object to checks array | ||
| checksArray.add(healthCheckObject); | ||
|
|
||
| // Check if we need to set the response as 503. Check against status 200 so we don't repeatedly set it | ||
| if (httpResponse.getStatus() == 200 | ||
| && healthCheckResponse.getState().equals(HealthCheckResponse.State.DOWN)) { | ||
| httpResponse.setStatus(503); | ||
| } | ||
| } | ||
|
|
||
| // Create the final aggregate object | ||
| JsonObjectBuilder responseObject = Json.createObjectBuilder(); | ||
|
|
||
| // Set the aggregate outcome | ||
| if (httpResponse.getStatus() == 200) { | ||
| responseObject.add("outcome", "UP"); | ||
| } else { | ||
| responseObject.add("outcome", "DOWN"); | ||
| } | ||
|
|
||
| // Add all of the checks | ||
| responseObject.add("checks", checksArray); | ||
|
|
||
| // Print the outcome | ||
| httpResponse.getOutputStream().print(responseObject.build().toString()); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.