Merge pull request #265 from dacrome/introduce-monitoring

Introduce monitoring

CHANGELOG.md

@@ -1,5 +1,18 @@
 # OSIAM
 
+## 3.1 - unreleased
+
+### Features
+
+- Add `/management` endpoint which provides monitoring information about the
+  running OSIAM app. Take a look at the
+  [Spring Boot documentation](http://docs.spring.io/spring-boot/docs/1.4.1.RELEASE/reference/html/production-ready-endpoints.html)
+  if you like to get more details.
+
+### Changes
+
+- Remove `/Metrics` endpoint
+
 ## 3.0 - 2016-08-09
 
 **Breaking changes!**

docs/api_documentation.md

@@ -35,6 +35,7 @@
         - [Replace an existing Group](#replace-an-existing-group)
         - [Update a Group](#update-a-group)
         - [Delete a Group](#delete-a-group)
+- [Monitoring](#monitoring)
 
 ## Basics
 
@@ -787,3 +788,8 @@ e.g.:
 ```sh
 curl -i -H "Accept: application/json" -H "Content-type: application/json" -H "Authorization: Bearer $YOUR_ACCESS_TOKEN" -X DELETE http://localhost:8080/Groups/$ID
 ```
+## Monitoring
+
+To monitor the running OSIAM you can call
+[one of the endpoints](http://docs.spring.io/spring-boot/docs/1.4.1.RELEASE/reference/html/production-ready-endpoints.html)
+which are grouped under `/management`.

pom.xml

@@ -123,26 +123,13 @@
         </dependency>
 
         <dependency>
-            <groupId>org.flywaydb</groupId>
-            <artifactId>flyway-core</artifactId>
-        </dependency>
-
-        <dependency>
-            <groupId>com.ryantenney.metrics</groupId>
-            <artifactId>metrics-spring</artifactId>
-            <version>3.1.3</version>
-        </dependency>
-
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-json</artifactId>
-            <version>3.1.2</version>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
         </dependency>
 
         <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-jvm</artifactId>
-            <version>3.1.2</version>
+            <groupId>org.flywaydb</groupId>
+            <artifactId>flyway-core</artifactId>
         </dependency>
 
         <dependency>

src/main/java/org/osiam/Osiam.java

@@ -24,7 +24,6 @@
 package org.osiam;
 
 import com.google.common.collect.ImmutableMap;
-import com.ryantenney.metrics.spring.config.annotation.EnableMetrics;
 import org.osiam.cli.InitHome;
 import org.osiam.cli.MigrateDb;
 import org.springframework.boot.SpringApplication;
@@ -45,7 +44,6 @@
 
 @SpringBootApplication
 @EnableWebSecurity
-@EnableMetrics
 @EnableAspectJAutoProxy(proxyTargetClass = true)
 @ComponentScan(excludeFilters = {
         @ComponentScan.Filter(type = FilterType.REGEX, pattern = "org\\.osiam\\.cli.*")

src/main/java/org/osiam/configuration/JacksonConfig.java

@@ -23,7 +23,6 @@
  */
 package org.osiam.configuration;
 
-import com.codahale.metrics.json.MetricsModule;
 import com.fasterxml.jackson.core.Version;
 import com.fasterxml.jackson.databind.Module;
 import com.fasterxml.jackson.databind.module.SimpleModule;
@@ -34,25 +33,19 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
 
-import java.util.concurrent.TimeUnit;
-
 @Configuration
 public class JacksonConfig {
 
     @Bean
     public Jackson2ObjectMapperBuilder jacksonBuilder() {
         Jackson2ObjectMapperBuilder jacksonBuilder = new Jackson2ObjectMapperBuilder();
         jacksonBuilder.filters(new SimpleFilterProvider().setFailOnUnknownId(false));
-        jacksonBuilder.modules(jacksonUserDeserializerModule(), metricsModule());
+        jacksonBuilder.modules(jacksonUserDeserializerModule());
         return jacksonBuilder;
     }
 
     private Module jacksonUserDeserializerModule() {
         return new SimpleModule("userDeserializerModule", new Version(1, 0, 0, null, "org.osiam", "osiam"))
                 .addDeserializer(User.class, new UserDeserializer(User.SCHEMA));
     }
-
-    private Module metricsModule() {
-        return new MetricsModule(TimeUnit.SECONDS, TimeUnit.SECONDS, false);
-    }
 }

src/main/java/org/osiam/configuration/OAuth2ResourceServerConfig.java

@@ -52,6 +52,7 @@ public void configure(HttpSecurity http) throws Exception {
         // @formatter:off
         http.authorizeRequests()
                 .antMatchers("/ServiceProviderConfig").permitAll()
+                .antMatchers("/management/**").access("#oauth2.hasScope('ADMIN')")
                 .antMatchers("/Me/**").access("#oauth2.hasScope('ADMIN') or #oauth2.hasScope('ME')")
                 .antMatchers(HttpMethod.POST, "/Users/**").access("#oauth2.hasScope('ADMIN')")
                 .regexMatchers(HttpMethod.GET, "/Users/?").access("#oauth2.hasScope('ADMIN')")

src/main/resources/application.yml

@@ -37,6 +37,8 @@ spring.thymeleaf.prefix: file:${osiam.home}/templates/web/
 spring.jpa.hibernate.ddl-auto: none
 server.port: ${osiam.port:8080}
 
+management.context-path: /management
+
 flyway:
   locations: db/migration/${osiam.db.vendor}
   baseline-on-migrate: true