<!-- End of Default ONAP Schema Properties -->
<keycloak.version>11.0.2</keycloak.version>
+ <micrometer-spring-legacy.version>1.3.19</micrometer-spring-legacy.version>
+ <micrometer-core.version>1.6.6</micrometer-core.version>
+ <micrometer-registry-prometheus.version>1.6.6</micrometer-registry-prometheus.version>
+ <micrometer-jersey2>1.6.6</micrometer-jersey2>
<!-- Setting some default value to not complain by editor but it will be overridden by gmaven plugin -->
</properties>
<profiles>
</profiles>
<dependencies>
+ <dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-starter-actuator</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-starter-hateoas</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>io.micrometer</groupId>
+ <artifactId>micrometer-spring-legacy</artifactId>
+ <version>${micrometer-spring-legacy.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>io.micrometer</groupId>
+ <artifactId>micrometer-core</artifactId>
+ <version>${micrometer-core.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>io.micrometer</groupId>
+ <artifactId>micrometer-registry-prometheus</artifactId>
+ <version>${micrometer-registry-prometheus.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>io.micrometer</groupId>
+ <artifactId>micrometer-jersey2</artifactId>
+ <version>${micrometer-jersey2}</version>
+ </dependency>
<dependency>
<groupId>javax.jms</groupId>
<artifactId>javax.jms-api</artifactId>
import javax.ws.rs.Path;
+import io.micrometer.core.annotation.Timed;
import org.onap.aai.restcore.HttpMethod;
@Path("{version: v[1-9][0-9]*|latest}/bulkadd")
+@Timed
public class BulkAddConsumer extends BulkConsumer {
@Override
import javax.ws.rs.Path;
+import io.micrometer.core.annotation.Timed;
import org.onap.aai.restcore.HttpMethod;
@Path("{version: v[1-9][0-9]*|latest}/bulkprocess")
+@Timed
public class BulkProcessConsumer extends BulkConsumer {
@Override
import javax.ws.rs.core.Response.Status;
import javax.ws.rs.core.UriInfo;
+import io.micrometer.core.annotation.Timed;
import org.onap.aai.config.SpringContextAware;
import org.onap.aai.exceptions.AAIException;
import org.onap.aai.introspection.Introspector;
* The Class ExampleConsumer.
*/
@Path("{version: v[1-9][0-9]*|latest}/examples")
+@Timed
public class ExampleConsumer extends RESTAPI {
*/
package org.onap.aai.rest;
+import io.micrometer.core.annotation.Timed;
import io.swagger.jaxrs.PATCH;
import org.apache.commons.lang3.ObjectUtils;
import org.javatuples.Pair;
*/
@Controller
@Path("{version: v[1-9][0-9]*|latest}")
+@Timed
public class LegacyMoxyConsumer extends RESTAPI {
private static final Logger logger = LoggerFactory.getLogger(LegacyMoxyConsumer.class.getName());
*/
package org.onap.aai.rest;
+import io.micrometer.core.annotation.Timed;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.onap.aai.config.SpringContextAware;
import org.onap.aai.exceptions.AAIException;
* The Class URLFromVertexIdConsumer.
*/
@Path("{version: v[1-9][0-9]*|latest}/generateurl")
+@Timed
public class URLFromVertexIdConsumer extends RESTAPI {
private ModelType introspectorFactoryType = ModelType.MOXY;
*/
package org.onap.aai.rest;
+import io.micrometer.core.annotation.Timed;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.javatuples.Pair;
import org.onap.aai.config.SpringContextAware;
* The Class VertexIdConsumer.
*/
@Path("{version: v[1-9][0-9]*|latest}/resources")
+@Timed
public class VertexIdConsumer extends RESTAPI {
private ModelType introspectorFactoryType = ModelType.MOXY;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonParser;
+import io.micrometer.core.annotation.Timed;
import org.javatuples.Pair;
import org.onap.aai.config.SpringContextAware;
import org.onap.aai.exceptions.AAIException;
import java.util.*;
@Path(value = "{version: v[1-9][0-9]*|latest}/bulk/single-transaction")
+@Timed
public class BulkSingleTransactionConsumer extends RESTAPI {
private static final Set<String> validOperations = Collections.unmodifiableSet(new HashSet<>(Arrays.asList("put", "patch", "delete")));
--- /dev/null
+/**
+ * ============LICENSE_START=======================================================
+ * org.onap.aai
+ * ================================================================================
+ * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+package org.onap.aai.web;
+import io.micrometer.core.instrument.Tag;
+import io.micrometer.core.instrument.Tags;
+import io.micrometer.jersey2.server.JerseyTags;
+import io.micrometer.jersey2.server.JerseyTagsProvider;
+import org.glassfish.jersey.server.ContainerResponse;
+import org.glassfish.jersey.server.monitoring.RequestEvent;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Configuration Class to add customized tags to http metrics scraped in /actuator/prometheus endpoint
+ */
+@Configuration
+public class MicrometerConfiguration {
+ private static final String TAG_AAI_URI = "aai_uri";
+ private static final String NOT_AVAILABLE = "NOT AVAILABLE";
+
+ @Bean
+ public JerseyTagsProvider jerseyTagsProvider() {
+ return new JerseyTagsProvider() {
+ @Override
+ public Iterable httpRequestTags(RequestEvent event) {
+ ContainerResponse response = event.getContainerResponse();
+ return Tags.of(JerseyTags.method(event.getContainerRequest()),
+ JerseyTags.exception(event), JerseyTags.status(response), JerseyTags.outcome(response), getAaiUriTag(event));
+ }
+ private Tag getAaiUriTag(RequestEvent event) {
+ String aai_uri = event.getUriInfo().getRequestUri().toString();
+ if (aai_uri == null) {
+ aai_uri = NOT_AVAILABLE;
+ }
+ return Tag.of(TAG_AAI_URI, aai_uri);
+ }
+ @Override
+ public Iterable<Tag> httpLongRequestTags(RequestEvent event) {
+ return Tags.of(JerseyTags.method(event.getContainerRequest()), JerseyTags.uri(event));
+ }
+ };
+ }
+}
\ No newline at end of file
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.keycloak.adapters.springboot.KeycloakAutoConfiguration,\
- org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration
+ org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration,\
+ org.springframework.boot.actuate.autoconfigure.security.servlet.ManagementWebSecurityAutoConfiguration
spring.jersey.application-path=${schema.uri.base.path}
schema.service.ssl.trust-store-password=password(OBF:1vn21ugu1saj1v9i1v941sar1ugw1vo0)
schema.service.versions.override=false
+#To Expose the Prometheus scraping endpoint
+management.server.port=8448
+#To Enable Actuator Endpoint, you can override this to True in OOM charts
+management.endpoints.enabled-by-default=false
+#To Enable Actuator Endpoint, you can override this in OOM Charts
+#management.endpoints.web.exposure.include=info, health, prometheus
+management.metrics.web.server.auto-time-requests=false
+management.metrics.tags.group_id=aai
+management.metrics.tags.app_id=${info.build.artifact}
+
# Location of the cadi properties file should be specified here
aaf.cadi.file=${server.local.startpath}/cadi.properties
import org.onap.aai.restclient.PropertyPasswordConfiguration;
import org.onap.aai.config.SpringContextAware;
import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.server.LocalServerPort;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Import;
import java.util.UUID;
import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
/**
* Test REST requests against configuration resource
@LocalServerPort
int randomPort;
+ @Value("${local.management.port}")
+ private int mgtPort;
+
private HttpEntity<String> httpEntity;
private HttpEntity<String> httpEntityPut;
private HttpEntity<String> httpEntityPatch;
private String baseUrl;
+ private String actuatorurl;
private HttpHeaders headers;
@Before
public void setup() throws UnsupportedEncodingException {
httpEntity = new HttpEntity<String>(headers);
baseUrl = "http://localhost:" + randomPort;
+ actuatorurl = "http://localhost:" + mgtPort;
}
@Test
}
+
+ @Test
+ public void TestManagementEndpointConfiguration() {
+ ResponseEntity responseEntity = null;
+ String responseBody = null;
+
+ //set Accept as text/plain in order to get access of endpoint "/actuator/prometheus"
+ headers.set("Accept", "text/plain");
+ httpEntity = new HttpEntity<String>(headers);
+ responseEntity = restTemplate.exchange(actuatorurl + "/actuator/prometheus", HttpMethod.GET, httpEntity, String.class);
+ responseBody = (String) responseEntity.getBody();
+ assertEquals(HttpStatus.OK, responseEntity.getStatusCode());
+ assertTrue(responseBody.contains("app_id"));
+ assertTrue(responseBody.contains("group_id"));
+
+ //Set Accept as MediaType.APPLICATION_JSON in order to get access of endpoint "/actuator/info" and "/actuator/health"
+ headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));
+ httpEntity = new HttpEntity<String>(headers);
+ responseEntity = restTemplate.exchange(actuatorurl + "/actuator/info", HttpMethod.GET, httpEntity, String.class);
+ responseBody = (String) responseEntity.getBody();
+ assertEquals(HttpStatus.OK, responseEntity.getStatusCode());
+ assertTrue(responseBody.contains("aai-resources"));
+
+ responseEntity = restTemplate.exchange(actuatorurl + "/actuator/health", HttpMethod.GET, httpEntity, String.class);
+ responseBody = (String) responseEntity.getBody();
+ assertEquals(HttpStatus.OK, responseEntity.getStatusCode());
+ assertTrue(responseBody.contains("UP"));
+ }
}
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.keycloak.adapters.springboot.KeycloakAutoConfiguration,\
- org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration
+ org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration,\
+ org.springframework.boot.actuate.autoconfigure.security.servlet.ManagementWebSecurityAutoConfiguration
spring.profiles.active=production
#The max number of active threads in this pool
schema.version.api.default=v15
schema.translator.list=config
+#To expose the Prometheus scraping endpoint in unit test
+management.server.port=0
+management.endpoints.enabled-by-default=true
+management.endpoints.web.exposure.include=info, health, prometheus
+management.metrics.web.server.auto-time-requests=false
Code Review / aai / resources.git / commitdiff