# HG changeset patch # User Christopher Koehler # Date 1504632608 14400 # Node ID 7499f1b499c15f68197348fe96ab64c51856b08f # Parent 1bcd159ffaf7ad12d14ee8f4a61a123bf516cbdd Add jvm-cpu service Reviewed-by: jkang Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-August/024671.html Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-September/024804.html diff -r 1bcd159ffaf7 -r 7499f1b499c1 distribution/pom.xml --- a/distribution/pom.xml Tue Sep 05 16:46:50 2017 +0200 +++ b/distribution/pom.xml Tue Sep 05 13:30:08 2017 -0400 @@ -223,6 +223,13 @@ com.redhat.thermostat + thermostat-web-gateway-service-jvm-cpu + ${project.version} + war + false + + + com.redhat.thermostat thermostat-web-gateway-service-jvm-gc ${project.version} war diff -r 1bcd159ffaf7 -r 7499f1b499c1 distribution/src/etc/services.properties --- a/distribution/src/etc/services.properties Tue Sep 05 16:46:50 2017 +0200 +++ b/distribution/src/etc/services.properties Tue Sep 05 13:30:08 2017 -0400 @@ -1,4 +1,5 @@ /commands = thermostat-web-gateway-service-commands-@project.version@.war +/jvm-cpu = thermostat-web-gateway-service-jvm-cpu-@project.version@.war /jvm-gc = thermostat-web-gateway-service-jvm-gc-@project.version@.war /jvm-io = thermostat-web-gateway-service-jvm-io-@project.version@.war /jvm-memory = thermostat-web-gateway-service-jvm-memory-@project.version@.war diff -r 1bcd159ffaf7 -r 7499f1b499c1 services/jvm-cpu/pom.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/services/jvm-cpu/pom.xml Tue Sep 05 13:30:08 2017 -0400 @@ -0,0 +1,104 @@ + + + + + thermostat-web-gateway-services + com.redhat.thermostat + 1.99.12-SNAPSHOT + + 4.0.0 + + thermostat-web-gateway-service-jvm-cpu + + war + + Thermostat Web Gateway JVM CPU Service + + + jvm-cpu + + + + + + maven-war-plugin + + + + src/main/webapp + true + + + + + + + + + + + com.redhat.thermostat + thermostat-web-gateway-common-core + ${project.version} + + + com.redhat.thermostat + thermostat-web-gateway-common-mongodb + ${project.version} + + + + + javax.servlet + javax.servlet-api + ${javax.servlet.version} + provided + + + + + javax.ws.rs + javax.ws.rs-api + ${javax-rs-api.version} + provided + + + diff -r 1bcd159ffaf7 -r 7499f1b499c1 services/jvm-cpu/src/main/java/com/redhat/thermostat/gateway/service/jvm/cpu/JvmCpuHttpHandler.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/services/jvm-cpu/src/main/java/com/redhat/thermostat/gateway/service/jvm/cpu/JvmCpuHttpHandler.java Tue Sep 05 13:30:08 2017 -0400 @@ -0,0 +1,122 @@ +/* + * Copyright 2012-2017 Red Hat, Inc. + * + * This file is part of Thermostat. + * + * Thermostat is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published + * by the Free Software Foundation; either version 2, or (at your + * option) any later version. + * + * Thermostat 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 + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Thermostat; see the file COPYING. If not see + * . + * + * Linking this code with other modules is making a combined work + * based on this code. Thus, the terms and conditions of the GNU + * General Public License cover the whole combination. + * + * As a special exception, the copyright holders of this code give + * you permission to link this code with independent modules to + * produce an executable, regardless of the license terms of these + * independent modules, and to copy and distribute the resulting + * executable under terms of your choice, provided that you also + * meet, for each linked independent module, the terms and conditions + * of the license of that module. An independent module is a module + * which is not derived from or based on this code. If you modify + * this code, you may extend this exception to your version of the + * library, but you are not obligated to do so. If you do not wish + * to do so, delete this exception statement from your version. + */ + +package com.redhat.thermostat.gateway.service.jvm.cpu; + +import javax.servlet.ServletContext; +import javax.servlet.http.HttpServletRequest; +import javax.ws.rs.Consumes; +import javax.ws.rs.DELETE; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.Response; + +import com.redhat.thermostat.gateway.common.mongodb.servlet.MongoHttpHandlerHelper; +import com.redhat.thermostat.gateway.common.mongodb.servlet.RequestParameters; + +@Path("/") +public class JvmCpuHttpHandler { + + private static final String collectionName = "jvm-cpu"; + private final MongoHttpHandlerHelper serviceHelper = new MongoHttpHandlerHelper(collectionName); + + @GET + @Path("/jvms/{" + RequestParameters.JVM_ID + "}") + @Consumes({ "application/json" }) + @Produces({ "application/json", "text/html; charset=utf-8" }) + public Response getJvmCpu(@PathParam(RequestParameters.JVM_ID) String jvmId, + @QueryParam(RequestParameters.LIMIT) @DefaultValue("1") Integer limit, + @QueryParam(RequestParameters.OFFSET) @DefaultValue("0") Integer offset, + @QueryParam(RequestParameters.SORT) String sort, + @QueryParam(RequestParameters.QUERY) String queries, + @QueryParam(RequestParameters.INCLUDE) String includes, + @QueryParam(RequestParameters.EXCLUDE) String excludes, + @QueryParam(RequestParameters.METADATA) @DefaultValue("false") String metadata, + @Context HttpServletRequest httpServletRequest, + @Context ServletContext context) { + return serviceHelper.handleGetWithJvmID(httpServletRequest, context, null, jvmId, limit, offset, sort, queries, includes, excludes, metadata); + } + + @GET + @Path("/systems/{" + RequestParameters.SYSTEM_ID + "}/jvms/{" + RequestParameters.JVM_ID + "}") + @Consumes({ "application/json" }) + @Produces({ "application/json", "text/html; charset=utf-8" }) + public Response getJvmCpu(@PathParam(RequestParameters.SYSTEM_ID) String systemId, + @PathParam(RequestParameters.JVM_ID) String jvmId, + @QueryParam(RequestParameters.LIMIT) @DefaultValue("1") Integer limit, + @QueryParam(RequestParameters.OFFSET) @DefaultValue("0") Integer offset, + @QueryParam(RequestParameters.SORT) String sort, + @QueryParam(RequestParameters.QUERY) String queries, + @QueryParam(RequestParameters.INCLUDE) String includes, + @QueryParam(RequestParameters.EXCLUDE) String excludes, + @QueryParam(RequestParameters.METADATA) @DefaultValue("false") String metadata, + @Context HttpServletRequest httpServletRequest, + @Context ServletContext context) { + return serviceHelper.handleGetWithJvmID(httpServletRequest, context, systemId, jvmId, limit, offset, sort, queries, includes, excludes, metadata); + } + + @POST + @Path("/systems/{" + RequestParameters.SYSTEM_ID + "}/jvms/{" + RequestParameters.JVM_ID + "}") + @Consumes({ "application/json" }) + @Produces({ "application/json", "text/html; charset=utf-8" }) + public Response postJvmCpu(String body, + @PathParam(RequestParameters.SYSTEM_ID) String systemId, + @PathParam(RequestParameters.JVM_ID) String jvmId, + @QueryParam(RequestParameters.METADATA) @DefaultValue("false") String metadata, + @Context ServletContext context, + @Context HttpServletRequest httpServletRequest) { + return serviceHelper.handlePostWithJvmID(httpServletRequest, context, systemId, jvmId, metadata, body); + } + + @DELETE + @Path("/systems/{" + RequestParameters.SYSTEM_ID + "}/jvms/{" + RequestParameters.JVM_ID + "}") + @Consumes({ "application/json" }) + @Produces({ "application/json", "text/html; charset=utf-8" }) + public Response deleteJvmCpu(@PathParam(RequestParameters.SYSTEM_ID) String systemId, + @PathParam(RequestParameters.JVM_ID) String jvmId, + @QueryParam(RequestParameters.QUERY) String queries, + @QueryParam(RequestParameters.METADATA) @DefaultValue("false") String metadata, + @Context ServletContext context, + @Context HttpServletRequest httpServletRequest) { + return serviceHelper.handleDeleteWithJvmID(httpServletRequest, context, systemId, jvmId, queries, metadata); + } +} diff -r 1bcd159ffaf7 -r 7499f1b499c1 services/jvm-cpu/src/main/java/com/redhat/thermostat/gateway/service/jvm/cpu/SwaggerSpecResourceHandler.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/services/jvm-cpu/src/main/java/com/redhat/thermostat/gateway/service/jvm/cpu/SwaggerSpecResourceHandler.java Tue Sep 05 13:30:08 2017 -0400 @@ -0,0 +1,58 @@ +/* + * Copyright 2012-2017 Red Hat, Inc. + * + * This file is part of Thermostat. + * + * Thermostat is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published + * by the Free Software Foundation; either version 2, or (at your + * option) any later version. + * + * Thermostat 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 + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Thermostat; see the file COPYING. If not see + * . + * + * Linking this code with other modules is making a combined work + * based on this code. Thus, the terms and conditions of the GNU + * General Public License cover the whole combination. + * + * As a special exception, the copyright holders of this code give + * you permission to link this code with independent modules to + * produce an executable, regardless of the license terms of these + * independent modules, and to copy and distribute the resulting + * executable under terms of your choice, provided that you also + * meet, for each linked independent module, the terms and conditions + * of the license of that module. An independent module is a module + * which is not derived from or based on this code. If you modify + * this code, you may extend this exception to your version of the + * library, but you are not obligated to do so. If you do not wish + * to do so, delete this exception statement from your version. + */ + +package com.redhat.thermostat.gateway.service.jvm.cpu; + +import java.io.IOException; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import com.redhat.thermostat.gateway.common.core.servlet.BasicResourceHandler; + +@Path("doc/{fileName: .+\\.yaml}") +@Produces(MediaType.TEXT_PLAIN) +public class SwaggerSpecResourceHandler extends BasicResourceHandler { + + @GET + public Response getFileAsPlainText(@PathParam("fileName") String fileName) throws IOException { + return getFileAsResponse(SwaggerSpecResourceHandler.class.getClassLoader(), fileName); + } +} diff -r 1bcd159ffaf7 -r 7499f1b499c1 services/jvm-cpu/src/main/resources/jvm-cpu-swagger.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/services/jvm-cpu/src/main/resources/jvm-cpu-swagger.yaml Tue Sep 05 13:30:08 2017 -0400 @@ -0,0 +1,208 @@ +swagger: '2.0' +info: + version: 0.0.1 + title: Thermostat Web Gateway JVM CPU Info API + license: + name: GPL v2 with Classpath Exception + url: 'http://www.gnu.org/licenses' +consumes: + - application/json +produces: + - application/json + - text/html; charset=utf-8 +basePath: /jvm-cpu/0.0.1 +paths: + /jvms/{jvmId}: + parameters: + - $ref: '#/parameters/thermostat-realms' + - $ref: '#/parameters/jvm-id' + get: + description: Get JVM CPU information for JVM {jvmId}. + parameters: + - $ref: '#/parameters/limit' + - $ref: '#/parameters/offset' + - $ref: '#/parameters/sort' + - $ref: '#/parameters/include' + - $ref: '#/parameters/exclude' + - $ref: '#/parameters/query' + - $ref: '#/parameters/metadata' + responses: + '200': + description: OK + schema: + $ref: '#/definitions/jvm-cpu-info-get-response' + /systems/{systemId}/jvms/{jvmId}: + parameters: + - $ref: '#/parameters/thermostat-realms' + - $ref: '#/parameters/system-id' + - $ref: '#/parameters/jvm-id' + get: + description: Get JVM CPU information for system {systemId}. + parameters: + - $ref: '#/parameters/limit' + - $ref: '#/parameters/offset' + - $ref: '#/parameters/sort' + - $ref: '#/parameters/include' + - $ref: '#/parameters/exclude' + - $ref: '#/parameters/query' + - $ref: '#/parameters/metadata' + responses: + '200': + description: OK + schema: + $ref: '#/definitions/jvm-cpu-info-get-response' + post: + description: Add JVM CPU information for system {systemId}. + parameters: + - $ref: '#/parameters/jvm-cpu-info-array' + - $ref: '#/parameters/metadata' + responses: + '200': + description: OK + schema: + $ref: '#/definitions/metadata' + delete: + description: Delete JVM CPU information for system {systemId}. + parameters: + - $ref: '#/parameters/query' + - $ref: '#/parameters/metadata' + responses: + '200': + description: OK + schema: + $ref: '#/definitions/metadata' +definitions: + jvm-cpu-info-get-response: + type: object + properties: + response: + $ref: '#/definitions/jvm-cpu-info-array' + metadata: + $ref: '#/definitions/metadata' + jvm-cpu-info-array: + type: array + items: + $ref: '#/definitions/jvm-cpu-info' + jvm-cpu-info: + type: object + properties: + cpuLoad: + type: number + format: double + programTicks: + $ref: '#/definitions/metric' + timeStamp: + $ref: '#/definitions/timeStamp' + agentId: + $ref: '#/definitions/metric' + jvmId: + $ref: '#/definitions/metric' + metric: + type: object + properties: + $numberLong: + type: string + timeStamp: + description: UNIX timestamp in milliseconds + type: object + properties: + $numberLong: + type: string + metadata: + type: object + properties: + payloadCount: + type: integer + count: + type: integer + prev: + type: string + next: + type: string + first: + type: string + last: + type: string + insertCount: + type: integer + matchCount: + type: integer + elapsed: + type: integer + format: int64 +parameters: + system-id: + name: systemId + in: path + required: true + type: string + jvm-id: + name: jvmId + in: path + required: true + type: string + jvm-cpu-info-array: + name: jvm-cpu-info-array + in: body + description: The JVM CPU information + required: true + schema: + $ref: '#/definitions/jvm-cpu-info-array' + limit: + name: limit + in: query + description: Limit of items to return. Example '1' + type: integer + required: false + default: 1 + offset: + name: offset + in: query + description: Offset of items to return. Example '0' + type: integer + required: true + default: 0 + sort: + name: sort + in: query + description: Sort string. Comma separated list of fields prefixed with '+' for ascending or '-' for descending. Example '?sort=+a,-b' Fields use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer. + type: string + required: false + query: + name: query + in: query + description: Query string. Comma separated list of key, comparator, value pairs. Comparator supports '==', '<=', '>=', '<', '>', '!='. Example '?query=a==b,c!=d'. Keys are fields in documents and use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer. + type: string + required: false + include: + name: include + in: query + description: >- + Inclusion string. Comma separated list of fields to include in the + response. Example '?include=a,b' Fields use dot notation for embedded + documents. Example 'outer.inner' refers to field inner contained in field + outer. Cannot be used in combination with 'exclude' parameter Overriden by + 'exclude' parameter + type: string + required: false + exclude: + name: exclude + in: query + description: >- + Exclusion string. Comma separated list of fields to exclude in the + response. Example '?exclude=a,b' Fields use dot notation for embedded + documents. Example 'outer.inner' refers to field inner contained in field + outer. Cannot be used in combination with 'include' parameter; takes + precedence over 'include' parameter + type: string + required: false + metadata: + name: metadata + type: boolean + in: query + description: "Metadata flag. If set to 'true', the subsequent request response will return metadata information. If set to 'false', such metadata information will be omitted." + thermostat-realms: + name: X-Thermostat-Realms + type: string + in: header + description: "Realms Header used to specify a subset of roles to use for Keycloak authorization. Attempts to specify realms that the client does not have, or no valiod realms at all will result in a 400 Bad Request response. Expects a space separated list of realms. Example 'X-Thermostat-Realms: realm-one realm-two'" diff -r 1bcd159ffaf7 -r 7499f1b499c1 services/jvm-cpu/src/main/webapp/WEB-INF/web.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/services/jvm-cpu/src/main/webapp/WEB-INF/web.xml Tue Sep 05 13:30:08 2017 -0400 @@ -0,0 +1,88 @@ + + + + JvmCpuServlet + org.glassfish.jersey.servlet.ServletContainer + + + jersey.config.server.provider.packages + + + com.redhat.thermostat.gateway.service.jvm.cpu, + + + + + ServiceVersionFilter + com.redhat.thermostat.gateway.common.core.servlet.ServiceVersionFilter + + version + 0.0.1 + + + + ServiceVersionFilter + /* + + + JvmCpuServlet + /0.0.1/* + + + + com.redhat.thermostat.gateway.SERVICE_NAME + @com.redhat.thermostat.gateway.SERVICE_NAME@ + + + + com.redhat.thermostat.gateway.common.mongodb.servlet.StorageConnectionSettingListener + + + + + Swagger API Spec File + /0.0.1/doc/@com.redhat.thermostat.gateway.SERVICE_NAME@-swagger.yaml + + + + diff -r 1bcd159ffaf7 -r 7499f1b499c1 services/pom.xml --- a/services/pom.xml Tue Sep 05 16:46:50 2017 +0200 +++ b/services/pom.xml Tue Sep 05 13:30:08 2017 -0400 @@ -55,6 +55,7 @@ jvm-gc jvms jvm-memory + jvm-cpu jvm-io systems system-cpu diff -r 1bcd159ffaf7 -r 7499f1b499c1 tests/integration-tests/src/test/java/com/redhat/thermostat/gateway/service/jvm/cpu/JvmCpuServiceIntegrationTest.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/tests/integration-tests/src/test/java/com/redhat/thermostat/gateway/service/jvm/cpu/JvmCpuServiceIntegrationTest.java Tue Sep 05 13:30:08 2017 -0400 @@ -0,0 +1,94 @@ +/* + * Copyright 2012-2017 Red Hat, Inc. + * + * This file is part of Thermostat. + * + * Thermostat is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published + * by the Free Software Foundation; either version 2, or (at your + * option) any later version. + * + * Thermostat 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 + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Thermostat; see the file COPYING. If not see + * . + * + * Linking this code with other modules is making a combined work + * based on this code. Thus, the terms and conditions of the GNU + * General Public License cover the whole combination. + * + * As a special exception, the copyright holders of this code give + * you permission to link this code with independent modules to + * produce an executable, regardless of the license terms of these + * independent modules, and to copy and distribute the resulting + * executable under terms of your choice, provided that you also + * meet, for each linked independent module, the terms and conditions + * of the license of that module. An independent module is a module + * which is not derived from or based on this code. If you modify + * this code, you may extend this exception to your version of the + * library, but you are not obligated to do so. If you do not wish + * to do so, delete this exception statement from your version. + */ + +package com.redhat.thermostat.gateway.service.jvm.cpu; + +import java.util.UUID; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeoutException; + +import com.redhat.thermostat.gateway.tests.integration.MongoIntegrationTest; +import com.redhat.thermostat.gateway.tests.utils.HttpTestUtil; +import org.eclipse.jetty.http.HttpMethod; +import org.junit.Test; + +public class JvmCpuServiceIntegrationTest extends MongoIntegrationTest { + + private static final String SERVICE_NAME = "jvm-cpu"; + private static final String VERSION_NUMBER = "0.0.1"; + private static final String SYSTEM_ID = UUID.randomUUID().toString(); + private static final String JVM_ID = UUID.randomUUID().toString(); + private static final String simpleUrl = baseUrl + "/" + SERVICE_NAME + "/" + VERSION_NUMBER; + private static final String serviceUrl = simpleUrl + "/systems/" + SYSTEM_ID + "/jvms/" + JVM_ID; + private static final String jvmsServiceUrl = simpleUrl + "/jvms/" + JVM_ID; + + public JvmCpuServiceIntegrationTest() { + super(SERVICE_NAME + "/" + VERSION_NUMBER + "/systems/" + SYSTEM_ID + "/jvms/" + JVM_ID, SERVICE_NAME); + } + + @Test + public void testGetForJvms() throws InterruptedException, TimeoutException, ExecutionException { + HttpTestUtil.testContentlessResponse(client, HttpMethod.GET, jvmsServiceUrl, 200, HttpTestUtil.EMPTY_RESPONSE); + } + + @Test + public void testGetForSystemJvms() throws InterruptedException, TimeoutException, ExecutionException { + HttpTestUtil.testContentlessResponse(client, HttpMethod.GET, serviceUrl, 200, HttpTestUtil.EMPTY_RESPONSE); + } + + @Test + public void testPost() throws InterruptedException, TimeoutException, ExecutionException { + String expected = "{\"response\":[{\"a\":\"b\",\"systemId\":\"" + SYSTEM_ID + "\",\"jvmId\":\"" + JVM_ID + "\"}]}"; + HttpTestUtil.addRecords(client, serviceUrl, "[{\"a\":\"b\"}]"); + HttpTestUtil.testContentlessResponse(client, HttpMethod.GET, serviceUrl, 200, expected); + } + + @Test + public void testPut() throws InterruptedException, TimeoutException, ExecutionException { + String putContent = "{\"set\": {\"a\":\"c\"}}"; + HttpTestUtil.addRecords(client, serviceUrl, "[{\"a\":\"b\"}]"); + HttpTestUtil.testContentResponse(client, HttpMethod.PUT, serviceUrl, putContent, 405); + } + + @Test + public void testDelete() throws InterruptedException, TimeoutException, ExecutionException { + String expectedBefore = "{\"response\":[{\"a\":\"b\",\"systemId\":\"" + SYSTEM_ID + "\",\"jvmId\":\"" + JVM_ID + "\"}]}"; + HttpTestUtil.addRecords(client, serviceUrl, "[{\"a\":\"b\"}]"); + HttpTestUtil.testContentlessResponse(client, HttpMethod.GET, serviceUrl, 200, expectedBefore); + HttpTestUtil.testContentlessResponse(client, HttpMethod.DELETE, serviceUrl + "?q=a==b", 200); + HttpTestUtil.testContentlessResponse(client, HttpMethod.GET, serviceUrl, 200, HttpTestUtil.EMPTY_RESPONSE); + } +}